From b034c75495cf033b3ec7a1b6ea6b1f4c1338ecb4 Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Wed, 21 Jul 2010 09:50:42 +0000 Subject: [PATCH] Backport r82456 --- Doc/library/dis.rst | 12 +++++++++--- Misc/NEWS | 6 ++++++ 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst index a73e6b37d1..e97743c17f 100644 --- a/Doc/library/dis.rst +++ b/Doc/library/dis.rst @@ -5,12 +5,18 @@ :synopsis: Disassembler for Python bytecode. -The :mod:`dis` module supports the analysis of Python :term:`bytecode` by -disassembling it. Since there is no Python assembler, this module defines the -Python assembly language. The Python bytecode which this module takes as an +The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by +disassembling it. The CPython bytecode which this module takes as an input is defined in the file :file:`Include/opcode.h` and used by the compiler and the interpreter. +.. impl-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. + Example: Given the function :func:`myfunc`:: def myfunc(alist): diff --git a/Misc/NEWS b/Misc/NEWS index a2fa664751..57998e371f 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -363,6 +363,12 @@ Tests - Issue #8193: Fix test_zlib failure with zlib 1.2.4. +Documentation +------------- + +- Issue #7829: Document in dis that bytecode is an implementation detail. + + What's New in Python 3.1.2? =========================== -- 2.40.0