如何正确从其他Python文件加载类并解决目录移植后的路径导入问题

核心改造步骤 #

• 第一步：补全Python包标识
  在step_sequencer、step_sequencer/commands两个目录下分别新建空的__init__.py文件，让Python将这两个目录识别为正规的包结构，不受上层路径变动影响。
• 第二步：修改包内导入为相对导入
  所有位于commands目录下的子类文件（如ClickMouse.py），将原来的导入语句：

  from Command import Command, auto
  

  修改为包内相对导入：

  from .Command import Command, auto
  

  相对导入会基于当前文件所在包的位置解析依赖，不会受执行入口的路径影响。
• 第三步：修正command_parser.py的动态加载逻辑
  原动态加载逻辑未将加载的模块注册到Python的模块缓存，也未设置正确的包属性，会导致子模块的相对导入失效。修改加载部分代码如下：

  for cmd_file in command_filenames:
      command_name = os.path.splitext(cmd_file)[0]
      # 构造模块全限定名，继承当前模块的包前缀
      module_fullname = f"{__package__}.{command_name}"
      # 避免重复加载
      if module_fullname in sys.modules:
          module = sys.modules[module_fullname]
      else:
          spec = importlib.util.spec_from_file_location(
              module_fullname, 
              os.path.join(path, cmd_file)
          )
          module = importlib.util.module_from_spec(spec)
          # 注册模块到全局缓存，保证相对导入可正常解析
          sys.modules[module_fullname] = module
          spec.loader.exec_module(module)
      # 原有类遍历逻辑保持不变
  

• 第四步：修正入口导入语句
  main.py中的导入路径要和实际目录结构匹配，修正为：

  from step_sequencer.commands.command_parser import load_classes, parse
  print(load_classes())
  

进阶：实现step_sequencer任意位置可调用 #

如果需要将step_sequencer目录移动到任意位置都能被正常导入，可将其封装为可安装的Python包：

1. 在step_sequencer的同级目录新建pyproject.toml配置文件，内容如下：

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "step-sequencer"
version = "0.1.0"
packages = ["step_sequencer", "step_sequencer.commands"]

2. 在配置文件所在目录执行安装命令：

pip install .

安装完成后，在任意Python代码中都可以直接导入step_sequencer下的模块，无需关心目录位置。

内容的提问来源于stack exchange，提问作者Jordan Larson