【Python】 sys.path(环境变量)与__init__.py

sys.path(环境变量)

介绍

指定模块的搜索路径的字符串列表。

sys模块包含了与python解释器和它的环境有关的函数, 里面有个 sys.path属性。它是一个list.默然情况下python导入文件或者模块的话,他会先在sys.path里找模块的路径。如果没有的话,程序就会报错。

1. path[0]

此列表的第一项,path[0],在程序启动时初始化,是包含用来调用Python解释器的脚本的目录。如果脚本目录不可用(例如,如果解释器被交互式地调用,或者脚本是从标准输入读取的),path[0]是空字符串,它引导Python首先在当前目录中搜索模块。
比如在C:User\chenxi3\Destop\Simplify中有一个testSysPath. py

import sys
print("\n".join(sys.path))

输出是:

C:\Users\chenxi3\Desktop\Simplify
C:\Python27\DLLs
C:\Python27\lib
C:\Python27\lib\plat-win
C:\Python27\lib\lib-tk
C:\Python27
C:\Python27\lib\site-packages

path[0]是C:\Users\chenxi3\Desktop\Simplify,调用python解释器的脚本所在的目录。
如果在命令行中

>>> import sys
>>> print("\n".join(sys.path)

path[0]为空,因为没有脚本文件,也就找不到脚本文件所在目录。
这里写图片描述

2. 标准库

lib目录下(home目录\pythonXX\lib)

3. 第三方库

在lib目录下的site-package目录下(home目录\pythonXX\lib\site-packages)

修改path

一个程序可以根据它自己的目的自由地修改path列表。
场景:在实际开发中,默认包含了当前目录为搜索路径,所以,当前目录下的模块和子模块均可以正常访问。

但是若一个模块需要import平级的不同目录的模块,或者上级目录里面的模块,就可以通过修改path来实现。

修改path常用两种方法:

方法一:函数添加

这是即时生效的方法,就是在模块里面修改sys.path值,这种方法修改的sys.path作用域只是当前进程,进程结束后就失效了。
个人比较推荐这种方法,比较干净, 避免一些冲突问题。

比如现在的代码目录结构:

/src/configs/config.py
/src/common/Database.py

假如Database.py期望导入config. py,则可以增加上级目录到sys.path列表里面:

parent_path = os.path.dirname(sys.path[0])
if parent_path not in sys.path:
    sys.path.append(parent_path)
import configs.config

最好加个判断,避免重复加入。

方法二:添加.pth文件

在site-packages/ 增加一个路径文件,如mypkpath.pth,必须以.pth为后缀,将模块的路径写进去,一行一个路径,写上要加入的模块文件所在的目录名称。这种方法一劳永逸, 简单暴力。

举个例子,将/tmp/增加到sys.path
首先cd到指定python的sit-packages/目录下,然后创建一个文件,例如test.pth(注意后缀要为.pth),在文件中增加/tmp/路径信息,保存退出。
python2.7/site-packages/test.pth文件中添加一条:

/tmp/

方法三:修改环境变量

添加系统环境变量PYTHONPATH,在这个环境变量中输入相关的路径,不同的路径之间用逗号(英文的!)分开。路径会自动加入到sys.path中。

sys.path与init.py

_ init_ .py文件将一个文件夹转化为一个package,这对于创建一个模块的层次结构是很有用的,这样就可以使用这样的导入语句:

import mymodule.cool.stuff

如果没有package,这样就不行了。

假如有文件夹mymodule,mymodule下有文件夹cool,cool目录下有stuff.py脚本
将环境变量C:\mymodule加到sys.path中,在mymodule目录下简历_ init_ .py里面写上import cool(文件夹),在cool目录下新建_ init_ .py内容为空
运行时,就只需import mymodule.cool.stuff即可。

注:不需要增加子目录,因为在目录中我们有_ init_ .py

更多阅读

How does python find packages?
Where is Python’s sys.path initialized from?
python documentation-sys
Importing modules in Python and__init__.py

参考

https://my.oschina.net/zhangxu0512/blog/506744
http://blog.sina.com.cn/s/blog_6ff7a3b50102vzg1.html
https://blog.csdn.net/likelynn/article/details/1804665

已标记关键词 清除标记
相关推荐
©️2020 CSDN 皮肤主题: 编程工作室 设计师:CSDN官方博客 返回首页