python | 深刻理解sys.path.append方法的用法

sys模块的功能

sys.path.append() 方法是 Python 中用于动态添加搜索路径的工具。sys.path 是一个由字符串组成的列表,它定义了 Python 解释器在导入模块时搜索模块的路径。当你使用 sys.path.append() 方法时,你实际上是在列表的末尾添加一个新的路径。

  • 用途

    导入自定义模块:如果你有自定义的 Python 模块或包,它们不在标准库或安装的第三方库的路径中,你可以使用 sys.path.append() 来添加包含这些模块的目录。

开发中的模块:在开发过程中,你可能需要导入尚未安装到环境中的模块。通过添加模块所在的目录到 sys.path,你可以在开发过程中直接导入这些模块。

避免命名冲突:如果你的模块名与标准库中的模块名相同,通过添加自定义模块的路径,你可以确保你的模块被优先导入

实战认识

  • 功能结构如下

在这里插入图片描述

  • 代码
模块内容
module1.py:

# module1.py
def greet():
    return "Hello from module1"
module2.py:

python
# module2.py
def greet():
    return "Hello from module2"
主程序
main.py:
import sys
import os


# 获取当前文件的目录
current_dir = os.path.dirname(os.path.abspath(__file__))
print('*'*100)
print('current_file_path:',os.path.abspath(__file__))

print('current_dir:',current_dir)
print('before _  sys.path ',sys.path)

from package.module1 import greet as greet1
from package.module2 import greet as greet2

def main():
    print(greet1())
    print(greet2())

if __name__ == "__main__":
    main()

不使用sys.path.append方法

在这里插入图片描述

-主要查看before_sys.path

before_sys.path  
['E:\\GitRepository\\PythonModuleLearn\\sys_append_test', # 本机目录
'E:\\GitRepository\\PythonModuleLearn', '  # 本工程目录
...]

观察上述结果可知,模块下的learnTest没有加载到路径中,导致 Python 解释器在导入模块时搜索不到

使用sys.path.append方法

  • 修改main.py
    在from导入模块之前动态加载到python解释器的路径中
# 将  目录添加到 sys.path
sys.path.append(os.path.join("../learnTest"))
print('after _  sys.path ',sys.path)
print('*'*100)
  • 结果

在这里插入图片描述

****************************************************************************************************
before_sys.path  ['E:\\GitRepository\\PythonModuleLearn\\sys_append_test',
'E:\\GitRepository\\PythonModuleLearn',
...]
after_sys.path  ['E:\\GitRepository\\PythonModuleLearn\\sys_append_test', 
'E:\\GitRepository\\PythonModuleLearn',
...
'../learnTest']

查看after_sys.path发现’…/learnTest’在Python 解释器搜索路径上,虽然文件标红,但是不影响运行

在这里插入图片描述

### 回答1: 在Python中,sys.path是一个列表,用于存储模块的搜索路径。当我们使用import语句导入模块时,Python会在sys.path中列出的路径中搜索相应的模块。 使用sys.path.append()函数可以向sys.path列表中添加新的搜索路径。如果我们想要导入上级目录中的模块或子文件,就可以使用sys.path.append()函数添加上级目录的路径。 例如,假设我们有一个文件夹结构如下: ``` project/ module/ __init__.py module.py utils/ __init__.py utils.py main.py ``` 如果我们想在main.py中导入module.py和utils.py,就可以使用sys.path.append()函数添加相应的搜索路径: ```python import sys sys.path.append('../module') sys.path.append('../utils') import module # 导入module.py import utils # 导入utils.py ``` 在上面的代码中,我们将../module和../utils分别添加sys.path中,使得Python可以在这两个路径中搜索相应的模块。 需要注意的是,使用sys.path.append()函数添加搜索路径并不会永久生效,只会在当前会话中有效。如果想要永久添加搜索路径,可以修改PYTHONPATH环境变量。 ### 回答2: python中,sys.path.append()是用来添加模块搜索路径的函数,使用该函数可以将所需的模块路径添加至系统模块搜索路径列表中。 sys.path.append() 是向sys.path列表末尾 添加一个模块搜索路径。在Python中,一个包package通常包含多个模块module,这些模块通常保存在同一个文件夹下,该文件夹就是这个包的目录。使用sys.path.append()函数可以将这个目录添加Python模块搜索路径列表中,从而能够快速地找到该目录下的所有模块。 例如,我们在项目中需要使用上一级目录中的模块,此时可以使用sys.path.append()函数将上级目录添加模块搜索路径列表中。具体实现可以按以下步骤进行: 1.使用os模块获取当前文件所在的目录路径,这可以通过os.path.dirname(__file__)函数来实现。 2.使用os.path.abspath()函数获取当前目录的绝对路径。 3.使用os.path.join()函数将当前目录的父目录与要添加的路径拼接起来,即可得到上级目录中的路径。 4.使用sys.path.append()函数将上级目录路径添加模块搜索路径列表中。 下面是一个简单的示例代码,假设我们需使用上级目录中的模块mymodule作为一个函数: ``` python import os import sys # 获取当前文件所在的目录路径 cur_path = os.path.dirname(__file__) # 获取当前目录的绝对路径 cur_path = os.path.abspath(cur_path) # 获取上一级目录的路径 parent_path = os.path.join(cur_path, '..') # 将上级目录路径添加sys.path列表末尾 sys.path.append(parent_path) # 导入上级目录中的mymodule模块 import mymodule # 调用mymodule中的函数 mymodule.myfunction() ``` 以上代码将上级目录路径添加模块搜索路径列表中,因此可以成功地导入上级目录中的模块。其中,mymodule是上级目录中的模块,myfunction是mymodule模块中的一个函数。 ### 回答3: 在Python中,sys.pathPython搜索module的路径列表,所有在该列表中的路径下的module都可以被Python引入并使用。常见的情况是,我们需要使用自己或他人编写的库,但是这些库文件并不在Python内置库或Python安装目录下,而是放在自定义路径下,为了能够让Python找到这些库文件,就需要将这些路径添加sys.path中。 在添加路径时,不仅可以添加当前目录、Python内置库、Python安装目录等路径,还可以添加上级目录下的子目录路径,以此使Python可以直接找到这些包和模块。 使用sys.path.append()函数可以将路径添加sys.path中,可以添加绝对路径或相对路径。在添加上级目录子文件的路径时,可以使用os模块和os.path模块来获取指定路径的上级目录路径,并通过sys.path.append()来添加上级目录子文件的路径。 例如,我们可以在当前Python文件中添加上级目录子文件的路径方式如下: import sys import os #获取当前文件的路径 current_path = os.path.abspath(__file__) #获取当前文件的上级目录路径 current_dir = os.path.dirname(current_path) #获取上级目录的上级目录路径 parent_path = os.path.abspath(os.path.join(current_dir, "..")) #添加上级目录子文件 sys.path.append(parent_path) 这样,我们就可以通过Python的import语句直接引入上级目录子文件中的模块和子模块了。通过该方法,我们可以更方便地调用上级目录下子文件中的模块,使得项目的模块结构更加清晰合理。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

胜天半月子

打不打商的无所谓,能帮到你就好

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值