百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

[编程基础] Python中的绝对导入与相对导入

off999 2024-09-18 22:38 20 浏览 0 评论


如果您从事的Python项目有多个文件,那么您以前可能不得不使用import语句。即使对于拥有多个项目的Python重度使用者(比如我),import也可能会造成混淆!您可能正在阅读本文,因为您想对Python中的import(尤其是绝对导入和相对导入)有更深入的了解。

在本教程中,您将学习两者之间的区别以及它们的优缺点。让我们潜入吧!

文章目录

  • 1 Imports快速介绍
  • 2 import语句的语法
  • 2.1 基本使用
  • 2.2 导入声明的样式
  • 3 绝对import和相对import
  • 3.1 绝对import
  • 3.2 相对导入
  • 4 参考

1 Imports快速介绍

Python模块是具有.py扩展名的文件,而Python包是其中具有模块的任何文件夹(或者在Python 2中是包含__init__.py文件的文件夹)。当一个模块中的代码需要访问另一模块或程序包中的代码时,你需要导入它。

但是如何一个模块,假设您像这样导入os模块:

import os

Python要做的第一件事是在 sys.modules中查找名为os系统模块. 这是以前导入的所有模块的缓存。sys模块提供了一系列关于Python运行环境的变量和函数。如果在模块缓存中找不到该名称,Python将继续搜索内置模块的列表。这些模块与Python一起预装,可以在Python标准库中找到。如果在内置模块中仍然找不到该名称,Python就会在sys.path定义的目录列表中搜索它。该列表通常包括当前目录,首先搜索该目录。

总结来说,Python寻找一个模块主要有以下三个步骤:

  • 1 通过sys.modules从已经加载的模块中寻找
  • 2 从Python标准库中寻找,Python标注库就是那些通过pip install安装来的模块
  • 3 通过sys.path包含的目录列表寻找,sys.path通常会自动导入当前目录,当然sys.path也可以添加自己指定的路径

当Python找到该模块时,它将其绑定到本地范围内的一个名称。这意味着现在已经定义了os,并且可以在当前文件中使用os,而不会抛出ModuleNotFoundError。如果没找到模块就抛出ModuleNotFoundError,如下所示:

import os

但是要注意的另外一个问题是,导入模块,会出现安全问题。请注意,Python的导入系统存在一些重大的安全风险。这主要是由于其灵活性。例如,模块缓存是可写的,并且可以使用导入系统覆盖Python的核心功能。从第三方程序包导入还会使您的应用程序面临安全威胁。

2 import语句的语法

现在您知道了导入语句的工作原理,让我们探究它们的语法。您可以导入软件包和模块。(请注意,导入软件包实际上是将软件包的__init__.py文件作为模块导入。)您还可以从软件包或模块中导入特定的对象。

通常有两种类型的导入语法。直接使用模块时,可以直接导入模块,如下所示:

2.1 基本使用

import os

os可以是包或模块。当您使用第二种语法时,您将从另一个包或模块中导入。下面是是一个实例

from os import path

path可以是模块,子包或对象,例如类或函数。您还可以选择重命名导入的资源,如下所示:

import os as so

这将把导入的os重命名为so。现在必须将其引用为so,否则将无法识别它。

2.2 导入声明的样式

PEP 8 是Python的官方样式指南,在编写导入语句时有一些提示。PEP 8详细见?https://pep8.org/#imports???。
总结如下:

  1. 导入应始终写在文件顶部,在任何模块注释和文档字符串之后。
  2. import应该根据用途分为以下三类:
  • 标准库导入(Python的内置模块)
  • 相关的第三方导入(已安装但不属于当前应用程序的模块)
  • 本地应用程序导入(属于当前应用程序的模块)
  1. 每个import都要用空格分隔

在每个导入组中按字母顺序排列导入也是一个好主意。这使得查找特定导入变得更加容易,特别是当一个文件中有许多导入时。以下是如何设置导入语句样式的示例。以下的import语句分为三个不同的组,用空格隔开。在每个组中,它们也按字母顺序排列。

'''
    格式化的import如下所示
'''
# 标准库
import datetime
import os

# 第三方库
from flask import Flask

# 本地库
# import local_module

3 绝对import和相对import

3.1 绝对import

您已经掌握了如何编写import语句以及如何像专业人士那样设计它们的样式。现在是时候学习一点关于绝对导入的知识了。绝对导入指定要导入的资源使用其从项目根文件夹中的完整路径。

假设您具有以下目录结构:

└── project
    ├── package1
    │   ├── module1.py
    │   └── module2.py
    └── package2
        ├── __init__.py
        ├── module3.py
        ├── module4.py
        └── subpackage1
            └── module5.py

当前目录project其中包含两个子目录package1和package2。该package1目录有两个文件,module1.py和module2.py。

该package2目录包含三个文件:两个模块module3.py和module4.py,以及一个初始化文件__init__.py。它还包含一个目录,subpackage该目录又包含一个文件module5.py。

让我们假设以下内容:

  • package1/module2.py包含一个函数function1。
  • package2/__init__.py包含一个类class1。
  • package2/subpackage1/module5.py包含一个函数function2。

以下是绝对导入的实际示例:

from package1 import module1
from package1.module2 import function1
from package2 import class1
from package2.subpackage1.module5 import function2

module2中的内容如下:

def function1():
    passs

package2中__init__.py中的内容如下:

class class1():
    def __init__():
        return

package2.subpackage1.module5中的内容如下:

def function2():
    pass

请注意,必须为每个包或文件提供来自顶级包文件夹的详细路径。这有点类似于它的文件路径,但是我们使用点(.)而不是斜杠(/)。

对导入是首选,因为它们非常清楚和直接。仅通过查看语句,就可以很容易地准确知道导入的资源在哪里。此外,即使import语句的当前位置发生更改,绝对导入仍然有效。实际上,PEP 8明确建议绝对导入。

但是,有时绝对导入可能会变得非常冗长,具体取决于目录结构的复杂性。想象一下这样的声明:

from package1.subpackage2.subpackage3.subpackage4.module5 import function6

太荒谬了吧?幸运的是,在这种情况下,相对导入是一个不错的选择!

3.2 相对导入

相对导入指定相对于当前位置(即import语句所在的位置)要导入的资源。有两种类型的相对导入:隐式和显式。隐式相对导入在Python3中已被弃用,因此我将不在这里介绍它们。

相对导入的语法取决于当前位置以及要导入的模块,包或对象的位置。以下是相对导入的一些示例:

from .some_module import some_class
from ..some_package import some_function
from . import some_class

您可以看到在上面的每个import语句中至少有一个点。相对导入使用点表示法来指定位置。

单点表示所引用的模块或软件包与当前位置位于同一目录中。两个点表示它位于当前位置的父目录中,即上面的目录中。三个点表示它位于祖父母目录中,依此类推。如果您使用类似Unix的操作系统,这可能对您来说很熟悉!

假设您具有与以前相同的目录结构:

└── project
    ├── package1
    │   ├── module1.py
    │   └── module2.py
    └── package2
        ├── __init__.py
        ├── module3.py
        ├── module4.py
        └── subpackage1
            └── module5.py

您可以function1通过package1/module1.py以下方式导入文件:

# package1/module1.py

from .module2 import function1

你可以将class1和function2导入到package2/module3.py文件中:

# package2/module3.py

from . import class1
from .subpackage1.module5 import function2

在第一个import语句中,单点表示您正在class1从当前包中导入。请记住,导入软件包实际上会将软件包的__init__.py文件导入为模块。

在第二个import语句中,您将再次使用一个点,因为subpackage1它与当前模块位于同一目录中module3.py。

当然这种方法有个极大问题,可能会报错,如下所示:

ModuleNotFoundError: No module named '__main__.module2'; '__main__' is not a package

这是相对导入只有在父模块已经在当前运行环境中被导入过才有用,所以尽可能用绝对导入。解决办法见:

相对导入的利与弊
相对导入的一个明显优势是它们非常简洁。根据当前位置,他们可以将您之前看到的可笑的冗长的import语句变成如下所示的简单内容:

from …subpackage4.module5 import function6

不幸的是,相对导入可能会很混乱,尤其是对于目录结构可能会更改的共享项目。相对导入也不如绝对导入更易读,而且很难说出导入资源的位置。

总的来说,通常应该选择绝对导入而不是相对导入,除非路径复杂并且会使语句过长。

4 参考

??https://realpython.com/absolute-vs-relative-python-imports/??


相关推荐

面试官:来,讲一下枚举类型在开发时中实际应用场景!

一.基本介绍枚举是JDK1.5新增的数据类型,使用枚举我们可以很好的描述一些特定的业务场景,比如一年中的春、夏、秋、冬,还有每周的周一到周天,还有各种颜色,以及可以用它来描述一些状态信息,比如错...

一日一技:11个基本Python技巧和窍门

1.两个数字的交换.x,y=10,20print(x,y)x,y=y,xprint(x,y)输出:102020102.Python字符串取反a="Ge...

Python Enum 技巧,让代码更简洁、更安全、更易维护

如果你是一名Python开发人员,你很可能使用过enum.Enum来创建可读性和可维护性代码。今天发现一个强大的技巧,可以让Enum的境界更进一层,这个技巧不仅能提高可读性,还能以最小的代价增...

Python元组编程指导教程(python元组的概念)

1.元组基础概念1.1什么是元组元组(Tuple)是Python中一种不可变的序列类型,用于存储多个有序的元素。元组与列表(list)类似,但元组一旦创建就不能修改(不可变),这使得元组在某些场景...

你可能不知道的实用 Python 功能(python有哪些用)

1.超越文件处理的内容管理器大多数开发人员都熟悉使用with语句进行文件操作:withopen('file.txt','r')asfile:co...

Python 2至3.13新特性总结(python 3.10新特性)

以下是Python2到Python3.13的主要新特性总结,按版本分类整理:Python2到Python3的重大变化Python3是一个不向后兼容的版本,主要改进包括:pri...

Python中for循环访问索引值的方法

技术背景在Python编程中,我们经常需要在循环中访问元素的索引值。例如,在处理列表、元组等可迭代对象时,除了要获取元素本身,还需要知道元素的位置。Python提供了多种方式来实现这一需求,下面将详细...

Python enumerate核心应用解析:索引遍历的高效实践方案

喜欢的条友记得关注、点赞、转发、收藏,你们的支持就是我最大的动力源泉。根据GitHub代码分析统计,使用enumerate替代range(len())写法可减少38%的索引错误概率。本文通过12个生产...

Python入门到脱坑经典案例—列表去重

列表去重是Python编程中常见的操作,下面我将介绍多种实现列表去重的方法,从基础到进阶,帮助初学者全面掌握这一技能。方法一:使用集合(set)去重(最简单)pythondefremove_dupl...

Python枚举类工程实践:常量管理的标准化解决方案

本文通过7个生产案例,系统解析枚举类在工程实践中的应用,覆盖状态管理、配置选项、错误代码等场景,适用于Web服务开发、自动化测试及系统集成领域。一、基础概念与语法演进1.1传统常量与枚举类对比#传...

让Python枚举更强大!教你玩转Enum扩展

为什么你需要关注Enum?在日常开发中,你是否经常遇到这样的代码?ifstatus==1:print("开始处理")elifstatus==2:pri...

Python枚举(Enum)技巧,你值得了解

枚举(Enum)提供了更清晰、结构化的方式来定义常量。通过为枚举添加行为、自动分配值和存储额外数据,可以提升代码的可读性、可维护性,并与数据库结合使用时,使用字符串代替数字能简化调试和查询。Pytho...

78行Python代码帮你复现微信撤回消息!

来源:悟空智能科技本文约700字,建议阅读5分钟。本文基于python的微信开源库itchat,教你如何收集私聊撤回的信息。[导读]Python曾经对我说:"时日不多,赶紧用Python"。于是看...

登录人人都是产品经理即可获得以下权益

文章介绍如何利用Cursor自动开发Playwright网页自动化脚本,实现从选题、写文、生图的全流程自动化,并将其打包成API供工作流调用,提高工作效率。虽然我前面文章介绍了很多AI工作流,但它们...

Python常用小知识-第二弹(python常用方法总结)

一、Python中使用JsonPath提取字典中的值JsonPath是解析Json字符串用的,如果有一个多层嵌套的复杂字典,想要根据key和下标来批量提取value,这是比较困难的,使用jsonpat...

取消回复欢迎 发表评论: