VSCode问题记录

Sunmy Lv5
  2023-06-30 16:56:57 2023-06-30 16:56:57 创建   2025-06-29 21:05:24 2025-06-29 21:05:24 更新      1.9k 字  9 分钟  

Vscode中Python代码引入其他模块下自定义包

  • 在 VS Code 中导入其他文件夹下的模块，需要使用 Python 的模块搜索路径，可以通过以下步骤实现：

假设我们的项目结构如下：

1
2
3
4
5
my_project/
├── main.py
└── utils/
    ├── __init__.py
    └── my_module.py

  1. 在自定义的文件夹中创建一个 init.py 文件，使该文件夹变成一个包。

  2. 在需要导入模块的 Python 文件中，使用 sys.path.append() 方法将自定义文件夹所在的路径添加到模块搜索路径中。使用 import 语句导入自定义文件夹下的模块即可。

    例如，现在我们需要在 main.py 中导入 my_module.py

    main.py

1
2
3
import sys
sys.path.append('utils')  # 将 utils 文件夹添加到模块搜索路径中
import my_module  # 导入自定义模块
  • 如果导入其他项目文件夹中的模块，但是需要将其他项目文件夹所在的路径添加到 Python 的模块搜索路径中。

假设我们有两个项目：project1 和 project2，它们的文件结构如下：

1
2
3
4
5
6
7
8
9
10
11
project1/
├── main.py
└── utils/
    ├── __init__.py
    └── my_module.py

project2/
├── main.py
└── helpers/
    ├── __init__.py
    └── helper_module.py

现在，我们需要在 project1/main.py 中导入 project2/helpers/helper_module.py 中的模块，可以按照以下步骤操作：

  1. 在 project1/main.py 文件中添加以下代码，将 project2 文件夹所在的路径添加到 Python 的模块搜索路径中：
1
2
3
4
import sys
sys.path.append('../project2')  # 将 project2 文件夹添加到模块搜索路径中
然后可以使用 import 语句导入 project2/helpers/helper_module.py 中的模块了：
from helpers.helper_module import some_function
  1. 这样就可以在 project1/main.py 中使用 some_function 函数了。

需要注意的是，如果多个项目之间存在相互依赖的情况，最好使用包管理工具（如 pipenv 或者 poetry）来管理项目依赖，而不是手动添加模块搜索路径。

VsCode引入全局自定义函数

以自定义的Python logging为例，在 site-packages 创建一个名为 site-packages.pth 的文件。在 site-packages.pth 文件中，添加一行，指向您希望在模块搜索路径中添加的目录。例如，如果您的文件根目录是 /root/code/vscode-server/Personal

Python logging 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
import sys
import logging
import os

from logging.handlers import RotatingFileHandler

sys.path.append("./")


# 绑定句柄到logger对象
logger = logging.getLogger(__name__)

# 获取当前工具文件所在的路径
root_path = os.path.dirname(os.path.abspath(__file__))

# 拼接当前要输出的日志的路径
log_dir_path = os.sep.join([root_path, f"/logs"])
if not os.path.isdir(log_dir_path):
    os.mkdir(log_dir_path)

# 创建日志记录器，指明日志保存路径，每个日志的大小，保存的上限
file_log_handler = RotatingFileHandler(
    os.sep.join([log_dir_path, "log.log"]),
    maxBytes=1024 * 1024,
    backupCount=10,
    encoding="utf-8",
)

# 设置日志的格式
data_string = "%Y-%m-%d %H:%M:%S"
formatter = logging.Formatter(
    "[%(asctime)s] [%(levelname)s] [%(filename)s]-[Line: %(lineno)d]-[Func: %(funcName)s] [%(message)s]",
    data_string,
)

# 日志输出到控制台的句柄
stream_handler = logging.StreamHandler()

# 将日志记录器指定日志的格式
file_log_handler.setFormatter(formatter)
stream_handler.setFormatter(formatter)

# 为全局的日志工具对象添加日志记录器
# 绑定句柄到logger对象
logger.addHandler(stream_handler)
logger.addHandler(file_log_handler)

# 设置日志输出级别
logger.setLevel(level=logging.INFO)

目录结构

1
2
3
./Personal/utils/
|-- __init__.py
|-- log_util.py

加入系统变量

查找site-packages

1
2
3
import site
print(site.getsitepackages())
# ['/usr/local/lib/python3.10/dist-packages', '/usr/lib/python3/dist-packages', '/usr/lib/python3.10/dist-packages']

重新启动 Python 解释器

1
2
3
4
5
import os
import sys

python_executable = sys.executable
os.execl(python_executable, python_executable, *sys.argv)

使用

1
2
3
4
5
6
7
from utils.log_util import logger

logger.info("!! This is an info message.testing")
logger.error("@ This is an error message.")

# [2023-08-20 22:05:16] [INFO] [test_log_util.py]-[Line: 20]-[Func: <module>] [!! This is an info message.testing]
# [2023-08-20 22:05:16] [ERROR] [test_log_util.py]-[Line: 21]-[Func: <module>] [@ This is an error message.]

如何禁止不必要的输出

您可以按照以下步骤在 VSCode 中的设置中进行配置：

  1. 打开 VSCode，点击左侧的菜单栏中的“文件(File)”菜单，选择“首选项(Preferences)”下的“设置(Settings)”选项。
  2. 在搜索框中输入“code-runner”，找到“Code-runner: Run In Terminal”这一项，将其设置为“true”。（不勾选）
  3. 在设置中搜索“Code-runner: Clear Previous Output”，表示运行代码前清空之前的输出。（勾选）
  4. 保存设置后，再次使用 Code-runner 运行代码，就应该只保留正常输出了。

如何引入自定义的头文件

在c语言编译的时候加入 -I 头文件所在目录 即可，以下是code-runner的配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
    "liveServer.settings.donotShowInfoMsg": true,
    "editor.guides.bracketPairs": true,
    "settingsSync.ignoredSettings": [],
    "C_Cpp.autocompleteAddParentheses": true,
    "explorer.confirmDragAndDrop": false,
    "workbench.editorAssociations": {
        "*.drawio": "default"
    },
    "hediet.vscode-drawio.codeLinkActivated": true,
    "C_Cpp.files.exclude": {
        "**/.vscode": true,
        "**/.vs": true
    },
    "workbench.tree.indent": 16,
    "debug.onTaskErrors": "showErrors",
    "code-runner.executorMap": {
        "javascript": "node",
        "java": "cd $dir && javac $fileName && java $fileNameWithoutExt",
        "c": "cd $dir && gcc $fileName -o $fileNameWithoutExt.out -I /root/code/vscode-server/7714/SMY/include -I /root/code/vscode-server/posixtestsuite/include && $dir$fileNameWithoutExt.out",
        "zig": "zig run",
        "cpp": "cd $dir && g++ $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt",
        "objective-c": "cd $dir && gcc -framework Cocoa $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt",
        "php": "php",
        "python": "set PYTHONIOENCODING=utf-8 && set PYTHONPATH=. && python -u",
        "perl": "perl",
        "perl6": "perl6",
        "ruby": "ruby",
        "go": "go run",
        "lua": "lua",
        "groovy": "groovy",
        "powershell": "powershell -ExecutionPolicy ByPass -File",
        "bat": "cmd /c",
        "shellscript": "bash",
        "fsharp": "fsi",
        "csharp": "scriptcs",
        "vbscript": "cscript //Nologo",
        "typescript": "ts-node",
        "coffeescript": "coffee",
        "scala": "scala",
        "swift": "swift",
        "julia": "julia",
        "crystal": "crystal",
        "ocaml": "ocaml",
        "r": "Rscript",
        "applescript": "osascript",
        "clojure": "lein exec",
        "haxe": "haxe --cwd $dirWithoutTrailingSlash --run $fileNameWithoutExt",
        "rust": "cd $dir && rustc $fileName && $dir$fileNameWithoutExt",
        "racket": "racket",
        "scheme": "csi -script",
        "ahk": "autohotkey",
        "autoit": "autoit3",
        "dart": "dart",
        "pascal": "cd $dir && fpc $fileName && $dir$fileNameWithoutExt",
        "d": "cd $dir && dmd $fileName && $dir$fileNameWithoutExt",
        "haskell": "runghc",
        "nim": "nim compile --verbosity:0 --hints:off --run",
        "lisp": "sbcl --script",
        "kit": "kitc --run",
        "v": "v run",
        "sass": "sass --style expanded",
        "scss": "scss --style expanded",
        "less": "cd $dir && lessc $fileName $fileNameWithoutExt.css",
        "FortranFreeForm": "cd $dir && gfortran $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt",
        "fortran-modern": "cd $dir && gfortran $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt",
        "fortran_fixed-form": "cd $dir && gfortran $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt",
        "fortran": "cd $dir && gfortran $fileName -o $fileNameWithoutExt && $dir$fileNameWithoutExt",
        "sml": "cd $dir && sml $fileName",
    },
    "[python]": {
        "editor.formatOnType": true,
        "editor.defaultFormatter": "ms-python.python"
    },
    "terminal.integrated.env.osx": {
        "PYTHONPATH": "${workspaceFolder}/",
    },
    "terminal.integrated.env.linux": {
        "PYTHONPATH": "${workspaceFolder}/",
    },
    "terminal.integrated.env.windows": {
        "PYTHONPATH": "${workspaceFolder}/",
    },
    "env": {
        "PYTHONPATH": "${workspaceRoot}"
    },
    "code-runner.fileDirectoryAsCwd": true,
    "workbench.startupEditor": "none",
    "window.menuBarVisibility": "classic",
    "leetcode.outputFolder": "$difficulty",
    "leetcode.filePath": {
        "default": {
            "folder": "",
            "filename": "${id}.${kebab-case-name}.${ext}"
        }
    },
    "leetcode.endpoint": "leetcode-cn",
    "markdown.preview.breaks": true,
    "leetcode.workspaceFolder": "/root/.leetcode",
    "leetcode.showDescription": "Both",
    "leetcode.hint.configWebviewMarkdown": false,
    "python.autoComplete.extraPaths": [],
    "python.analysis.extraPaths": [],
    "workbench.editor.enablePreview": false,
    "explorer.autoReveal": "focusNoScroll",
    "workbench.colorTheme": "Learn with Sumit Official Theme",
    "code-runner.saveAllFilesBeforeRun": true,
    "code-runner.showStopIconInEditorTitleMenu": false,
    "code-runner.saveFileBeforeRun": true,
    "code-runner.showExecutionMessage": false,
    "code-runner.clearPreviousOutput": true,
}
  • 标题: VSCode问题记录
  • 作者: Sunmy
  • 创建于 : 2023-06-30 16:56:57
  • 更新于 : 2025-06-29 21:05:24
  • 链接: https://ldspdvsun.github.io/cmchvp8g50034h0gb6ifw0djq/
  • 版权声明: 版权所有 © Sunmy，禁止转载。
推荐阅读
ChaosBlade ChaosBlade PyTestAllure PyTestAllure CodeServer CodeServer
推荐阅读
ChaosBlade ChaosBlade PyTestAllure PyTestAllure
评论
目录
VSCode问题记录
  1. Vscode中Python代码引入其他模块下自定义包
  2. VsCode引入全局自定义函数
    1. Python logging 文件
    2. 目录结构
    3. 加入系统变量
    4. 重新启动 Python 解释器
    5. 使用
  3. 如何禁止不必要的输出
  4. 如何引入自定义的头文件