Git子模块导入问题：无法从ProjectA子模块导入MainClass

Let's break down the core issue first:

• When you run ProjectA on its own, Python automatically adds ProjectA's root directory to sys.path—the list of locations it scans for modules. That’s why from Libraries.library1 import ... works smoothly: Python can see the Libraries folder right in ProjectA’s root.
• When ProjectA becomes a submodule inside ProjectB, Python only adds ProjectB’s root directory to sys.path. So when mainA.py tries to import Libraries, Python looks for it in ProjectB’s root (not ProjectA’s) and can’t find it—hence the ModuleNotFoundError.

The best part? You don’t need to edit a single line of ProjectA’s code. Here are the most reliable solutions:

Solution 1: Add ProjectA’s Path to sys.path in ProjectB #

This is a quick, no-fuss fix for smaller projects. In your mainB.py, explicitly tell Python where to find ProjectA’s modules before importing:

import sys
import os

# Adjust the relative path if your ProjectA is in a different subfolder
project_a_root = os.path.join(os.path.dirname(__file__), "ProjectA")
sys.path.append(project_a_root)

# Now the import will work as expected
from ProjectA.mainA import MainClass

Solution 2: Turn ProjectA Into an Installable Package (Recommended) #

This is the cleanest, most scalable approach—perfect if you plan to reuse ProjectA across multiple projects. Here’s how to set it up:

1. In ProjectA’s root directory, create a pyproject.toml file (the modern Python standard) to mark it as a package:

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

[project]
name = "ProjectA"
version = "0.1.0"
packages = ["Libraries", "."]

2. In ProjectB, install ProjectA in "editable" mode (so any changes to ProjectA are reflected immediately without reinstalling):

pip install -e ./ProjectA

Now you can import from ProjectA normally in mainB.py with zero path hacks:

from ProjectA.mainA import MainClass

This works because installing the package adds ProjectA’s root to Python’s module search path, making both standalone runs of ProjectA and submodule usage work flawlessly.

Solution 3: Use Relative Imports (Optional, Minimal ProjectA Change) #

If you’re open to one tiny tweak in ProjectA, switch to relative imports in mainA.py:

# Replace this:
# from Libraries.library1 import ClassA, ClassB
# With this:
from .Libraries.library1 import ClassA, ClassB

To run ProjectA independently now, use Python’s module syntax instead of running the script directly:

python -m ProjectA.mainA

This tells Python to treat ProjectA as a package, so the relative import works. But since you wanted to avoid modifying ProjectA, this is just an optional extra.

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