debugging 如何从命令行调试使用python -m运行的Python模块?

whhtz7ly  于 2023-05-29  发布在  Python
关注(0)|答案(6)|浏览(214)

我知道Python脚本可以从命令行调试

python -m pdb my_script.py

如果my_script.py是要与python my_script.py一起运行脚本。
但是,Python模块my_module.py应该与python -m my_module一起运行。即使包含相对导入的脚本也应该使用python -m运行。如何在pdb的控制下运行python -m my_module?以下不起作用

python -m pdb -m my_module
6ss1mwsb

6ss1mwsb1#

现在不能执行此操作,因为-m会终止选项列表

python -h
...
-m mod : run library module as a script (terminates option list)
...

这意味着解释参数列表的其余部分是mod的工作,并且此行为完全取决于mod的内部设计以及它是否支持另一个**-m**
让我们看看在python 2.x的pdb中发生了什么。实际上,没有什么有趣的,它只需要提供一个脚本名称:

if not sys.argv[1:] or sys.argv[1] in ("--help", "-h"):
        print "usage: pdb.py scriptfile [arg] ..."
        sys.exit(2)

    mainpyfile =  sys.argv[1]     # Get script filename
    if not os.path.exists(mainpyfile):
        print 'Error:', mainpyfile, 'does not exist'
        sys.exit(1)

    del sys.argv[0]         # Hide "pdb.py" from argument list

    # Replace pdb's dir with script's dir in front of module search path.
    sys.path[0] = os.path.dirname(mainpyfile)

    # Note on saving/restoring sys.argv: it's a good idea when sys.argv was
    # modified by the script being debugged. It's a bad idea when it was
    # changed by the user from the command line. There is a "restart" command
    # which allows explicit specification of command line arguments.
    pdb = Pdb()
    while True:
        try:
            pdb._runscript(mainpyfile)

当前发布的python 3.x版本相同

喜讯

允许执行您所请求操作的pull请求在5天前为merged。多么神秘的巧合!这是密码
因此,只需等待即将到来的python3.x版本解决此问题即可)

qni6mghb

qni6mghb2#

Python 3.7增加了该功能

the docs中,看起来你的命令:

python -m pdb -m my_module

将开始在Python 3.7上工作:
版本3.7中的新功能:pdb.py现在接受一个-m选项,它执行模块的方式与python3 -m类似。与脚本一样,调试器将在模块的第一行之前暂停执行。
在Ubuntu 23.10、Python 3.11.2上测试:
main.py

a = 1
print(a)
a = 2
print(a)

然后:

python -m pdb -m main

导致:

> /home/ciro/test/main.py(1)<module>()
-> a = 1
(Pdb)
wfypjpf4

wfypjpf43#

下面的脚本将运行一个模块,如果在运行该模块时发生异常,则会中断到事后调试。它应该可以在Python 2.7和3.x中工作。

用法

mdb.py module_name [args ...]

已知限制

  • 在运行模块代码时,sys.argv[0]被保留为模块名称,而不是解析为模块的文件路径。
  • 如果未找到目标模块,则报告错误的方式与模块执行期间发生错误的方式没有任何不同
    mdb.py
#!/usr/bin/env python

from __future__ import print_function
import pdb
import runpy
import sys
import traceback

if len(sys.argv) == 0:
    print("Usage: mdb.py module_name [args ...]")
    exit(1)

modulename = sys.argv[1]
del sys.argv[0]

try:
    runpy.run_module(modulename, run_name='__main__')
except:
    traceback.print_exception(*sys.exc_info())
    print("")
    print("-" * 40)
    print("mdb: An exception occurred while executing module ", modulename)
    print("mdb: See the traceback above.")
    print("mdb: Entering post-mortem debugging.")
    print("-" * 40)
    pdb.post_mortem(sys.exc_info()[2])

演示

$ tree
.
├── mdb.py
└── mypackage
    ├── __init__.py
    ├── __main__.py
    └── mymodule.py

1 directory, 4 files

$ ###################### Examine the module code ###################
$ cat mypackage/mymodule.py 
from __future__ import print_function
import sys

print("mymodule loaded")

if __name__ == "__main__":
    print("mymodule executed")
    print("args:", sys.argv)

$ #################### Run the module through python ###############
$ python -m mypackage.mymodule abc defgh
mymodule loaded
mymodule executed
args: ['/home/leon/playground/mdb/mypackage/mymodule.py', 'abc', 'defgh']

$ #################### Run the module through mdb ##################
$ ./mdb.py mypackage.mymodule abc defgh
mymodule loaded
mymodule executed
args: ['mypackage.mymodule', 'abc', 'defgh']
$ ###   ^^^^^^^^^^^^^^^^^^
$ ### Note that sys.argv[0] is not resolved to the file path

$ ###################### Examine the module code ###################
$ cat mypackage/__main__.py 
from __future__ import print_function
import sys

print("mypackage loaded")

if __name__ == "__main__":
    print("mypackage executed")
    print("args:", sys.argv)
    print(x + y)

$ #################### Run the module through python ###############
$ python -m mypackage
mypackage loaded
mypackage executed
args: ['/home/leon/playground/mdb/mypackage/__main__.py']
Traceback (most recent call last):
  File "/usr/lib/python2.7/runpy.py", line 174, in _run_module_as_main
    "__main__", fname, loader, pkg_name)
  File "/usr/lib/python2.7/runpy.py", line 72, in _run_code
    exec code in run_globals
  File "/home/leon/playground/mdb/mypackage/__main__.py", line 9, in <module>
    print(x + y)
NameError: name 'x' is not defined

$ #################### Run the module through mdb ##################
$ ./mdb.py mypackage
mypackage loaded
mypackage executed
args: ['mypackage']
Traceback (most recent call last):
  File "./mdb.py", line 17, in <module>
    runpy.run_module(modulename, run_name='__main__')
  File "/usr/lib/python2.7/runpy.py", line 192, in run_module
    fname, loader, pkg_name)
  File "/usr/lib/python2.7/runpy.py", line 72, in _run_code
    exec code in run_globals
  File "/home/leon/playground/mdb/mypackage/__main__.py", line 9, in <module>
    print(x + y)
NameError: name 'x' is not defined

----------------------------------------
mdb: An exception occurred while executing module  mypackage
mdb: See the traceback above.
mdb: Entering post-mortem debugging.
----------------------------------------
> /home/leon/playground/mdb/mypackage/__main__.py(9)<module>()
-> print(x + y)
(Pdb) q
xuo3flqw

xuo3flqw4#

您可以在代码中添加pdb.set_trace()以进行交互式调试,然后添加要调试的代码。

class C:    
    def __init__(self, x):
        self.x = x

    def inst_f(self):
        pass

a = C('this is a')
import pdb
pdb.set_trace()
b = C('this is b')

print a.x is b.x

运行这个将输出

> c:\python27\tests\test.py(11)<module>()
-> b = C('this is b')
(Pdb)

并让你使用python调试器。

zbwhf8kr

zbwhf8kr5#

正如其他人所说,这个特性是在Python 3.7中添加的。然而,人们仍然在使用旧版本,所以希望下面的解决方案可以帮助这些人!
基本上,你可以创建一个脚本来运行这个模块,只需要导入这个包的__main__.py文件:

# runner.py
import path.to.my.module.__main__

然后在pdb下运行该脚本:python -m pdb runner.py [args]
此解决方案适用于相对导入(因为__main__在包路径下运行,而不是作为脚本调用)。
只需要导入__main__模块的原因是Python导入会触发要执行的顶层代码,而在__main__中,逻辑是在顶层执行的。

bqujaahr

bqujaahr6#

根据python命令行手册页,-m标志执行以下操作:
在sys.path中搜索指定模块,并将相应的.py文件作为脚本运行。
考虑到这一点,我会很有信心通过运行.py文件来进行调试,就像您的第一个示例一样。需要记住的一点是-m搜索sys.path。幸运的是,python首先会查看当前的工作目录,所以只要你正在调试的.py在你的cwd中,python -m modulepython module.py就等价。

相关问题