1. 技术文章
  2. Python自定义包引入【新手必学】

Python自定义包引入【新手必学】

由 牧云@^-^@ 提交于 2020-04-30 00:14:20

 

前言
本文的文字及图片来源于网络,仅供学习、交流使用,不具有任何商业用途,版权归原作者所有,如有问题请及时联系我们以作处理。
作者：sys_song


python中的Module是比较重要的概念。常见的情况是，事先写好一个.py文 件，在另一个文件中需要import时，将事先写好的.py文件拷贝 到当前目录，或者是在sys.path中增加事先写好的.py文件所在的目录，然后import。这样的做法，对于少数文件是可行的，但如果程序数目很 多，层级很复杂，就很吃力了。如果你刚学python不久，有问题找不到人解答的话。可以去小编的Python交流.裙 ：一久武其而而流一思（数字的谐音）转换下可以找到了，里面有最新Python教程项目可拿,不懂的问题多跟里面的人交流，都会解决哦！

有没有办法，像Java的Package一样，将多个.py文件组织起来，以便在外部统一调用，和在内部互相调用呢？答案是有的。
主要是用到python的包的概念，python __init__.py在包里起一个比较重要的作用
要弄明白这个问题，首先要知道，python在执行import语句时，到底进行了什么操作，按照python的文档，它执行了如下操作：
第1步，创建一个新的，空的module对象（它可能包含多个module）；
第2步，把这个module对象插入sys.module中
第3步，装载module的代码（如果需要，首先必须编译）
第4步，执行新的module中对应的代码。

在执行第3步时，首先要找到module程序所在的位置，其原理为：
如 果需要导入的module的名字是m1，则解释器必须找到m1.py，它首先在当前目录查找，然后是在环境变量PYTHONPATH中查找。 PYTHONPATH可以视为系统的PATH变量一类的东西，其中包含若干个目录。如果PYTHONPATH没有设定，或者找不到m1.py，则继续搜索 与python的安装设置相关的默认路径，在Unix下，通常是/usr/local/lib/python。
事实上，搜索的顺序是：当前路径 （以及从当前目录指定的sys.path），然后是PYTHONPATH，然后是python的安装设置相关的默认路径。正因为存在这样的顺序，如果当前 路径或PYTHONPATH中存在与标准module同样的module，则会覆盖标准module。也就是说，如果当前目录下存在xml.py，那么执 行import xml时，导入的是当前目录下的module，而不是系统标准的xml。

了解了这些，我们就可以先构建一个package，以普通module的方式导入，就可以直接访问此package中的各个module了。

Python中的package定义很简单，其层次结构与程序所在目录的层次结构相同，这一点与Java类似，唯一不同的地方在于，python中的package必须包含一个__init__.py的文件。
例如，我们可以这样组织一个package:

package1/
    __init__.py
    subPack1/
        __init__.py
        module_11.py
        module_12.py
        module_13.py
    subPack2/
        __init__.py
        module_21.py
        module_22.py
    ……

__init__.py可以为空，只要它存在，就表明此目录应被作为一个package处理。当然，__init__.py中也可以设置相应的内容，下文详细介绍。

好了，现在我们在module_11.py中定义一个函数：

def funA():
    print "funcA in module_11"
    return

在顶层目录（也就是package1所在的目录，当然也参考上面的介绍，将package1放在解释器能够搜索到的地方）运行python:

>>>from package1.subPack1.module_11 import funcA
>>>funcA()
funcA in module_11

这样，我们就按照package的层次关系，正确调用了module_11中的函数。

细心的用户会发现，有时在import语句中会出现通配符*，导入某个module中的所有元素，这是怎么实现的呢？
答案就在__init__.py中。我们在subPack1的__init__.py文件中写

__all__ = ['module_13', 'module_12']

然后进入python
>>>from package1.subPack1 import *
>>>module_11.funcA()
Traceback (most recent call last):
  File "", line 1, in 
ImportError: No module named module_11

也就是说，以*导入时，package内的module是受__init__.py限制的。

好了，最后来看看，如何在package内部互相调用。
如果希望调用同一个package中的module，则直接import即可。也就是说，在module_12.py中，可以直接使用
import module_11

如果不在同一个package中，例如我们希望在module_21.py中调用module_11.py中的FuncA，则应该这样：
from module_11包名.module_11 import funcA

 

包机制

# a.py
def add_func(a,b):
    return a+b

# b.py
from a import add_func # Also can be : import a

print ("Import add_func from module a")
print ("Result of 1 plus 2 is: ")
print (add_func(1,2))    # If using "import a" , then here should be "a.add_func"

module可以定义在包里面.Python定义包的方式稍微有点古怪,假设我们有一个parent文件夹,该文件夹有一个child子文件夹.child中有一个module a.py . 如何让Python知道这个文件层次结构?很简单,每个目录都放一个名为_init_.py 的文件.该文件内容可以为空.这个层次结构如下所示:

parent 
  --__init_.py
  --child
    -- __init_.py
    --a.py

b.py
那么Python如何找到我们定义的module?在标准包sys中,path属性记录了Python的包路径.你可以将之打印出来:
import sys

print(sys.path)
通常我们可以将module的包路径放到环境变量PYTHONPATH中,该环境变量会自动添加到sys.path属性.另一种方便的方法是编程中直接指定我们的module路径到sys.path 中:
import sys
import os
sys.path.append(os.getcwd()+'\\parent\\child')
print(sys.path)
from a import add_func
print (sys.path)
print ("Import add_func from module a")
print ("Result of 1 plus 2 is: ")
print (add_func(1,2))

知识点:

      如何定义模块和包

      如何将模块路径添加到系统路径,以便python找到它们

      如何得到当前路径

 

http://www.dai3.com/python-import.html下文地址：

 

Python 包的相对导入讲解

 

两个常见错误

1. ValueError: Attempted relative import in non-package​

错误重现
目录树

 

 
1
2
3
4
5
6
7
8
9
case1/
├── cat
│    ├── __init__.py
│    └── cat.py
├── dog
│    ├── __init__.py
│    └── dog.py
└── main.py
 

 

代码

 

 
1
2
3
# case1/cat/cat.py
from .. import dog
 

 

执行

python case1/cat/cat.py

错误原因

python 使用一个模块的属性 name 来决定他在包结构中的位置，所以当直接执行 cat.py 时，name = \’main\’，cat.py 被当作顶层模块来处理了，自然不可能导入上层的任何对象了。

2. ValueError: Attempted relative import beyond toplevel package

错误重现

目录树

 

 
1
2
3
4
5
6
7
8
9
10
11
case2/
├── cat
│    ├── __init__.py
│    ├── cat.py
│    └── cat.pyc
├── dog
│    ├── __init__.py
│    └── dog.py
├── __init__.py
└── main.py
 

 

代码

 

 
1
2
3
4
5
6
# case2/cat/cat.py
from .. import dog
 
# case2/main.py
import cat.cat
 

 

执行

python case2/main.py

错误原因:

这里的 case2 是一个包，但当你直接执行 main.py 的时候，就没有把完整的 case2 当作一个包来处理了，可想而知，下层的 cat.py 自然找不到上层包了。即想要相对导入成功，必须让下层的被导入对象是上层包或上层包内的对象。

正确执行的例子

目录树

 

 
1
2
3
4
5
6
7
8
9
10
11
12
case3/
├── alpaca.py
├── main.py
└── pets
    ├── __init__.py
    ├── cat
    │   ├── __init__.py
    │   └── cat.py
    └── dog
        ├── __init__.py
        └── dog.py
 

 

代码

 

 
1
2
3
4
5
6
7
# case3/pets/cat/cat.py
from ..dog import dog
from .. import dog
 
# case3/main.py
from pets.cat import cat
 

 

执行

python case3/main.py

请注意，这里的 cat.py 中是不能导入 alpaca 的，因为 pets 已经是这个包树的顶层了。

From：http://hiaero.net/python-relative-imports/

另外一篇：

python的相对路径导入问题

用python做项目，如果项目大了，或者想更好的管理程序，总是要使用包。包解决了命名冲突的问题。
今天在使用python的相对路径导入的时候，遇到了不少的问题。
包导入情形：

 

 
1
2
3
4
5
6
7
8
9
10
11
src/
    __init__.py
    main.py
    components/
        __init__.py
        expander.py
        language_id.py
    utilities/
        __init__.py
        functions.py
 

 

如果要在expander.py中引用functions.py中的内容，或许这样表示
from ..utilities import functions.py

1.错误一：ValueError:Attemptedrelative import beyond toplevel package
这个问题是因为到达了包的最顶层，而最顶层不是一个包。
解决方法：在main.py同级添加一个目录mod，包含components和utilities，并在mod中添加一个init.py，即可解决
参见：http://stackoverflow.com/questions/4175534/relative-imports-in-python

2.错误二：ValueError: Attempted relative import in non-package
使用相对路径进行导入的文件，不能再当作主文件执行。原因如下：

http://blog.csdn.net/chinaren0001/article/details/7338041

3.错误三：no module named ***
在指定路径下没有找到该模块。

另外：在main.py执行的时候，没有指定路径的文件默认与main.py是同一路径。本期分享到此，如果你刚学python不久，没有最新学习路线或有问题找不到人解答的话。可以去小编的Python交流.裙 ：一久武其而而流一思（数字的谐音）转换下可以找到了，里面有最新Python教程项目可拿,不懂的问题多跟里面的人交流，都会解决哦！

标签
python
java
def
alpaca
expander
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!