python3的import导入语句的书写方式

因为接触python比较晚,所以直接就开始用python3,没有太过关注python2的使用习惯。因此今天记录import语句的写法,也只关注python3的用法习惯。

 

首先说明python3import语句的规则。

有两种import语法,但我认为可以细分为三种:

1. import {<package_name>.}<package_name> | <module_name> [as <alias>]

2. from (.{.}) | ({.}{<package_name>.}<package_name>) import <module_name> [as <alias>]

3. from (.{.}) | ({.}{<package_name>.}<module_name>) import * | (<class_name> | <function_name> | <variable_name> [as <alias>])

 

第一种语法是绝对导入。其对<package_name>或<module_name>的搜索范围(按顺序)为:被运行的.py文件的同级目录,运行.py文件的指令的执行目录,sys.path的目录。对同优先级目录下,优先导入package,其次是module。

 

第二、三种语法,如果第一个字符是字母,就是绝对导入;如果from后面的第一个字符是'.',则是相对导入,每一个'.'都表示上溯一级目录,只有一个'.'时表示当前目录。“相对导入”所相对的路径就是当前import语句所在的文件。

之所以将from *** import *** 的导入语句分为两种,是因为想用巴斯克范式严谨地写出import语句的语法来。如有错误还请指正。

 

python3一直没能把绝对导入和相对导入统一起来,因此新手经常会被这几种import方法搞晕。

之所以没有统一起来,是因为以下两点局限性:

绝对导入的局限性在于,导入时对包和模块的搜索范围与该导入语句的文件所在位置无关。这里要注意,被运行的.py文件不一定就是我们所关注的这个import语句所在的文件。比如我们关注的导入语句出现在a.py中,但我们执行的是b.py,b.py中import了a,那么a中的绝对导入的搜索路径与a.py在哪里是一点关系都没有的。换句话说(如果不考虑sys.path),a.py中的绝对导入是否能成功执行,取决于b.py在哪个目录下,以及执行python3 [<parent_path>]b.py的语句所在的目录。

相对导入看上去是个不错的选择,但事实上,相对导入能否成功,还要取决于在分析相对路径的过程中,是否一直在python的package中。或者说,在相对路径的每一层目录下,都需要存在__init__.py,才能正确地进行导入。然而还有一个特例——被执行的.py文件的父目录不被视作package。这就造成了,当被执行的.py文件出现在了相对导入的某一个目录层下时,相对导入就会无法正常工作。我猜这一机制是为了防止循环导入,但初识python,自己的理解可能还太过肤浅。

为了避免相对导入的局限性,可以把相对导入用try语句包裹起来,当相对导入出错时,捕获异常,并改写为绝对导入的路径。例如

file: a.py

try:

    from . import module_b

    from .pkg_c import module_c

except Exception:

    import module_b

    from pkg_c import module_c

 

它的原理是,先试图用相对路径导入,如果出错的话,说明可能被执行文件出现在了同级目录下,破坏了包结构,那么,在目前情况下,就假定那个被执行的文件在a.py的同级目录下,因此就用绝对路径来试图导入,应该就可以成功。但是,如果被执行文件不在同级目录下而在pkg_c下面,那么绝对路径的导入也会失败。然而,大多数情况下,如果你想import a的话,不会把要执行的文件放入pkg_c下面。如果出现这种现象的话(极其特殊的情况除外),可能是包结构设计得不合理吧。在设计合理的情况下,被运行的.py文件不应当包含其“同级目录与子目录”以外的非系统的”包与模块“。

 

不过,上面所说的这种技巧,更多地应该用在package开发的过程中,经常需要调试,所以这样写。在package开发完成之后,应该遵循python的推荐用法:在包内使用相对导入,在包外使用绝对导入。

不过,在开发过程中,就安心地使用try...except的方法吧!

 

### 解决方案 在 Python 中处理同级目录下模块的导入问题可以通过多种方式进行优化。当遇到 IDE 如 IDEA 运行 Python 时无法成功导入同级目录下的模块,这通常是因为工作路径设置不当或解释器未能正确识别这些模块所在的位置。 #### 方法一:调整工作路径 确保当前的工作路径被设定为项目的根目录可以有效解决问题。对于大多数集成开发环境来说,在配置运行/调试选项时指定正确的“Working Directory”,可以使 Python 正确解析相对路径[^1]。 #### 方法二:利用 `sys.path` 动态添加模块路径 另一种常见的做法是在脚本启动前临时修改系统的模块搜索路径列表 (`sys.path`) 来含目标文件夹: ```python import sys from pathlib import Path project_root = str(Path(__file__).resolve().parent.parent) if project_root not in sys.path: sys.path.append(project_root) # 接下来就可以正常导入同级或其他子目录中的模块了 import my_module ``` 这种方法适用于那些不想改变全局行为的应用程序,并且能够灵活应对不同结构化的项目布局。 #### 方法三:采用的形式并使用相对导入语句 为了更优雅地管理依赖关系以及遵循 PEP8 的建议,推荐将整个应用程序构建成一个完整的软件体系。此时可借助于相对导入来访问兄弟模块内的资源: 假设有一个简单的结构如下所示: ``` my_package/ │ ├── __init__.py ├── main.py # 主入口文件 └── utils/ ├── __init__.py └── helper.py # 辅助工具类定义在此处 ``` 那么在 `main.py` 文件里便能像这样写入代码来进行跨文件操作: ```python from .utils.helper import some_function some_function() ``` 这里的关键在于每个子文件夹都需配备有空的 `__init__.py` 文件以表明其作为 Python 的身份;而点号则表示相对于当前命名空间执行查找动作[^2]。 #### 方法四:初始化文件声明导出成员 针对某些特殊场景——比如希望某个特定层次上的所有公共接口都能自动暴露给外部使用者,则可以在相应级别的 `__init__.py` 内显式列出要公开的对象名称: ```python # test1/__init__.py from .demo import * __all__ = [&#39;function_name&#39;, &#39;class_Name&#39;] ``` 上述例子展示了如何让位于同一层下的 `bar.py` 能够方便快捷地获取来自 `demo.py` 定义的内容而不必每次都重复书写冗长的全限定名[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值