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

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

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


相关推荐

Linux 网络协议栈_linux网络协议栈

前言;更多学习资料(包含视频、技术学习路线图谱、文档等)后台私信《资料》免费领取技术点包含了C/C++,Linux,Nginx,ZeroMQ,MySQL,Redis,fastdfs,MongoDB,Z...

揭秘 BPF map 前生今世_bpfdm

1.前言众所周知,map可用于内核BPF程序和用户应用程序之间实现双向的数据交换,为BPF技术中的重要基础数据结构。在BPF程序中可以通过声明structbpf_map_def...

教你简单 提取fmpeg 视频,音频,字幕 方法

ffmpeg提取视频,音频,字幕方法(HowtoExtractVideo,Audio,SubtitlefromOriginalVideo?)1.提取视频(ExtractVi...

Linux内核原理到代码详解《内核视频教程》

Linux内核原理-进程入门进程进程不仅仅是一段可执行程序的代码,通常进程还包括其他资源,比如打开的文件,挂起的信号,内核内部的数据结构,处理器状态,内存地址空间,或多个执行线程,存放全局变量的数据段...

Linux C Socket UDP编程详解及实例分享

1、UDP网络编程主要流程UDP协议的程序设计框架,客户端和服务器之间的差别在于服务器必须使用bind()函数来绑定侦听的本地UDP端口,而客户端则可以不进行绑定,直接发送到服务器地址的某个端口地址。...

libevent源码分析之bufferevent使用详解

libevent的bufferevent在event的基础上自己维护了一个buffer,这样的话,就不需要再自己管理一个buffer了。先看看structbufferevent这个结构体struct...

一次解决Linux内核内存泄漏实战全过程

什么是内存泄漏:程序向系统申请内存,使用完不需要之后,不释放内存还给系统回收,造成申请的内存被浪费.发现系统中内存使用量随着时间的流逝,消耗的越来越多,例如下图所示:接下来的排查思路是:1.监控系统中...

彻底搞清楚内存泄漏的原因,如何避免内存泄漏,如何定位内存泄漏

作为C/C++开发人员,内存泄漏是最容易遇到的问题之一,这是由C/C++语言的特性引起的。C/C++语言与其他语言不同,需要开发者去申请和释放内存,即需要开发者去管理内存,如果内存使用不当,就容易造成...

linux网络编程常见API详解_linux网络编程视频教程

Linux网络编程API函数初步剖析今天我们来分析一下前几篇博文中提到的网络编程中几个核心的API,探究一下当我们调用每个API时,内核中具体做了哪些准备和初始化工作。1、socket(family...

Linux下C++访问web—使用libcurl库调用http接口发送解析json数据

一、背景这两天由于一些原因研究了研究如何在客户端C++代码中调用web服务端接口,需要访问url,并传入json数据,拿到返回值,并解析。 现在的情形是远程服务端的接口参数和返回类型都是json的字符...

平衡感知调节:“系统如人” 视角下的架构设计与业务稳定之道

在今天这个到处都是数字化的时代,系统可不是一堆冷冰冰的代码。它就像一个活生生的“数字人”,没了它,业务根本转不起来。总说“技术要为业务服务”,但实际操作起来问题不少:系统怎么才能快速响应业务需求?...

谈谈分布式文件系统下的本地缓存_什么是分布式文件存储

在分布式文件系统中,为了提高系统的性能,常常会引入不同类型的缓存存储系统(算法优化所带来的的效果可能远远不如缓存带来的优化效果)。在软件中缓存存储系统一般可分为了两类:一、分布式缓存,例如:Memca...

进程间通信之信号量semaphore--linux内核剖析

什么是信号量信号量的使用主要是用来保护共享资源,使得资源在一个时刻只有一个进程(线程)所拥有。信号量的值为正的时候,说明它空闲。所测试的线程可以锁定而使用它。若为0,说明它被占用,测试的线程要进入睡眠...

Qt编写推流程序/支持webrtc265/从此不用再转码/打开新世界的大门

一、前言在推流领域,尤其是监控行业,现在主流设备基本上都是265格式的视频流,想要在网页上直接显示监控流,之前的方案是,要么转成hls,要么魔改支持265格式的flv,要么265转成264,如果要追求...

30 分钟搞定 SpringBoot 视频推拉流!实战避坑指南

30分钟搞定SpringBoot视频推拉流!实战避坑指南在音视频开发领域,SpringBoot凭借其快速开发特性,成为很多开发者实现视频推拉流功能的首选框架。但实际开发中,从环境搭建到流处理优...

取消回复欢迎 发表评论: