Python学习笔记番外：模块开发中的debug

Python学习笔记番外：模块开发中的debug

因为兴趣使然和现实需要的关系，我写了个Python模块——markdown_img。

在编写和更新的过程中，其中很大一部分时间花费在了研究如何打包和debug上了。

一开始我是在模块目录下编写测试程序，但后来发现这样并不能模拟通过pip安装后用户实际上使用的环境。

与此同时，在源码目录下放置测试程序和测试用的md文件和图片也不妥，更不方便于打包。

后来我无奈之下都是打包->pip安装->运行一条龙，循环往复，每次打包就要等一会，巨麻烦。

今天偶然想起VSCode在调试当前项目的时候是通过一个配置文件的，那是不是可以通过那个配置文件来设置整个项目的测试入口和环境？

的确如此，可以在launch.json中配置如下设置：

{
    // 使用 IntelliSense 了解相关属性。 
    // 悬停以查看现有属性的描述。
    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: 当前文件",
            "type": "python",
            "request": "launch",
            // "program": "${file}",
            "program": "${workspaceFolder}\\tests\\test.py",
            "cwd": "${workspaceFolder}\\tests",
            "console": "integratedTerminal"
        }
    ]
}

其中program就是项目调试的入口文件，默认是当前文件，我们这里直接指定为测试程序。这样不管我们正在修改项目下的哪个文件，运行调试后都是通过测试程序运行。

cwd是工作目录，调试程序在开始调试前会通过cd命令打开这个目录，默认是项目根目录，这里我们指定为测试程序所在的测试用目录。

现在我们就可以在测试目录下部署所需文件进行调试，就和用户通过pip安装模块后在某个工作目录操作一样。

现在还有个问题，如何引用未打包和安装的模块？

我这里是通过sys.path来实现引用：

import sys
sys.path.insert(-2, "d:\\workspace\\python\\markdown-img\\src")
print(sys.path)
from markdown_img.main import Main
import os
testFile = '.\\markdown_img\\一次奇妙的网课体验_image.md'
if os.path.exists(testFile):
    os.remove(testFile)
main = Main()
main.main(True)

这里有个要点，要使用sys.path.insert把我们开发中的模块包所在目录加入到Python第三方模块的检索目录之前，也就是说要在Python检索第三方模块前先来检索我们的开发目录。

比方说我这里的sys.path输出是这样的：

['D:\\workspace\\python\\markdown-img\\tests', 'D:\\software\\Coding\\Python\\python39.zip', 'D:\\software\\Coding\\Python\\DLLs', 'D:\\software\\Coding\\Python\\lib', 'D:\\software\\Coding\\Python', 'd:\\workspace\\python\\markdown-img\\src', 'C:\\Users\\70748\\AppData\\Roaming\\Python\\Python39\\site-packages', 'D:\\software\\Coding\\Python\\lib\\site-packages']

其中'C:\\Users\\70748\\AppData\\Roaming\\Python\\Python39\\site-packages', 'D:\\software\\Coding\\Python\\lib\\site-packages'都是第三方包安装目录，所以我们这里的insert插入位置下标是-2，就是为了提高优先级，覆盖掉安装目录下的同名第三方模块。

如果不这么做，每次都需要手动卸载掉第三方同名模块。