我想从一个位于当前目录上面的目录中的文件中继承一个类。
能否使用相对导入来导入该文件?
我想从一个位于当前目录上面的目录中的文件中继承一个类。
能否使用相对导入来导入该文件?
from ..subpkg2 import mod
根据Python文档:当在一个包层级结构中时,使用两个点,如import语句文档所述:
在指定要导入的模块时,您不必指定模块的绝对名称。当一个模块或包包含在另一个包中时,可以在同一顶级包内进行相对导入,而无需提及包名称。通过在
from
之后的指定模块或包中使用前导点,可以指定要向上遍历当前包层次结构的层数,而无需指定确切的名称。一个前导点表示存在该导入的模块的当前包。 两个点表示向上一级包。 三个点表示向上两个级别,以此类推。因此,如果您从pkg
包中的模块执行from. import mod
,则最终将导入pkg.mod
。如果您从pkg.subpkg1
内部执行from..subpkg2 import mod
,则将导入pkg.subpkg2.mod
。相对导入的规范包含在PEP 328中。
PEP 328处理绝对/相对导入。
import sys
sys.path.append("..") # Adds higher directory to python modules path.
..
访问任何其他目录,那么您所做的是创建一个包,因此您应该构建该包,并使用虚拟环境在本地系统上进行安装管理。更多信息请参见此答案:https://stackoverflow.com/questions/77507389/python-project-directory-structure-modulenotfounderror - undefined@gimel 的回答是正确的,如果你可以保证他提到的包层次结构。如果你不能保证这一点——如果你的真正需求与目录紧密相关而没有任何必要与打包有关——那么你需要使用 __file__
来找到父目录(几个 os.path.dirname
调用就行了;-),然后(如果该目录尚未在 sys.path
中)临时将该目录插入到 sys.path
的最前面,__import__
,再将该目录删除——确实是一项混乱的工作,但“当你必须时,你必须”(而 Python 力求永远不阻止程序员做出必须做的事情——就像 ISO C 标准在其前言的“C 精神”部分所说的那样!)。
以下是一个可能适合您的示例:
import sys
import os.path
sys.path.append(
os.path.abspath(os.path.join(os.path.dirname(__file__), os.path.pardir)))
import module_in_parent_dir
sys.path.remove(pathYouJustAdded)
的操作,以便不保留这个新路径。 - Matthias从当前目录的上一级目录导入模块:
from .. import module
from .. import module
时,按照建议操作后出现了 ValueError: Attempted relative import in non-package 错误。 - user3428154前言:我对之前的回答进行了大量改写,希望能够帮助大家更好地了解Python生态系统,并且帮助大家成功使用Python的import系统。
这篇文章将涵盖包内相对导入,我认为这是最可能出现在OP问题中的情况。
这就是为什么我们写import foo
来从根命名空间加载一个名为"foo"的模块,而不是写:
foo = dict(); # please avoid doing this
with open(os.path.join(os.path.dirname(__file__), '../foo.py') as foo_fh: # please avoid doing this
exec(compile(foo_fh.read(), 'foo.py', 'exec'), foo) # please avoid doing this
这就是为什么我们可以将Python嵌入到没有提供虚拟文件系统的环境中,例如Jython。
不受文件系统的耦合让导入变得灵活,这种设计允许从存档/zip文件中导入,导入单例,字节码缓存,cffi扩展,甚至远程代码定义加载等。
那么,如果导入与文件系统没有耦合,"上一级目录"是什么意思呢?我们必须选择一些启发式方法,但我们可以做到这一点,例如在package中工作时,已经定义了一些启发式方法,使得相对导入,如.foo
和..foo
可以在同一个包中工作。太酷了!
如果您真的想将源代码加载模式与文件系统耦合,可以这样做。您将不得不选择自己的启发式方法,并使用某种导入机制,我推荐使用importlib。
Python的importlib示例大致如下:
import importlib.util
import sys
# For illustrative purposes.
file_path = os.path.join(os.path.dirname(__file__), '../foo.py')
module_name = 'foo'
foo_spec = importlib.util.spec_from_file_location(module_name, file_path)
# foo_spec is a ModuleSpec specifying a SourceFileLoader
foo_module = importlib.util.module_from_spec(foo_spec)
sys.modules[module_name] = foo_module
foo_spec.loader.exec_module(foo_module)
foo = sys.modules[module_name]
# foo is the sys.modules['foo'] singleton
这里有一个很棒的官方示例项目:https://github.com/pypa/sampleproject
Python 包是关于您源代码的信息集合,可以告知其他工具如何将您的源代码复制到其他计算机,并如何将您的源代码集成到该系统的路径中,以便import foo
适用于其他计算机(无论解释器、主机操作系统等)。
我们假设有一个名为 foo
的包,在某个目录中(最好是空目录)。
some_directory/
foo.py # `if __name__ == "__main__":` lives here
setup.py
创建为foo.py
的同级文件,因为这样可以使编写setup.py文件更简单。但是,如果您愿意,可以编写配置来更改/重定向setuptools默认执行的所有操作。例如,将foo.py
放在“src /”目录下是比较流行的做法,本文不涉及此内容。some_directory/
foo.py
setup.py
.
#!/usr/bin/env python3
# setup.py
import setuptools
setuptools.setup(
name="foo",
...
py_modules=['foo'],
)
.
python3 -m pip install --editable ./ # or path/to/some_directory/
-e
,将再次重定向导入机制以加载此目录中的源文件,而不是将当前精确文件复制到安装环境的库中。这也可能导致开发人员计算机上的行为差异,请务必测试您的代码!除了pip之外还有其他工具,但我建议pip是最好的入门工具 :) 我还喜欢将foo
制作成“包”(包含__init__.py
的目录)而不是模块(单个“.py”文件),“包”和“模块”都可以加载到根名称空间中,模块允许嵌套命名空间,如果我们想要进行“相对于上一级目录”的导入,则这很有帮助。some_directory/
foo/
__init__.py
setup.py
.
#!/usr/bin/env python3
# setup.py
import setuptools
setuptools.setup(
name="foo",
...
packages=['foo'],
)
我也喜欢制作一个foo/__main__.py
,这使得Python可以将包作为模块执行,例如python3 -m foo
将会将foo/__main__.py
作为__main__
执行。
some_directory/
foo/
__init__.py
__main__.py # `if __name__ == "__main__":` lives here, `def main():` too!
setup.py
.
#!/usr/bin/env python3
# setup.py
import setuptools
setuptools.setup(
name="foo",
...
packages=['foo'],
...
entry_points={
'console_scripts': [
# "foo" will be added to the installing-environment's text mode shell, eg `bash -c foo`
'foo=foo.__main__:main',
]
},
)
让我们用更多的模块来丰富一下: 基本上,你可以有这样的目录结构:
some_directory/
bar.py # `import bar`
foo/
__init__.py # `import foo`
__main__.py
baz.py # `import foo.baz
spam/
__init__.py # `import foo.spam`
eggs.py # `import foo.spam.eggs`
setup.py
setup.py
一般包含源代码的元数据信息,例如:
foo
,不过使用下划线代替连字符也很流行python ./setup.py test
它非常广泛,甚至可以在开发机器上安装源模块时即时编译 C 扩展。对于日常示例,我推荐 PYPA 示例存储库的 setup.py。
如果您正在释放构建工件,例如一个副本代码,该副本被设计为在几乎相同的计算机上运行,那么 requirements.txt 文件是一种流行的方式来快照精确的依赖信息,其中 "install_requires" 是捕获最小和最大兼容版本的好方法。但是,考虑到目标计算机已经几乎相同,我强烈推荐创建整个 Python 前缀的 tarball。这可能有些棘手,这里不详细介绍。请查看 pip install
的 --target
选项,或者了解 virtualenv 或 venv。
回到示例
假设我们在 foo/spam/eggs.py 中,如果我们想要从 foo/baz 导入代码,我们可以通过其绝对命名空间来请求:
import foo.baz
from . import baz
。import ..baz
import foo.baz
或import ..baz
,我需要在正确制作的setup.py文件上运行python3 -m pip install --editable FILEPATH
吗?令人惊讶的是,Python需要这么多的开销来从上面进行导入... - JDGsetup.py
文件。filepath_to/project_name/
setup.py
setup.py
中编写:import setuptools
setuptools.setup(name='project_name')
在控制台中运行以下代码:
python -m pip install --editable filepath_to/project_name
根据你的python安装方式,你可能需要使用python3
或其他替代python
。此外,你可以使用-e
代替--editable
。
现在,你的目录看起来会像这样。我不知道那个egg是什么。
filepath_to/project_name/
setup.py
test_3.egg-info/
dependency_links.txt
PKG-INFO
SOURCES.txt
top_level.txt
filepath_to/project_name/
top_level_file.py
subdirectory/
subfile.py
setup.py |
test_3.egg-info/ |----- Ignore these guys
... |
top_level_file.py
看起来像这样:x = 1
subfile.py
导入它,或者在计算机上的任何其他文件中导入。# subfile.py OR some_other_python_file_somewhere_else.py
import random # This is a standard package that can be imported anywhere.
import top_level_file # Now, top_level_file.py works similarly.
print(top_level_file.x)
env\Scripts\python ...
或 env/bin/python
命令来使用你的项目所使用的虚拟环境)。 - road_to_quantdom使用 pathlib 的优化答案,引自@alex-martelli:
import pathlib
import sys
_parentdir = pathlib.Path(__file__).parent.parent.resolve()
sys.path.insert(0, str(_parentdir))
import module_in_parent_dir
sys.path.remove(str(_parentdir))
python /myprogram/submodule/mymodule.py
,该模块导入了/myprogram/mainmodule.py
,例如:通过以下方式from mainmodule import *
PYTHONPATH
中:export PYTHONPATH=/myprogram
现在是2022年,之前的回答都没有对我起作用。最终这个方法解决了我的问题。
import sys
sys.path.append('../my_class')
import my_class
我的目录结构:
src
--my_class.py
notebooks
-- mynotebook.ipynb
我从mynotebook.ipynb导入了my_class。
您可以使用sys.path.append()
方法将包所在的目录添加到搜索模块路径列表中。例如,如果该包位于当前目录的两个目录
之上,则可以使用以下代码:
import sys
sys.path.append("../../")
import sys
sys.path.append("..")