Python的Package和Module

最近有時會使用Python作些簡單的後端或工具的開發，這對許多人來說可能很熟悉了，不過在此就讓我這個不熟的新手作些基本觀念的記錄。

在Python中，Package(包)和Module(模組)是用來管理程式碼的結構。

1. 模組 Module

Module是包含Python程式碼的檔案，簡單來說就是一個.py的Source Code檔案，裡面可以包含函數、變數、類別等等。或者是一個己經編譯過的.pyc檔案也是一個Module。

如下定義一個a.py的模組。

# a.py
a=1

在其它的Python程式碼檔案裡面可以使用import語句來使用a.py這個模組內定義的函數、變數、類別等等。

如下測試引用a.py裡定義的a。

D:\temp\test>python
Python 3.12.3 (tags/v3.12.3:f6650f9, Apr  9 2024, 14:05:25) [MSC v.1938 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__']
>>> import a
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a']
>>> a
<module 'a' from 'D:\\temp\\test\\a.py'>
>>> a.a
1
>>>

注意：一個Module被import的時候，如果存在.pyc就會載入它。如果.py比較新就會先編譯成.pyc再載入。

2. 包 Package

Package其實就是一個目錄，裡面可以包含多個.py也就是多個Module。前提是這個目錄裡面必須有一個__init__.py檔案，這個目錄才會被Python視為一個Package。(不過Python3.3以後這個限制就不在了，__init__.py變成可有可無，但如果要作Package初始化還是需要它。)

因為是目錄，所以也能夠作巢狀管理。如a.b.c，就是目錄[a]下面的目錄[b]下面的c模組。

現在建立一個目錄[b]，在目錄[b]裡面建立一個c.py。

# b/c.py
c='ccc'

D:\temp\test>python
Python 3.12.3 (tags/v3.12.3:f6650f9, Apr  9 2024, 14:05:25) [MSC v.1938 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__']
>>> import b
>>> b
<module 'b' (namespace) from ['D:\\temp\\test\\b']>
>>> b.c
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'b' has no attribute 'c'
>>> import b.c
>>> b.c
<module 'b.c' from 'D:\\temp\\test\\b\\c.py'>
>>> b.c.c
'ccc'
>>>

3. 導入模組或包 import

Python的import語句有幾種用法。

#直接import Module a
import a

#import Package b裡面的Module c
import b.c

#從Package b裡面import Module c
from b import c

D:\temp\test>python
Python 3.12.3 (tags/v3.12.3:f6650f9, Apr  9 2024, 14:05:25) [MSC v.1938 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__']
>>> import a
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a']
>>> a
<module 'a' from 'D:\\temp\\test\\a.py'>
>>> import b.c
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'b']
>>> b
<module 'b' (namespace) from ['D:\\temp\\test\\b']>
>>> b.c
<module 'b.c' from 'D:\\temp\\test\\b\\c.py'>
>>> from b import c
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'b', 'c']
>>> c
<module 'b.c' from 'D:\\temp\\test\\b\\c.py'>
>>> c.c
'ccc'
>>>

4. 別名 as

import as的用法是在導入模組時給它一個別名，可以使程式碼更簡潔易讀。

如下是常見的範例，用np或pd来替代numpy或pandas。

import numpy as np                      # 導入 numpy 模組並給它起别名 np
import pandas as pd                     # 導入 pandas 模組並給它起别名 pd

結合from import as可以替模組內的特定部份取別名。

如下面的範例，from a import a as aaa用a裡面的a取了一個aaa的別名。

D:\temp\test>python
Python 3.12.3 (tags/v3.12.3:f6650f9, Apr  9 2024, 14:05:25) [MSC v.1938 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__']
>>> import a
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a']
>>> a
<module 'a' from 'D:\\temp\\test\\a.py'>
>>> a.a
1
>>> from a import a as aaa
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'a', 'aaa']
>>> aaa
1
>>>