iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PEP 657: Update the env variable name and the C-API and add some clarifications (#2015)

This commit is contained in:
Pablo Galindo 2021-06-30 22:02:10 +01:00 committed by GitHub
parent a8e7358a8a
commit 2991089ed8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
pep-0657.rst
View File

@ -191,11 +191,16 @@ this PEP:
four-element tuples containing the full location of every instruction four-element tuples containing the full location of every instruction
(including start line, end line, start column offset and end column offset) (including start line, end line, start column offset and end column offset)
or ``None`` if the code object was created without the offset information. or ``None`` if the code object was created without the offset information.
* Three new C-API functions, ``PyCode_Addr2EndLine``, ``PyCode_Addr2StartOffset`` * One new C-API function: ::
and ``PyCode_Addr2EndOffset`` will be added that can obtain the end line, the
start column offsets and the end column offset respectively given the index int PyCode_Addr2Location(
of a bytecode instruction. These functions will return 0 if the information PyCodeObject *co, int addr,
is not available. int *startline, int *startcolumn,
int *endline, int *endcolumn)
will be added so the end line, the start column offsets and the end column
offset can be obtained given the index of a bytecode instruction. This
function will set the values to 0 if the information is not available.
The internal storage, compression and encoding of the information is left as an The internal storage, compression and encoding of the information is left as an
implementation detail and can be changed at any point as long as the public API implementation detail and can be changed at any point as long as the public API
@ -311,18 +316,22 @@ storage and memory overhead and to allow third party tools and other
programs that are currently parsing tracebacks to catch up the following programs that are currently parsing tracebacks to catch up the following
methods will be provided to deactivate this feature: methods will be provided to deactivate this feature:
* A new environment variable: ``PYNODEBUGRANGES``. * A new environment variable: ``PYTHONNODEBUGRANGES``.
* A new command line option for the dev mode: ``python -Xnodebugranges``. * A new command line option for the dev mode: ``python -Xnodebugranges``.
If any of these methods are used, the Python compiler will **not** populate If any of these methods are used, the Python compiler will **not** populate
code objects with the new information (``None`` will be used instead) and any code objects with the new information (``None`` will be used instead) and any
unmarshalled code objects that contain the extra information will have it stripped unmarshalled code objects that contain the extra information will have it stripped
away and replaced with ``None``). This method allows users to: away and replaced with ``None``). Additionally, the traceback machinery will not
show the extended location information even if the information was present.
This method allows users to:
* Create smaller ``pyc`` files by using one of the two methods when said files * Create smaller ``pyc`` files by using one of the two methods when said files
are created. are created.
* Don't load the extra information from ``pyc`` files if those were created with * Don't load the extra information from ``pyc`` files if those were created with
the extra information in the first place. the extra information in the first place.
* Deactivate the extra information when displaying tracebacks (the caret characters
indicating the location of the error).
Doing this has a **very small** performance hit as the interpreter state needs Doing this has a **very small** performance hit as the interpreter state needs
to be fetched when code objects are created to look up the configuration. to be fetched when code objects are created to look up the configuration.