第十章 模块(Module)和包(Package)

1 模块(Module)和包(Package)

1.1 命名空间(Namespace)

由于在Python中一切皆为对象(Object), 想要好好理解Module和Package,一定要先理解Namespace的概念。 所谓Namespace,是指标示符的可见范围。对于Python而言,常见的Namespace主要有以下几种:

  1. Build-in Namespace (内建命名空间)
  2. Global Namespace (全局命名空间)
  3. Local Namespace (局部命名空间)

有了命名空间的概念,可以有效的解决函数或者是变量重名的问题。不同的命名空间中允许出现相同的函数名或者 是变量名。它们彼此之间不会相互影响,例如在Namespace A和B中同时有一个名为var的变量,对A.var赋值并不 会改变B.var的值。

1.2 模块(Module)

Python中的一个Module对应的就是一个.py文件。其中定义的所有函数或者是变量都属于这个Module。这个Module 对于所有函数而言就相当于一个全局的命名空间。而每个函数又都有自己局部的命名空间。

# test.py 
'''
This is only a test module
'''
age = 0

def printHello():
  print "Hello, world!"

if __name__ == '__main__':
   printHello()

我们可这样来使用这个module, 用t来作为test的别名

>>> import test as t
>>> t.age
0
>>> t.age = 1
1
>>> t.printHello()
Hello, world!
>>> print t.__doc__
This is only a test module

当然,我们也可以这样来使用:

>>> form test import *
>>> age
0
>>> printHello()

你一定有注意到'main'的条件判断,由于每一个module都有name的属性,只有当直接运行 这个module的时候,name属性才会等于main。当它被import的时候,你可以完全当它不存在。

1.3 包(Package)

所谓Package, 就是一堆module的集合,也就一堆.py文件。 你可以用如下方式来创建一个package

  1. 新建一个folder名为test
  2. 在test文件夹下新建一个空的init.py文件。
  3. 在test文件夹下新建下py文件,名为a.py
# a.py
def sayHello():
  print "Hello, world!"

>>> import test.a as t
>>> t.sayHello()
Hello, world!

Package 提供了一种很好的管理module的方式,可以有效的减少module的命名conflict,保持较好的树型结构。

模块的导入

From 文件名 import 方法名 #从文件里导入某个方法

**from **xxx **import **myfunc #从某个文件夹里 导入 某个文件

**from **xxx.模块 **import **myfunc 从库里面导入某个包的方法

import 文件名 #将某个文件里的所有方法都导入到当前的文件

impot 文件名 as 别名 #将导入的文件 起 一个别名

__name__ #判断是否在当前的文件里

Func 目录

—>_init_.py from .a import *或者 **from **func.a **import ***

—>a.py

all 暴露接口

Python 可以在模块级别暴露接口:

__all__ = ["foo", "bar"]

很多时候这么做还是很有好处的……

提供了哪些是公开接口的约定

不像 Ruby 或者 Java,Python 没有语言原生的可见性控制,而是靠一套需要大家自觉遵守的”约定“下工作。比如下划线开头的应该对外部不可见。同样,__all__ 也是对于模块公开接口的一种约定,比起下划线,__all__ 提供了暴露接口用的”白名单“。一些不以下划线开头的变量(比如从其他地方 import 到当前模块的成员)可以同样被排除出去。

import os
import sys

__all__ = ["process_xxx"]  # 排除了 `os` 和 `sys`


def process_xxx():
    pass  # omit

控制 from xxx import * 的行为

代码中当然是不提倡用 from xxx import * 的写法的,但是在 console 调试的时候图个方便还是很常见的。如果一个模块 spam 没有定义 __all__,执行 from spam import * 的时候会将 spam 中非下划线开头的成员都导入当前命名空间中,这样当然就有可能弄脏当前命名空间。如果显式声明了 __all__import * 就只会导入 __all__ 列出的成员。如果 __all__ 定义有误,列出的成员不存在,还会明确地抛出异常,而不是默默忽略。

为 lint 工具提供辅助

编写一个库的时候,经常会在 __init__.py 中暴露整个包的 API,而这些 API 的实现可能是在包中其他模块中定义的。如果我们仅仅这样写:

from foo.bar import Spam, Egg

一些代码检查工具,如 pyflakes 就会报错,认为 SpamEggimport 了又没被使用的变量。当然一个可行的方法是把这个警告压掉:

from foo.bar import Spam, Egg  # noqa

但是更好的方法是显式定义 __all__,这样代码检查工具会理解这层意思,就不再报 unused variables 的警告:

from foo.bar import Spam, Egg

__all__ = ["Spam", "Egg"]

需要注意的是大部分情况下 __all__ 都是一个 list,而不是 tuple 或者其他序列类型。如果写了其他类型的 __all__,如无意外 pyflakes 等 lint 工具会无法识别出。

定义 all 需要注意的地方

  • 如上所述,__all__ 应该是 list 类型的
  • 不应该动态生成 __all__,比如使用列表解析式。__all__ 的作用就是定义公开接口,如果不以字面量的形式显式写出来,就失去意义了。
  • 即使有了 __all__ 也不应该在非临时代码中使用 from xxx import * 语法,或者用元编程手段模拟 Ruby 的自动 import。Python 不像 Ruby,没有 Module 这种成员,模块就是命名空间隔离的执行者。如果打破了这一层,而且引入诸多动态因素,生产环境跑的代码就充满了不确定性,调试也会非常困难。
  • 按照 PEP8 建议的风格,__all__ 应该写在所有 import 语句下面,和函数、常量等模块成员定义的上面。

如果一个模块需要暴露的接口改动频繁,__all__ 可以这样定义:

__all__ = [
    "foo",
    "bar",
    "egg",
]

最后多出来的逗号在 Python 中是允许的,也是符合 PEP8 风格的。这样修改一个接口的暴露就只修改一行,方便版本控制的时候看 diff

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 模块和包 一 模块 1 什么是模块? 常见的场景:一个模块就是一个包含了python定义和声明的文件,文件名就是...
    go以恒阅读 2,347评论 0 4
  • 一、PyCharm下载及安装 学习Demo 官网下载地址选择平台及版本,社区版是免费的,专业版收费。若是选择专业版...
    小哥_xiaoge阅读 3,627评论 0 1
  • If you quit from the Python interpreter and enter it agai...
    linyk3阅读 461评论 0 0
  • 2月的深圳,鸟语花香,莺歌燕舞。温柔的春风,轻轻地抚摸着巍峨的高楼,宽阔的马路,匆忙的人群和娇羞的小草。路边...
    泊宁赵阅读 454评论 0 2
  • 看简书也有那么久,有时候会在简书看一些技术性得文章,有时候会在简书看一些故事短文。但是,我也是今天才注册的一个简书...
    app丶阅读 240评论 0 3

友情链接更多精彩内容