Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Can I step into Python library code?

When I run my Python debugger, I can step into functions that I write. But if I try to step into a library function like os.mkdir("folder"), for example, it "steps over" it instead. Is there a way to step into builtin library functions to see what Python is doing under the hood?

Ideally there'd be a way to do this in PyPy so that you could keep drilling down into Python code.

like image 631
twasbrillig Avatar asked Oct 05 '14 01:10

twasbrillig


People also ask

How can I debug my Python code?

If you're only interested in debugging a Python script, the simplest way is to select the down-arrow next to the run button on the editor and select Debug Python File in Terminal.

How do I debug a Python package in VSCode?

You can also start the debugger by clicking on the down-arrow next to the run button on the editor, and selecting Debug Python File in Terminal. The debugger will stop at the first line of the file breakpoint. The current line is indicated with a yellow arrow in the left margin.


Video Answer


2 Answers

pdb, the Python Debugger, cannot step into C functions like os.mkdir, but gdb can. Try this:

gdb --args python whatever.py ...

Then:

start
break posix_mkdir
continue

You should see it stop inside Python's implementation of os.mkdir, as detailed here: https://stackoverflow.com/a/16617835/4323

like image 140
John Zwinck Avatar answered Oct 12 '22 14:10

John Zwinck


os.mkdir() is implemented in C code and pdb cannot step into that function.

You are limited to debugging pure Python code only; it doesn't matter if that code is part of the standard library or not. You can step into the shutil module, or os.path just fine, for example.

os.mkdir() has to call into native code because it interacts with the OS; even PyPy has to defer to the underlying (host-Python) os.mkdir() call to handle that part, so you cannot step into it with pdb even in PyPy. In fact, just like in CPython, that part of the standard library is part of the RPython runtime and not seen as 'native Python code' by PyPy either, just like the built-in types are part of the runtime environment.

You could run the PyPy interpreter untranslated (so not statically compile the RPython code but have Python run the PyPy interpreter directly), but that'll only give you access to the RPython code paths, not the os.mkdir() C code.

like image 29
Martijn Pieters Avatar answered Oct 12 '22 13:10

Martijn Pieters