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

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

off999 2024-09-18 22:38 14 浏览 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/??


相关推荐

python gui编程框架推荐以及介绍(python gui开发)

Python的GUI编程框架有很多,这里为您推荐几个常用且功能强大的框架:Tkinter:Tkinter是Python的标准GUI库,它是Python内置的模块,无需额外安装。它使用简单,功能较为基础...

python自动化框架学习-pyautogui(python接口自动化框架)

一、适用平台:PC(windows和mac均可用)二、下载安装:推荐使用命令行下载(因为会自动安装依赖库):pipinstallPyAutoGUI1该框架的依赖库还是蛮多的,第一次用的同学耐心等...

Python 失宠!Hugging Face 用 Rust 新写了一个 ML框架,现已低调开源

大数据文摘受权转载自AI前线整理|褚杏娟近期,HuggingFace低调开源了一个重磅ML框架:Candle。Candle一改机器学习惯用Python的做法,而是Rust编写,重...

Flask轻量级框架 web开发原来可以这么可爱呀~(建议收藏)

Flask轻量级框架web开发原来可以这么可爱呀大家好呀~今天让我们一起来学习一个超级可爱又实用的PythonWeb框架——Flask!作为一个轻量级的Web框架,Flask就像是一个小巧精致的工...

Python3使用diagrams生成架构图(python架构设计)

目录技术背景diagrams的安装基础逻辑关系图组件簇的定义总结概要参考链接技术背景对于一个架构师或者任何一个软件工程师而言,绘制架构图都是一个比较值得学习的技能。这就像我们学习的时候整理的一些Xmi...

几个高性能Python网络框架,高效实现网络应用

Python作为一种广泛使用的编程语言,其简洁易读的语法和强大的生态系统,使得它在Web开发领域占据重要位置。高性能的网络框架是构建高效网络应用的关键因素之一。本文将介绍几个高性能的Python网络框...

Web开发人员的十佳Python框架(python最好的web框架)

Python是一种面向对象、解释型计算机程序设计语言。除了语言本身的设计目的之外,Python的标准库也是值得大家称赞的,同时Python还自带服务器。其它方面,Python拥有足够多的免费数据函数库...

Diagram as Code:用python代码生成架构图

工作中常需要画系统架构图,通常的方法是通过visio、processon、draw.io之类的软件,但是今天介绍的这个软件Diagrams,可以通过写Python代码完成架构图绘制,确实很co...

分享一个2022年火遍全网的Python框架

作者:俊欣来源:关于数据分析与可视化最近Python圈子当中出来一个非常火爆的框架PyScript,该框架可以在浏览器中运行Python程序,只需要在HTML程序中添加一些Python代码即可实现。该...

10个用于Web开发的最好 Python 框架

Python是一门动态、面向对象语言。其最初就是作为一门面向对象语言设计的,并且在后期又加入了一些更高级的特性。除了语言本身的设计目的之外,Python标准库也是值得大家称赞的,Python甚至还...

使用 Python 将 Google 表格变成您自己的数据库

图片来自Shutterstock,获得FrankAndrade的许可您知道Google表格可以用作轻量级数据库吗?GoogleSheets是一个基于云的电子表格应用程序,可以像大多数数据库管...

牛掰!用Python处理Excel的14个常用操作总结!

自从学了Python后就逼迫用Python来处理Excel,所有操作用Python实现。目的是巩固Python,与增强数据处理能力。这也是我写这篇文章的初衷。废话不说了,直接进入正题。数据是网上找到的...

将python打包成exe的方式(将python文件打包成exe可运行文件)

客户端应用程序往往需要运行Python脚本,这对于那些不熟悉Python语言的用户来说可能会带来一定的困扰。幸运的是,Python拥有一些第三方模块,可以将这些脚本转换成可执行的.exe...

对比Excel学Python第1练:既有Excel,何用Python?

背景之前发的文章开头都是“Python数据分析……”,使得很多伙伴以为我是专门分享Python的,但我的本意并非如此,我的重点还是会放到“数据分析”上,毕竟,Python只是一种工具而已。现在网上可以...

高效办公:Python处理excel文件,摆脱无效办公

一、Python处理excel文件1.两个头文件importxlrdimportxlwt其中xlrd模块实现对excel文件内容读取,xlwt模块实现对excel文件的写入。2.读取exce...

取消回复欢迎 发表评论: