Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error: Process completed with exit code 139. on Python 3.11.0-alpha.3 #1294

Closed
oittaa opened this issue Dec 23, 2021 · 12 comments
Closed

Error: Process completed with exit code 139. on Python 3.11.0-alpha.3 #1294

oittaa opened this issue Dec 23, 2021 · 12 comments
Labels
bug Something isn't working fixed

Comments

@oittaa
Copy link

oittaa commented Dec 23, 2021

Describe the bug

I noticed that my GitHub tests that use 3.11-dev as one of their Python versions started to fail after alpha 3 release.

/home/runner/work/_temp/2b7509c5-dbf2-4144-be0a-3be053d8594c.sh: line 1:  1866 Segmentation fault      (core dumped) coverage run -m unittest discover
Error: Process completed with exit code 139.

To Reproduce

  1. Create a GitHub action that uses 3.11-dev as a Python version.
  2. Create a step with coverage run -m unittest discover

Expected behavior
No segmentation faults.

Additional context
For example https://github.com/oittaa/ibkr-report-parser/runs/4615838413?check_suite_focus=true#step:8:12 and https://github.com/oittaa/uuid6-python/runs/4615723292?check_suite_focus=true#step:7:23

@oittaa oittaa added bug Something isn't working needs triage labels Dec 23, 2021
@jepler
Copy link

jepler commented Dec 25, 2021

I am seeing similar. Some fraction of the time, it does succeed. (about 50/50)

As this seems to devolve to a problem with MyFrame_Lasti it is maybe

  1. Use a Debian / Ubuntu amd64 system
  2. Un-tar https://github.com/actions/python-versions/releases/download/3.11.0-alpha.3-120611/python-3.11.0-alpha.3-win32-x64.zip in /tmp/py311
  3. Fix the binary so it doesn't need LD_LIBRARY_PATH set, or to be untarred in a specific location (not strictly necessary, can use LD_LIBRARY_PATH=/tmp/py311/lib instead): chrpath -r '${ORIGIN}/../lib' /tmp/py311/bin/python3
  4. Create a virtual environment in /tmp/env311: /tmp/py311/bin/python -mvenv create /tmp/env311; . /tmp/env311/bin/activate
  5. git clone https://github.com/jepler/wwvbpy && cd wwvbpy && pip install -r requirements_dev.txt (tested at 2afca67091e607c4032ad0600361d578bfdafaf6)
  6. gdb --args python -m coverage run --branch -p -m wwvb.gen -m 1 2020 1 1 12 30
  7. At the gdb prompt, run.
(gdb) r
Starting program: /tmp/311_env/bin/python -m coverage run --branch -p -m wwvb.gen -m 1 2020 1 1 12 30
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".

Program received signal SIGSEGV, Segmentation fault.
CTracer_handle_return (frame=0x7ffff6797d70, self=0x7ffff67e6c70) at coverage/ctracer/tracer.c:698
698	coverage/ctracer/tracer.c: No such file or directory.
(gdb) where
#0  CTracer_handle_return (frame=0x7ffff6797d70, self=0x7ffff67e6c70) at coverage/ctracer/tracer.c:698
#1  CTracer_trace (self=0x7ffff67e6c70, frame=0x7ffff6797d70, what=3, arg_unused=<optimized out>) at coverage/ctracer/tracer.c:784
#2  0x00007ffff7cabcb3 in call_trace (func=0x7ffff7108f70 <CTracer_trace>, obj=0x7ffff67e6c70, tstate=0x555555576b70, frame=0x7ffff7fc1ff0, what=<optimized out>, arg=<optimized out>)
    at Python/ceval.c:6331
#3  0x00007ffff7cabdcc in call_trace_protected (func=0x7ffff7108f70 <CTracer_trace>, obj=0x7ffff67e6c70, tstate=0x555555576b70, frame=0x7ffff7fc1ff0, what=3, 
    arg=0x7ffff7e4a060 <_Py_NoneStruct>) at Python/ceval.c:6286
#4  0x00007ffff7cabe50 in trace_function_exit (tstate=0x555555576b70, frame=0x7ffff7fc1ff0, retval=0x7ffff7e4a060 <_Py_NoneStruct>) at Python/ceval.c:1612
#5  0x00007ffff7c279f8 in _PyEval_EvalFrameDefault (tstate=<optimized out>, frame=<optimized out>, throwflag=<optimized out>) at Python/ceval.c:2475
#6  0x00007ffff7c1d7cc in _PyEval_EvalFrame (throwflag=0, frame=0x7ffff7fc1ff0, tstate=0x555555576b70) at ./Include/internal/pycore_ceval.h:48
#7  _PyEval_Vector (tstate=<optimized out>, func=<optimized out>, locals=<optimized out>, args=<optimized out>, argcount=0, kwnames=<optimized out>) at Python/ceval.c:5937
#8  0x00007ffff7cab4ce in PyEval_EvalCode (co=co@entry=0x7ffff644b670, globals=globals@entry=0x7ffff6444580, locals=locals@entry=0x7ffff6444580) at Python/ceval.c:1138
#9  0x00007ffff7caa44f in builtin_exec_impl (module=<optimized out>, locals=0x7ffff6444580, globals=0x7ffff6444580, source=0x7ffff644b670) at Python/bltinmodule.c:1057
#10 builtin_exec (module=<optimized out>, args=args@entry=0x7ffff665abd8, nargs=<optimized out>) at Python/clinic/bltinmodule.c.h:371
#11 0x00007ffff7bd8012 in cfunction_vectorcall_FASTCALL (func=0x7ffff72f8ae0, args=0x7ffff665abd8, nargsf=<optimized out>, kwnames=<optimized out>) at Objects/methodobject.c:430
#12 0x00007ffff7ba1a5a in PyObject_Call () from /tmp/py311/bin/../lib/libpython3.11.so.1.0
#13 0x00007ffff7c2678e in do_call_core (use_tracing=<optimized out>, kwdict=0x7ffff64449c0, callargs=0x7ffff665abc0, func=0x7ffff72f8ae0, tstate=<optimized out>) at Python/ceval.c:6736
#14 _PyEval_EvalFrameDefault (tstate=<optimized out>, frame=<optimized out>, throwflag=<optimized out>) at Python/ceval.c:4903
#15 0x00007ffff7c1d7cc in _PyEval_EvalFrame (throwflag=0, frame=0x7ffff7fc1c88, tstate=0x555555576b70) at ./Include/internal/pycore_ceval.h:48
#16 _PyEval_Vector (tstate=<optimized out>, func=<optimized out>, locals=<optimized out>, args=<optimized out>, argcount=2, kwnames=<optimized out>) at Python/ceval.c:5937
#17 0x00007ffff7ba0b8e in _PyObject_VectorcallTstate (kwnames=0x0, nargsf=<optimized out>, args=0x7fffffffccd0, callable=0x7ffff7300540, tstate=0x555555576b70)
    at ./Include/internal/pycore_call.h:89
#18 object_vacall (tstate=0x555555576b70, base=<optimized out>, callable=0x7ffff7300540, vargs=<optimized out>) at Objects/call.c:784
#19 0x00007ffff7ba206c in _PyObject_CallMethodIdObjArgs (obj=0x0, name=name@entry=0x7ffff7e543a0 <PyId__find_and_load.17574>) at Objects/call.c:874
#20 0x00007ffff7c405d0 in import_find_and_load (abs_name=0x7ffff64547f0, tstate=0x555555576b70) at Python/import.c:1739
#21 PyImport_ImportModuleLevelObject (name=name@entry=0x7ffff6cb31b0, globals=<optimized out>, locals=<optimized out>, fromlist=fromlist@entry=0x7ffff7326e60, level=1)
    at Python/import.c:1840
#22 0x00007ffff7c23e99 in import_name (level=0x7ffff7f4c418 <_PyRuntime+280>, fromlist=0x7ffff7326e60, name=0x7ffff6cb31b0, frame=0x7ffff7fc1bc0, tstate=<optimized out>)
    at Python/ceval.c:6837
#23 _PyEval_EvalFrameDefault (tstate=<optimized out>, frame=<optimized out>, throwflag=<optimized out>) at Python/ceval.c:3953
#24 0x00007ffff7c1d7cc in _PyEval_EvalFrame (throwflag=0, frame=0x7ffff7fc1bc0, tstate=0x555555576b70) at ./Include/internal/pycore_ceval.h:48
#25 _PyEval_Vector (tstate=<optimized out>, func=<optimized out>, locals=<optimized out>, args=<optimized out>, argcount=0, kwnames=<optimized out>) at Python/ceval.c:5937
#26 0x00007ffff7cab4ce in PyEval_EvalCode (co=co@entry=0x7ffff644b4b0, globals=globals@entry=0x7ffff6444b00, locals=locals@entry=0x7ffff6444b00) at Python/ceval.c:1138
#27 0x00007ffff7caa44f in builtin_exec_impl (module=<optimized out>, locals=0x7ffff6444b00, globals=0x7ffff6444b00, source=0x7ffff644b4b0) at Python/bltinmodule.c:1057
#28 builtin_exec (module=<optimized out>, args=args@entry=0x7ffff665af18, nargs=<optimized out>) at Python/clinic/bltinmodule.c.h:371
#29 0x00007ffff7bd8012 in cfunction_vectorcall_FASTCALL (func=0x7ffff72f8ae0, args=0x7ffff665af18, nargsf=<optimized out>, kwnames=<optimized out>) at Objects/methodobject.c:430
#30 0x00007ffff7ba1a5a in PyObject_Call () from /tmp/py311/bin/../lib/libpython3.11.so.1.0
#31 0x00007ffff7c2678e in do_call_core (use_tracing=<optimized out>, kwdict=0x7ffff6444840, callargs=0x7ffff665af00, func=0x7ffff72f8ae0, tstate=<optimized out>) at Python/ceval.c:6736
#32 _PyEval_EvalFrameDefault (tstate=<optimized out>, frame=<optimized out>, throwflag=<optimized out>) at Python/ceval.c:4903
#33 0x00007ffff7c1d7cc in _PyEval_EvalFrame (throwflag=0, frame=0x7ffff7fc1858, tstate=0x555555576b70) at ./Include/internal/pycore_ceval.h:48
#34 _PyEval_Vector (tstate=<optimized out>, func=<optimized out>, locals=<optimized out>, args=<optimized out>, argcount=2, kwnames=<optimized out>) at Python/ceval.c:5937
#35 0x00007ffff7ba0b8e in _PyObject_VectorcallTstate (kwnames=0x0, nargsf=<optimized out>, args=0x7fffffffd4d0, callable=0x7ffff7300540, tstate=0x555555576b70)
    at ./Include/internal/pycore_call.h:89
#36 object_vacall (tstate=0x555555576b70, base=<optimized out>, callable=0x7ffff7300540, vargs=<optimized out>) at Objects/call.c:784
#37 0x00007ffff7ba206c in _PyObject_CallMethodIdObjArgs (obj=0x0, name=name@entry=0x7ffff7e543a0 <PyId__find_and_load.17574>) at Objects/call.c:874
#38 0x00007ffff7c405d0 in import_find_and_load (abs_name=0x7ffff64445f0, tstate=0x555555576b70) at Python/import.c:1739
#39 PyImport_ImportModuleLevelObject (name=0x7ffff64445f0, globals=<optimized out>, locals=<optimized out>, fromlist=0x7ffff666ed00, level=0) at Python/import.c:1840
#40 0x00007ffff7c1bc6c in builtin___import__ (self=<optimized out>, args=<optimized out>, kwds=<optimized out>) at Python/bltinmodule.c:272
#41 0x00007ffff7bd7f62 in cfunction_call (func=0x7ffff72f8680, args=<optimized out>, kwargs=<optimized out>) at Objects/methodobject.c:543
#42 0x00007ffff7ba0199 in _PyObject_MakeTpCall (tstate=0x555555576b70, callable=0x7ffff72f8680, args=<optimized out>, nargs=<optimized out>, keywords=<optimized out>) at Objects/call.c:214
#43 0x00007ffff7c27329 in trace_call_function (kwnames=0x7ffff7327b80, nargs=1, args=<optimized out>, func=0x7ffff72f8680, tstate=<optimized out>) at Python/ceval.c:6700
#44 _PyEval_EvalFrameDefault (tstate=<optimized out>, frame=<optimized out>, throwflag=<optimized out>) at Python/ceval.c:4658
#45 0x00007ffff7c1d7cc in _PyEval_EvalFrame (throwflag=0, frame=0x7ffff7fc11d8, tstate=0x555555576b70) at ./Include/internal/pycore_ceval.h:48
#46 _PyEval_Vector (tstate=<optimized out>, func=<optimized out>, locals=<optimized out>, args=<optimized out>, argcount=0, kwnames=<optimized out>) at Python/ceval.c:5937
#47 0x00007ffff7cab4ce in PyEval_EvalCode (co=co@entry=0x7ffff713e170, globals=globals@entry=0x7ffff73613c0, locals=locals@entry=0x7ffff73613c0) at Python/ceval.c:1138
#48 0x00007ffff7caa44f in builtin_exec_impl (module=<optimized out>, locals=0x7ffff73613c0, globals=0x7ffff73613c0, source=0x7ffff713e170) at Python/bltinmodule.c:1057
#49 builtin_exec (module=<optimized out>, args=args@entry=0x7ffff7fc1190, nargs=<optimized out>) at Python/clinic/bltinmodule.c.h:371
#50 0x00007ffff7bd8012 in cfunction_vectorcall_FASTCALL (func=func@entry=0x7ffff72f8ae0, args=0x7ffff7fc1190, nargsf=<optimized out>, kwnames=<optimized out>) at Objects/methodobject.c:430
#51 0x00007ffff7ba098b in _PyObject_VectorcallTstate (kwnames=<optimized out>, nargsf=<optimized out>, args=<optimized out>, callable=0x7ffff72f8ae0, tstate=0x555555576b70)
    at ./Include/internal/pycore_call.h:89
#52 PyObject_Vectorcall (callable=0x7ffff72f8ae0, args=<optimized out>, nargsf=<optimized out>, kwnames=<optimized out>) at Objects/call.c:298
#53 0x00007ffff7c1f354 in _PyEval_EvalFrameDefault (tstate=<optimized out>, frame=<optimized out>, throwflag=<optimized out>) at Python/ceval.c:4661
#54 0x00007ffff7c1d7cc in _PyEval_EvalFrame (throwflag=0, frame=0x7ffff7fc1020, tstate=0x555555576b70) at ./Include/internal/pycore_ceval.h:48
#55 _PyEval_Vector (tstate=<optimized out>, func=<optimized out>, locals=<optimized out>, args=<optimized out>, argcount=2, kwnames=<optimized out>) at Python/ceval.c:5937
#56 0x00007ffff7ba1a5a in PyObject_Call () from /tmp/py311/bin/../lib/libpython3.11.so.1.0
#57 0x00007ffff7ccac07 in pymain_run_module (modname=<optimized out>, set_argv0=<optimized out>) at Modules/main.c:294
#58 0x00007ffff7cca96b in pymain_run_python (exitcode=0x7fffffffddc0) at Modules/main.c:587
#59 Py_RunMain () at Modules/main.c:672
#60 0x00007ffff7cca4cd in Py_BytesMain (argc=<optimized out>, argv=<optimized out>) at Modules/main.c:726
#61 0x00007ffff77ead0a in __libc_start_main (main=0x555555555060 <main>, argc=15, argv=0x7fffffffdff8, init=<optimized out>, fini=<optimized out>, rtld_fini=<optimized out>, 
    stack_end=0x7fffffffdfe8) at ../csu/libc-start.c:308
#62 0x000055555555509e in _start ()

local variables of CTracer_handle_return, from a different run:

Program received signal SIGSEGV, Segmentation fault.
CTracer_handle_return (frame=0x7ffff67a7cc0, self=0x7ffff67e6d30)
    at coverage/ctracer/tracer.c:698
698	coverage/ctracer/tracer.c: No such file or directory.
(gdb) info local
bytecode = <optimized out>
pCode = 0x7ffff66ae040
lasti = -268943664
ret = -1
error = <optimized out>
ret = <optimized out>
error = <optimized out>
bytecode = <optimized out>
pCode = <optimized out>
lasti = <optimized out>
first = <optimized out>
val = <optimized out>

It looks like the erroneous-seeming value in lasti is a step in the chain that causes the segfault. It's the actual subscript being used on PyBytes_AS_STRING(pCode).

 693             int lasti = MyFrame_lasti(frame);
 694 
 695             if (lasti < PyBytes_GET_SIZE(pCode)) {    
 696                 bytecode = PyBytes_AS_STRING(pCode)[lasti];
 697             }
 698             if (bytecode != YIELD_VALUE) {
 699                 int first = MyFrame_GetCode(frame)->co_firstlineno;
(gdb) x/i $pc
=> 0x7ffff71093ef <CTracer_trace+1151>:	cmpb   $0x56,0x20(%rdx,%rax,1)
(gdb) p PyBytes_AsString(pCode)
$14 = 0x7ffff66ae060 "U"
(gdb) p/x $rdx
$15 = 0x7ffff66ae040
(gdb) p $rax
$16 = -268943664
(gdb) p lasti
$17 = -268943664

Output of coverage debug sys:

-- sys -------------------------------------------------------
               coverage_version: 6.2
                coverage_module: /tmp/311_env/lib/python3.11/site-packages/coverage/__init__.py
                         tracer: -none-
                        CTracer: available
           plugins.file_tracers: -none-
            plugins.configurers: -none-
      plugins.context_switchers: -none-
              configs_attempted: .coveragerc
                   configs_read: /home/jepler/src/wwvbpy/.coveragerc
                    config_file: /home/jepler/src/wwvbpy/.coveragerc
                config_contents: b'# SPDX-FileCopyrightText: 2021 Jeff Epler\n#\n# SPDX-License-Identifier: GPL-3.0-only\n[run]\nomit =\n    */site-packages/*\n    test*.py\n'
                      data_file: -none-
                         python: 3.11.0a3 (main, Dec 22 2021, 10:17:10) [GCC 9.3.0]
                       platform: Linux-5.10.0-8-amd64-x86_64-with-glibc2.31
                 implementation: CPython
                     executable: /tmp/311_env/bin/python
                   def_encoding: utf-8
                    fs_encoding: utf-8
                            pid: 2552809
                            cwd: /home/jepler/src/wwvbpy
                           path: /home/jepler/src/wwvbpy
                                 /opt/hostedtoolcache/Python/3.11.0-alpha.3/x64/lib/python311.zip
                                 /tmp/py311/lib/python3.11
                                 /tmp/py311/lib/python3.11/lib-dynload
                                 /tmp/311_env/lib/python3.11/site-packages
                    environment: HOME = /home/jepler
                   command_line: /tmp/311_env/lib/python3.11/site-packages/coverage/__main__.py debug sys
                sqlite3_version: 2.6.0
         sqlite3_sqlite_version: 3.34.1
             sqlite3_temp_store: 0
        sqlite3_compile_options: COMPILER=gcc-10.2.1 20210110; ENABLE_COLUMN_METADATA; ENABLE_DBSTAT_VTAB
                                 ENABLE_FTS3; ENABLE_FTS3_PARENTHESIS; ENABLE_FTS3_TOKENIZER
                                 ENABLE_FTS4; ENABLE_FTS5; ENABLE_JSON1
                                 ENABLE_LOAD_EXTENSION; ENABLE_PREUPDATE_HOOK; ENABLE_RTREE
                                 ENABLE_SESSION; ENABLE_STMTVTAB; ENABLE_UNLOCK_NOTIFY
                                 ENABLE_UPDATE_DELETE_LIMIT; HAVE_ISNAN; LIKE_DOESNT_MATCH_BLOBS
                                 MAX_SCHEMA_RETRY=25; MAX_VARIABLE_NUMBER=250000; OMIT_LOOKASIDE
                                 SECURE_DELETE; SOUNDEX; TEMP_STORE=1
                                 THREADSAFE=1; USE_URI

Frustratingly, running under valgrind never reproduced the problem in 30 runs.

@jepler
Copy link

jepler commented Dec 25, 2021

Omitting --branch or adding --timid seems to make my test case succeed consistently.

Infernio added a commit to zoia-lang/zoia that referenced this issue Dec 26, 2021
Seems to cause random segfaults right now:
nedbat/coveragepy#1294
@parafoxia
Copy link

If you change your action to use 3.11.0-alpha.2 instead of 3.11-dev it will work. For some reason this seems to be an issue related specifically to 3.11.0a3. I've been trying to work out exactly what causes it but I can't seem to pinpoint it.

@jouve
Copy link

jouve commented Jan 7, 2022

I think the issue is related to this binary incompatible change to struct _interpreter_frame between alpha.2 and alpha.3 : python/cpython@135cabd#diff-dc43b169f3202922a7787b97210ce299172f0cf03bd88529d473128f32e49fe4

and my guess that 6.2 was compiled before the change.

This show in disassembly of tracer.cpython-311-x86_64-linux-gnu.so from the wheel

693     in coverage/ctracer/tracer.c
   0x00000000000033de <+1134>:  mov    0x18(%r15),%rax       # frame->f_frame
   0x00000000000033e2 <+1138>:  mov    0x38(%rax),%eax       # f_frame->f_lasti
   0x00000000000033e5 <+1141>:  add    %eax,%eax

f_lasti is acceced at 0x38 = 0x08 * 7 (PyObject *f_globals to PyObject *generator)
where the correct offset should be 0x40 = 0x08 * 8 (PyFunctionObject *f_func to PyObject *generator)

The can be verified by accessing the value at 0x40 and comparing to python's own frame_getlasti :

(gdb) p *(int*)((void*)frame->f_frame + 0x40) * 2
$189 = 16
(gdb) p PyLong_AsLong(frame_getlasti(frame, 0))     
$186 = 16

@nedbat
Copy link
Owner

nedbat commented Jan 7, 2022

I guess I shouldn't publish wheels for alpha versions of Python? Everyone here: does the problem go away if you install coverage from git?

pip install git+https://github.com/nedbat/[email protected]

@nedbat nedbat added kit question Further information is requested next and removed needs triage labels Jan 7, 2022
@jouve
Copy link

jouve commented Jan 7, 2022

@jepler
Copy link

jepler commented Jan 7, 2022

I guess I shouldn't publish wheels for alpha versions of Python? Everyone here: does the problem go away if you install coverage from git?

pip install git+https://github.com/nedbat/[email protected]

yes, that worked for me.

@nedbat
Copy link
Owner

nedbat commented Jan 7, 2022

Is the problem here that I used an internal field, or that wheels made for alpha 2 aren't expected to work on alpha 3?

@jepler
Copy link

jepler commented Jan 8, 2022

I'm way out of the loop when it comes to language lawyering of CPython but https://www.python.org/dev/peps/pep-0652/ + https://github.com/python/cpython/blob/main/Misc/stable_abi.txt does list PyFrameObject, but isn't specific as to what fields and offsets are guaranteed to be stable:

  • struct: A C struct. Currently this file does not distinguish between:
    • opaque structs, which the Limited API only handles via pointers (so these can change at any time)
    • structs where only certain members are part of the stable ABI (e.g. PyObject)
    • structs which must not be changed at all (e.g. PyType_Slot, which is fully defined and used in arrays)

The intent of the pyframe.h + frameobject.h header (checking into 3.9 here) is to hide all the fields from the compiler when Py_LIMITED_API is defined, implying that the fields and offsets of this header are not in the stable ABI.

So I guess .. it's more due to the use of the internal field than a "general lack of stable ABI" problem.

@jouve
Copy link

jouve commented Jan 16, 2022

The last whatsnew for py3.11 now refers to using PyObject_GetAttrString(frame, "lasti")

@nedbat nedbat removed the question Further information is requested label Jan 16, 2022
@nedbat
Copy link
Owner

nedbat commented Jan 16, 2022

As of 37ef7c7, everything works on 3.11.0a4. I haven't changed to use PyObject_GetAttrString, because the plans for CPython should make lasti unnecessary for me.

@nedbat
Copy link
Owner

nedbat commented Jan 25, 2022

This is now released as part of coverage 6.3.

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Aug 24, 2022
Version 6.4.4 — 2022-08-16
--------------------------

- Wheels are now provided for Python 3.11.


.. _changes_6-4-3:

Version 6.4.3 — 2022-08-06
--------------------------

- Fix a failure when combining data files if the file names contained
  glob-like patterns (`pull 1405`_).  Thanks, Michael Krebs and Benjamin
  Schubert.

- Fix a messaging failure when combining Windows data files on a different
  drive than the current directory. (`pull 1430`_, fixing `issue 1428`_).
  Thanks, Lorenzo Micò.

- Fix path calculations when running in the root directory, as you might do in
  a Docker container: `pull 1403`_, thanks Arthur Rio.

- Filtering in the HTML report wouldn't work when reloading the index page.
  This is now fixed (`pull 1413`_).  Thanks, Marc Legendre.

- Fix a problem with Cython code measurement (`pull 1347`_, fixing `issue
  972`_).  Thanks, Matus Valo.

.. _issue 972: nedbat/coveragepy#972
.. _pull 1347: nedbat/coveragepy#1347
.. _pull 1403: nedbat/coveragepy#1403
.. _pull 1405: nedbat/coveragepy#1405
.. _pull 1413: nedbat/coveragepy#1413
.. _issue 1428: nedbat/coveragepy#1428
.. _pull 1430: nedbat/coveragepy#1430


.. _changes_6-4-2:

Version 6.4.2 — 2022-07-12
--------------------------

- Updated for a small change in Python 3.11.0 beta 4: modules now start with a
  line with line number 0, which is ignored.  This line cannnot be executed, so
  coverage totals were thrown off.  This line is now ignored by coverage.py,
  but this also means that truly empty modules (like ``__init__.py``) have no
  lines in them, rather than one phantom line.  Fixes `issue 1419`_.

- Internal debugging data added to sys.modules is now an actual module, to
  avoid confusing code that examines everything in sys.modules.  Thanks,
  Yilei Yang (`pull 1399`_).

.. _pull 1399: nedbat/coveragepy#1399
.. _issue 1419: nedbat/coveragepy#1419


.. _changes_6-4-1:

Version 6.4.1 — 2022-06-02
--------------------------

- Greatly improved performance on PyPy, and other environments that need the
  pure Python trace function.  Thanks, Carl Friedrich Bolz-Tereick (`pull
  1381`_ and `pull 1388`_).  Slightly improved performance when using the C
  trace function, as most environments do.  Closes `issue 1339`_.

- The conditions for using tomllib from the standard library have been made
  more precise, so that 3.11 alphas will continue to work. Closes `issue
  1390`_.

.. _issue 1339: nedbat/coveragepy#1339
.. _pull 1381: nedbat/coveragepy#1381
.. _pull 1388: nedbat/coveragepy#1388
.. _issue 1390: nedbat/coveragepy#1390


.. _changes_64:

Version 6.4 — 2022-05-22
------------------------

- A new setting, :ref:`config_run_sigterm`, controls whether a SIGTERM signal
  handler is used.  In 6.3, the signal handler was always installed, to capture
  data at unusual process ends.  Unfortunately, this introduced other problems
  (see `issue 1310`_).  Now the signal handler is only used if you opt-in by
  setting ``[run] sigterm = true``.

- Small changes to the HTML report:

  - Added links to next and previous file, and more keyboard shortcuts: ``[``
    and ``]`` for next file and previous file; ``u`` for up to the index; and
    ``?`` to open/close the help panel.  Thanks, `J. M. F. Tsang
    <pull 1364_>`_.

  - The timestamp and version are displayed at the top of the report.  Thanks,
    `Ammar Askar <pull 1354_>`_. Closes `issue 1351`_.

- A new debug option ``debug=sqldata`` adds more detail to ``debug=sql``,
  logging all the data being written to the database.

- Previously, running ``coverage report`` (or any of the reporting commands) in
  an empty directory would create a .coverage data file.  Now they do not,
  fixing `issue 1328`_.

- On Python 3.11, the ``[toml]`` extra no longer installs tomli, instead using
  tomllib from the standard library.  Thanks `Shantanu <pull 1359_>`_.

- In-memory CoverageData objects now properly update(), closing `issue 1323`_.

.. _issue 1310: nedbat/coveragepy#1310
.. _issue 1323: nedbat/coveragepy#1323
.. _issue 1328: nedbat/coveragepy#1328
.. _issue 1351: nedbat/coveragepy#1351
.. _pull 1354: nedbat/coveragepy#1354
.. _pull 1359: nedbat/coveragepy#1359
.. _pull 1364: nedbat/coveragepy#1364


.. _changes_633:

Version 6.3.3 — 2022-05-12
--------------------------

- Fix: Coverage.py now builds successfully on CPython 3.11 (3.11.0b1) again.
  Closes `issue 1367`_.  Some results for generators may have changed.

.. _issue 1367: nedbat/coveragepy#1367


.. _changes_632:

Version 6.3.2 — 2022-02-20
--------------------------

- Fix: adapt to pypy3.9's decorator tracing behavior.  It now traces function
  decorators like CPython 3.8: both the @-line and the def-line are traced.
  Fixes `issue 1326`_.

- Debug: added ``pybehave`` to the list of :ref:`coverage debug <cmd_debug>`
  and :ref:`cmd_run_debug` options.

- Fix: show an intelligible error message if ``--concurrency=multiprocessing``
  is used without a configuration file.  Closes `issue 1320`_.

.. _issue 1320: nedbat/coveragepy#1320
.. _issue 1326: nedbat/coveragepy#1326


.. _changes_631:

Version 6.3.1 — 2022-02-01
--------------------------

- Fix: deadlocks could occur when terminating processes.  Some of these
  deadlocks (described in `issue 1310`_) are now fixed.

- Fix: a signal handler was being set from multiple threads, causing an error:
  "ValueError: signal only works in main thread".  This is now fixed, closing
  `issue 1312`_.

- Fix: ``--precision`` on the command-line was being ignored while considering
  ``--fail-under``.  This is now fixed, thanks to
  `Marcelo Trylesinski <pull 1317_>`_.

- Fix: releases no longer provide 3.11.0-alpha wheels. Coverage.py uses CPython
  internal fields which are moving during the alpha phase. Fixes `issue 1316`_.

.. _issue 1310: nedbat/coveragepy#1310
.. _issue 1312: nedbat/coveragepy#1312
.. _issue 1316: nedbat/coveragepy#1316
.. _pull 1317: nedbat/coveragepy#1317


.. _changes_63:

Version 6.3 — 2022-01-25
------------------------

- Feature: Added the ``lcov`` command to generate reports in LCOV format.
  Thanks, `Bradley Burns <pull 1289_>`_. Closes issues `587 <issue 587_>`_
  and `626 <issue 626_>`_.

- Feature: the coverage data file can now be specified on the command line with
  the ``--data-file`` option in any command that reads or writes data.  This is
  in addition to the existing ``COVERAGE_FILE`` environment variable.  Closes
  `issue 624`_. Thanks, `Nikita Bloshchanevich <pull 1304_>`_.

- Feature: coverage measurement data will now be written when a SIGTERM signal
  is received by the process.  This includes
  :meth:`Process.terminate <python:multiprocessing.Process.terminate>`,
  and other ways to terminate a process.  Currently this is only on Linux and
  Mac; Windows is not supported.  Fixes `issue 1307`_.

- Dropped support for Python 3.6, which reached end-of-life on 2021-12-23.

- Updated Python 3.11 support to 3.11.0a4, fixing `issue 1294`_.

- Fix: the coverage data file is now created in a more robust way, to avoid
  problems when multiple processes are trying to write data at once. Fixes
  issues `1303 <issue 1303_>`_ and `883 <issue 883_>`_.

- Fix: a .gitignore file will only be written into the HTML report output
  directory if the directory is empty.  This should prevent certain unfortunate
  accidents of writing the file where it is not wanted.

- Releases now have MacOS arm64 wheels for Apple Silicon, fixing `issue 1288`_.

.. _issue 587: nedbat/coveragepy#587
.. _issue 624: nedbat/coveragepy#624
.. _issue 626: nedbat/coveragepy#626
.. _issue 883: nedbat/coveragepy#883
.. _issue 1288: nedbat/coveragepy#1288
.. _issue 1294: nedbat/coveragepy#1294
.. _issue 1303: nedbat/coveragepy#1303
.. _issue 1307: nedbat/coveragepy#1307
.. _pull 1289: nedbat/coveragepy#1289
.. _pull 1304: nedbat/coveragepy#1304


.. _changes_62:

Version 6.2 — 2021-11-26
------------------------

- Feature: Now the ``--concurrency`` setting can now have a list of values, so
  that threads and another lightweight threading package can be measured
  together, such as ``--concurrency=gevent,thread``.  Closes `issue 1012`_ and
  `issue 1082`_.

- Fix: A module specified as the ``source`` setting is imported during startup,
  before the user program imports it.  This could cause problems if the rest of
  the program isn't ready yet.  For example, `issue 1203`_ describes a Django
  setting that is accessed before settings have been configured.  Now the early
  import is wrapped in a try/except so errors then don't stop execution.

- Fix: A colon in a decorator expression would cause an exclusion to end too
  early, preventing the exclusion of the decorated function. This is now fixed.

- Fix: The HTML report now will not overwrite a .gitignore file that already
  exists in the HTML output directory (follow-on for `issue 1244`_).

- API: The exceptions raised by Coverage.py have been specialized, to provide
  finer-grained catching of exceptions by third-party code.

- API: Using ``suffix=False`` when constructing a Coverage object with
  multiprocessing wouldn't suppress the data file suffix (`issue 989`_).  This
  is now fixed.

- Debug: The ``coverage debug data`` command will now sniff out combinable data
  files, and report on all of them.

- Debug: The ``coverage debug`` command used to accept a number of topics at a
  time, and show all of them, though this was never documented.  This no longer
  works, to allow for command-line options in the future.

.. _issue 989: nedbat/coveragepy#989
.. _issue 1012: nedbat/coveragepy#1012
.. _issue 1082: nedbat/coveragepy#1082
.. _issue 1203: nedbat/coveragepy#1203


.. _changes_612:

Version 6.1.2 — 2021-11-10
--------------------------

- Python 3.11 is supported (tested with 3.11.0a2).  One still-open issue has to
  do with `exits through with-statements <issue 1270_>`_.

- Fix: When remapping file paths through the ``[paths]`` setting while
  combining, the ``[run] relative_files`` setting was ignored, resulting in
  absolute paths for remapped file names (`issue 1147`_).  This is now fixed.

- Fix: Complex conditionals over excluded lines could have incorrectly reported
  a missing branch (`issue 1271`_). This is now fixed.

- Fix: More exceptions are now handled when trying to parse source files for
  reporting.  Problems that used to terminate coverage.py can now be handled
  with ``[report] ignore_errors``.  This helps with plugins failing to read
  files (`django_coverage_plugin issue 78`_).

- Fix: Removed another vestige of jQuery from the source tarball
  (`issue 840`_).

- Fix: Added a default value for a new-to-6.x argument of an internal class.
  This unsupported class is being used by coveralls (`issue 1273`_). Although
  I'd rather not "fix" unsupported interfaces, it's actually nicer with a
  default value.

.. _django_coverage_plugin issue 78: nedbat/django_coverage_plugin#78
.. _issue 1147: nedbat/coveragepy#1147
.. _issue 1270: nedbat/coveragepy#1270
.. _issue 1271: nedbat/coveragepy#1271
.. _issue 1273: nedbat/coveragepy#1273


.. _changes_611:

Version 6.1.1 — 2021-10-31
--------------------------

- Fix: The sticky header on the HTML report didn't work unless you had branch
  coverage enabled. This is now fixed: the sticky header works for everyone.
  (Do people still use coverage without branch measurement!? j/k)

- Fix: When using explicitly declared namespace packages, the "already imported
  a file that will be measured" warning would be issued (`issue 888`_).  This
  is now fixed.

.. _issue 888: nedbat/coveragepy#888


.. _changes_61:

Version 6.1 — 2021-10-30
------------------------

- Deprecated: The ``annotate`` command and the ``Coverage.annotate`` function
  will be removed in a future version, unless people let me know that they are
  using it.  Instead, the ``html`` command gives better-looking (and more
  accurate) output, and the ``report -m`` command will tell you line numbers of
  missing lines.  Please get in touch if you have a reason to use ``annotate``
  over those better options: [email protected].

- Feature: Coverage now sets an environment variable, ``COVERAGE_RUN`` when
  running your code with the ``coverage run`` command.  The value is not
  important, and may change in the future.  Closes `issue 553`_.

- Feature: The HTML report pages for Python source files now have a sticky
  header so the file name and controls are always visible.

- Feature: The ``xml`` and ``json`` commands now describe what they wrote
  where.

- Feature: The ``html``, ``combine``, ``xml``, and ``json`` commands all accept
  a ``-q/--quiet`` option to suppress the messages they write to stdout about
  what they are doing (`issue 1254`_).

- Feature: The ``html`` command writes a ``.gitignore`` file into the HTML
  output directory, to prevent the report from being committed to git.  If you
  want to commit it, you will need to delete that file.  Closes `issue 1244`_.

- Feature: Added support for PyPy 3.8.

- Fix: More generated code is now excluded from measurement.  Code such as
  `attrs`_ boilerplate, or doctest code, was being measured though the
  synthetic line numbers meant they were never reported.  Once Cython was
  involved though, the generated .so files were parsed as Python, raising
  syntax errors, as reported in `issue 1160`_.  This is now fixed.

- Fix: When sorting human-readable names, numeric components are sorted
  correctly: file10.py will appear after file9.py.  This applies to file names,
  module names, environment variables, and test contexts.

- Performance: Branch coverage measurement is faster, though you might only
  notice on code that is executed many times, such as long-running loops.

- Build: jQuery is no longer used or vendored (`issue 840`_ and `issue 1118`_).
  Huge thanks to Nils Kattenbeck (septatrix) for the conversion to vanilla
  JavaScript in `pull request 1248`_.

.. _issue 553: nedbat/coveragepy#553
.. _issue 840: nedbat/coveragepy#840
.. _issue 1118: nedbat/coveragepy#1118
.. _issue 1160: nedbat/coveragepy#1160
.. _issue 1244: nedbat/coveragepy#1244
.. _pull request 1248: nedbat/coveragepy#1248
.. _issue 1254: nedbat/coveragepy#1254
.. _attrs: https://www.attrs.org/


.. _changes_602:

Version 6.0.2 — 2021-10-11
--------------------------

- Namespace packages being measured weren't properly handled by the new code
  that ignores third-party packages. If the namespace package was installed, it
  was ignored as a third-party package.  That problem (`issue 1231`_) is now
  fixed.

- Packages named as "source packages" (with ``source``, or ``source_pkgs``, or
  pytest-cov's ``--cov``) might have been only partially measured.  Their
  top-level statements could be marked as unexecuted, because they were
  imported by coverage.py before measurement began (`issue 1232`_).  This is
  now fixed, but the package will be imported twice, once by coverage.py, then
  again by your test suite.  This could cause problems if importing the package
  has side effects.

- The :meth:`.CoverageData.contexts_by_lineno` method was documented to return
  a dict, but was returning a defaultdict.  Now it returns a plain dict.  It
  also no longer returns negative numbered keys.

.. _issue 1231: nedbat/coveragepy#1231
.. _issue 1232: nedbat/coveragepy#1232


.. _changes_601:

Version 6.0.1 — 2021-10-06
--------------------------

- In 6.0, the coverage.py exceptions moved from coverage.misc to
  coverage.exceptions. These exceptions are not part of the public supported
  API, CoverageException is. But a number of other third-party packages were
  importing the exceptions from coverage.misc, so they are now available from
  there again (`issue 1226`_).

- Changed an internal detail of how tomli is imported, so that tomli can use
  coverage.py for their own test suite (`issue 1228`_).

- Defend against an obscure possibility under code obfuscation, where a
  function can have an argument called "self", but no local named "self"
  (`pull request 1210`_).  Thanks, Ben Carlsson.

.. _pull request 1210: nedbat/coveragepy#1210
.. _issue 1226: nedbat/coveragepy#1226
.. _issue 1228: nedbat/coveragepy#1228


.. _changes_60:

Version 6.0 — 2021-10-03
------------------------

- The ``coverage html`` command now prints a message indicating where the HTML
  report was written.  Fixes `issue 1195`_.

- The ``coverage combine`` command now prints messages indicating each data
  file being combined.  Fixes `issue 1105`_.

- The HTML report now includes a sentence about skipped files due to
  ``skip_covered`` or ``skip_empty`` settings.  Fixes `issue 1163`_.

- Unrecognized options in the configuration file are no longer errors. They are
  now warnings, to ease the use of coverage across versions.  Fixes `issue
  1035`_.

- Fix handling of exceptions through context managers in Python 3.10. A missing
  exception is no longer considered a missing branch from the with statement.
  Fixes `issue 1205`_.

- Fix another rarer instance of "Error binding parameter 0 - probably
  unsupported type." (`issue 1010`_).

- Creating a directory for the coverage data file now is safer against
  conflicts when two coverage runs happen simultaneously (`pull 1220`_).
  Thanks, Clément Pit-Claudel.

.. _issue 1035: nedbat/coveragepy#1035
.. _issue 1105: nedbat/coveragepy#1105
.. _issue 1163: nedbat/coveragepy#1163
.. _issue 1195: nedbat/coveragepy#1195
.. _issue 1205: nedbat/coveragepy#1205
.. _pull 1220: nedbat/coveragepy#1220


.. _changes_60b1:

Version 6.0b1 — 2021-07-18
--------------------------

- Dropped support for Python 2.7, PyPy 2, and Python 3.5.

- Added support for the Python 3.10 ``match/case`` syntax.

- Data collection is now thread-safe.  There may have been rare instances of
  exceptions raised in multi-threaded programs.

- Plugins (like the `Django coverage plugin`_) were generating "Already
  imported a file that will be measured" warnings about Django itself.  These
  have been fixed, closing `issue 1150`_.

- Warnings generated by coverage.py are now real Python warnings.

- Using ``--fail-under=100`` with coverage near 100% could result in the
  self-contradictory message :code:`total of 100 is less than fail-under=100`.
  This bug (`issue 1168`_) is now fixed.

- The ``COVERAGE_DEBUG_FILE`` environment variable now accepts ``stdout`` and
  ``stderr`` to write to those destinations.

- TOML parsing now uses the `tomli`_ library.

- Some minor changes to usually invisible details of the HTML report:

  - Use a modern hash algorithm when fingerprinting, for high-security
    environments (`issue 1189`_).  When generating the HTML report, we save the
    hash of the data, to avoid regenerating an unchanged HTML page. We used to
    use MD5 to generate the hash, and now use SHA-3-256.  This was never a
    security concern, but security scanners would notice the MD5 algorithm and
    raise a false alarm.

  - Change how report file names are generated, to avoid leading underscores
    (`issue 1167`_), to avoid rare file name collisions (`issue 584`_), and to
    avoid file names becoming too long (`issue 580`_).

.. _Django coverage plugin: https://pypi.org/project/django-coverage-plugin/
.. _issue 580: nedbat/coveragepy#580
.. _issue 584: nedbat/coveragepy#584
.. _issue 1150: nedbat/coveragepy#1150
.. _issue 1167: nedbat/coveragepy#1167
.. _issue 1168: nedbat/coveragepy#1168
.. _issue 1189: nedbat/coveragepy#1189
.. _tomli: https://pypi.org/project/tomli/


.. _changes_56b1:

Version 5.6b1 — 2021-04-13
--------------------------

Note: 5.6 final was never released. These changes are part of 6.0.

- Third-party packages are now ignored in coverage reporting.  This solves a
  few problems:

  - Coverage will no longer report about other people's code (`issue 876`_).
    This is true even when using ``--source=.`` with a venv in the current
    directory.

  - Coverage will no longer generate "Already imported a file that will be
    measured" warnings about coverage itself (`issue 905`_).

- The HTML report uses j/k to move up and down among the highlighted chunks of
  code.  They used to highlight the current chunk, but 5.0 broke that behavior.
  Now the highlighting is working again.

- The JSON report now includes ``percent_covered_display``, a string with the
  total percentage, rounded to the same number of decimal places as the other
  reports' totals.

.. _issue 876: nedbat/coveragepy#876
.. _issue 905: nedbat/coveragepy#905
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fixed
Projects
None yet
Development

No branches or pull requests

5 participants