VS Code中如何用isort按PEP8规则排序自定义模块绝对导入？

问题核心 #

使用VS Code的python.sortImports（依赖isort）时，自定义Django应用customauth的导入被按字母顺序排在第三方模块（如django、rest_framework）之前，违反PEP8规范；但使用相对导入时排序正常。

当前VS Code配置 #

{
    "editor.defaultFormatter": "ms-python.python",
    "files.autoSave": "onWindowChange",
    "python.linting.flake8Enabled": true,
    "python.analysis.inlayHints.functionReturnTypes": true,
    "python.analysis.inlayHints.variableTypes": true,
    "[python]": {
        "editor.defaultFormatter": "ms-python.python",
        "editor.codeActionsOnSave": {
            "source.organizeImports": true,
            "python.sortImports": true
        }
    },
    "python.globalModuleInstallation": true,
    "python.autoComplete.extraPaths": "/usr/local/lib/python3.10/site-packages/",
    "python.analysis.extraPaths": "/usr/local/lib/python3.10/site-packages/",
    "isort.check": true,
    "isort.args": ["--profile", "django"],
    "python.analysis.autoImportCompletions": true,
    "python.analysis.packageIndexDepths": [
        {
            "name": "sklearn",
            "depth": 2
        },
        {
            "name": "matplotlib",
            "depth": 2
        },
        {
            "name": "scipy",
            "depth": 2
        },
        {
            "name": "django",
            "depth": 3
        }
    ],
    "python.analysis.indexing": true,
    "python.analysis.completeFunctionParens": true
}

注：原配置中python.analysis.packageIndexDepths缺少外层数组括号，已修正，否则会导致VS Code配置语法错误

期望与实际导入结果 #

期望排序（符合PEP8） #

from django.urls import path
from rest_framework.authtoken import views
from rest_framework.urlpatterns import format_suffix_patterns

from customauth.views import ListUsers, RegisterUser

实际错误排序 #

from customauth.views import ListUsers, RegisterUser
from django.urls import path
from rest_framework.authtoken import views
from rest_framework.urlpatterns import format_suffix_patterns

解决步骤 #

1. 明确指定自定义应用为第一方模块 #

isort的django profile会自动识别Django官方模块，但不会自动将你的自定义应用标记为第一方模块（first-party），导致isort把customauth当成第三方模块按字母排序。需要手动指定：

修改VS Code配置中的isort.args，添加--known-first-party=customauth：

"isort.args": ["--profile", "django", "--known-first-party=customauth"]

如果有多个自定义应用，用逗号分隔："--known-first-party=customauth,myapp,anotherapp"

2. （推荐）使用项目本地配置文件 #

更持久且直观的方式是在项目根目录创建pyproject.toml文件，添加isort配置：

[tool.isort]
profile = "django"
known_first_party = ["customauth"]

VS Code会自动读取这个文件的配置，优先级高于全局VS Code设置。

3. 验证isort环境一致性 #

确保VS Code使用的isort版本与项目环境一致：

• 打开VS Code终端，运行which isort（Linux/macOS）或where isort（Windows）
• 确认路径指向当前项目虚拟环境的isort，而非全局安装的版本

内容的提问来源于stack exchange，提问作者Abdullah Nafees