Python 学习笔记 6. 模块

🏷️ Python Python 学习笔记

模块是一个包含 Python 定义和语句的文件。 文件名就是模块名后跟文件后缀 .py 。

在一个模块内部，模块名（作为一个字符串）可以通过全局变量 __name__ 的值获得。

fibo.py

# Fibonacci numbers module

def fib(n):    # write Fibonacci series up to n
    a, b = 0, 1
    while a < n:
        print(a, end=' ')
        a, b = b, a+b
    print()

def fib2(n):   # return Fibonacci series up to n
    result = []
    a, b = 0, 1
    while a < n:
        result.append(a)
        a, b = b, a+b
    return result

运行上述文件：

>>> import fibo
>>> fibo.fib(1000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
>>> fibo.fib2(1000)
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610, 987]
>>> fibo.__name__
'fibo'

可以将函数与赋值给局部变量。

>>> fib = fibo.fib
>>> fib(1000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987

6.1. 有关模块的更多信息

模块可以包含 可执行的语句 以及 函数定义 。这些语句用于初始化模块。它们仅在模块 第一次 在 import 语句中被导入时才执行。

每个模块都有它自己的 私有符号表 ，该表用作模块中定义的所有函数的全局符号表。

模块可以导入其它模块：

>>> import fibo # 导入 fibo 模块到当前模块
>>> from fibo import fib, fib2 # 导入 fibo 模块中的 fib 和 fib2 导入到当前模块（模块名 fibo 不会被导入）
>>> from fibo import * # 导入 fibo 中的所有非以下划线（_）开头的符号到当前模块（模块名 fibo 不会被导入）

如果模块名称之后带有 as，则跟在 as 之后的名称将直接绑定到所导入的模块。
（功能类似于 SQL 中的 as，相当于将模块换了个名字。）

>>> import fibo as fib

也可以使用 as 来给导入的符号起别名。

>>> from fibo import fib as fibonacci
>>> fibonacci(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

6.1.1. 以脚本的方式执行模块

可以通过如下方式运行 Python：

python fibo.py <arguments>

模块里的代码会被执行，就好像你导入了模块一样，但是 __name__ 被赋值为 "__main__"。

在文件末尾添加如下代码：

if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))

以脚本的方式执行模块：

D:\py>python fibo.py 50
0 1 1 2 3 5 8 13 21 34

使用 import 时这段脚本是不会运行的。这经常用于为模块提供一个方便的用户接口，或用于测试。

6.1.2. 模块搜索路径

当导入一个模块时：

1. 解释器首先寻找具有该名称的内置模块。

2. 如果没有找到，然后解释器从 sys.path 变量给出的目录列表里寻找名为 spam.py 的文件。

sys.path 初始有这些目录地址:

1. 包含输入脚本的目录（或者未指定文件时的当前目录）。

2. PYTHONPATH （一个包含目录名称的列表，它和 shell 变量 PATH 有一样的语法）。

3. 取决于安装的默认设置

6.1.3. “编译过的” Python 文件

为了 加速模块载入，Python 在 __pycache__ 目录里缓存了每个模块的编译后版本，名称为 module.version.pyc ，其中名称中的版本字段对编译文件的格式进行编码；它一般使用 Python 版本号。

Python 在两种情况下不会检查缓存。

1. 对于从命令行直接载入的模块，它从来都是重新编译并且不存储编译结果；

2. 如果没有源模块，它不会检查缓存。

6.2. 标准模块

Python 附带了一个标准模块库。这些模块的集合是一个配置选项，它也取决于底层平台。

一个特别值得注意的模块 sys，它被内嵌到每一个 Python 解释器中。变量 sys.ps1 和 sys.ps2 定义用作主要和辅助提示的字符串:

>>> import sys
>>> sys.ps1
'>>> '
>>>
>>> sys.ps2
'... '
>>>
>>> sys.ps1 = 'C> '
C>

这两个变量只有在编译器是 交互模式 下才被定义。

sys.path 变量是一个字符串列表，用于确定解释器的模块搜索路径。该变量被初始化为从环境变量 PYTHONPATH 获取的默认路径，或者如果 PYTHONPATH 未设置，则从内置默认路径初始化。你可以使用标准列表操作对其进行修改:

>>> import sys
>>> sys.path.append('/ufs/guido/lib/python')

6.3. dir() 函数

内置函数 dir() 用于查找模块定义的名称。它返回一个排序过的字符串列表:

>>> import fibo, sys
>>> dir(fibo)
['__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', 'fib', 'fib2']
>>> dir(sys)
['__breakpointhook__', '__displayhook__', '__doc__', '__excepthook__', '__interactivehook__', '__loader__', '__name__', '__package__', '__spec__', '__stderr__', '__stdin__', '__stdout__', '_clear_type_cache', '_current_frames', '_debugmallocstats', '_enablelegacywindowsfsencoding', '_framework', '_getframe', '_git', '_home', '_xoptions', 'api_version', 'argv', 'base_exec_prefix', 'base_prefix', 'breakpointhook', 'builtin_module_names', 'byteorder', 'call_tracing', 'callstats', 'copyright', 'displayhook', 'dllhandle', 'dont_write_bytecode', 'exc_info', 'excepthook', 'exec_prefix', 'executable', 'exit', 'flags', 'float_info', 'float_repr_style', 'get_asyncgen_hooks', 'get_coroutine_origin_tracking_depth', 'get_coroutine_wrapper', 'getallocatedblocks', 'getcheckinterval', 'getdefaultencoding', 'getfilesystemencodeerrors', 'getfilesystemencoding', 'getprofile', 'getrecursionlimit', 'getrefcount', 'getsizeof', 'getswitchinterval', 'gettrace', 'getwindowsversion', 'hash_info', 'hexversion', 'implementation', 'int_info', 'intern', 'is_finalizing', 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path', 'path_hooks', 'path_importer_cache', 'platform', 'prefix', 'ps1', 'ps2', 'set_asyncgen_hooks', 'set_coroutine_origin_tracking_depth', 'set_coroutine_wrapper', 'setcheckinterval', 'setprofile', 'setrecursionlimit', 'setswitchinterval', 'settrace', 'stderr', 'stdin', 'stdout', 'thread_info', 'version', 'version_info', 'warnoptions', 'winver']

如果没有参数，dir() 会列出你当前定义的名称:

>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'sys']

注意：它列出所有类型的名称：变量，模块，函数，等等。

dir() 不会列出内置函数和变量的名称。如果你想要这些，它们的定义是在标准模块 builtins 中:

>>> import builtins
>>> dir(builtins)
['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning', 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError', 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning', 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False', 'FileExistsError', 'FileNotFoundError', 'FloatingPointError', 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError', 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError', 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError', 'MemoryError', 'ModuleNotFoundError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented', 'NotImplementedError', 'OSError', 'OverflowError', 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError', 'RecursionError', 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning', 'StopAsyncIteration', 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError', 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', 'ValueError', 'Warning', 'WindowsError', 'ZeroDivisionError', '_', '__build_class__', '__debug__', '__doc__', '__import__', '__loader__', '__name__', '__package__', '__spec__', 'abs', 'all', 'any', 'ascii', 'bin', 'bool', 'breakpoint', 'bytearray', 'bytes', 'callable', 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass', 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print',
'property', 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars', 'zip']

6.4. 包

包是一种通过用 “带点号的模块名” 来构造 Python 模块命名空间的方法。

当导入这个包时，Python 搜索 sys.path 里的目录，查找包的子目录。

必须要有 __init__.py 文件才能让 Python 将包含该文件的目录当作包。最简单的情况下， __init__.py 可以只是一个空文件。

import sound.effects.echo
from sound.effects import echo
from sound.effects.echo import echofilter

6.4.1. 从包中导入 *

import 语句使用下面的规范：如果一个包的 __init__.py 代码定义了一个名为 __all__ 的列表，它会被视为在遇到 from package import * 时应该导入的模块名列表。

__all__ = ["echo", "surround", "reverse"]

不推荐使用 import * 的方式导入。

6.4.2. 子包参考

绝对导入：

from sound.effects import echo

相对导入：

from . import echo # 导入同级目录下的 echo 模块
from .. import formats # 导入上级目录的 formats 子包
from ..filters import equalizer # 导入上级目录的 filters 包下的 equalizer 模块

6.4.3. 多个目录中的包

包支持另一个特殊属性， __path__ 。

它被初始化为一个列表，其中包含在执行该文件中的代码之前保存包的文件 __init__.py 的目录的名称。

这个变量可以修改；这样做会影响将来对包中包含的模块和子包的搜索。