你可能忽略的 Python 功能：Ellipsis (...)

即使寫了 Python 如此多年，我仍未發覺 ... （你沒看錯，三個點）在 Python 也是一個 object，而且它有些不為人知的妙用，可以提昇程式碼的簡潔性或可讀性，如果你跟我一樣不知道 ... 的用法，歡迎閱讀此文！

Ellipsis #

The same as the ellipsis literal “…”

根據 Python 官方文件，其實 Python 有提供 1 個相當特殊的語法 ... 或是 Ellipsis。

你可以在 Python 直譯器(interpreter)中輸入 3 個點，就會顯示 Ellipsis：

>>> ...
Ellipsis

一般情況下，它跟 pass 同樣沒有任何作用，所以它也可以用來取代 pass，例如：

>>> def do_nothing():
...     ...
...
>>> do_nothing()
>>>

但 Ellipsis 比起 pass 多了不少用途，下文列舉一些 Ellipsis 的其他用途。

型別的提示(type hints)可以使用 Ellipsis #

譬如，一個不定長度的 tuple 或者 list 變數，可以使用 Ellipsis 進行表示：

my_tuple: tuple[int, ...] = (1, 2, 3)

或者也可用 Callable 設定不定長度參數(variadic parameters)，例如下列範例：

from typing import Callable

def pprint(*args: int):
    print(*args)

VaridaicCallable = Callable[..., int]

def call_func(func: VaridaicCallable, *args: int):
    func(*args)

call_func(pprint, 1, 2, 3, 4)

p.s. 有人可能會好奇為什麼 pprint 的不定長度參數能夠以 *args: int 進行表示，這是因為 *args 在 Python type hints 會自動以 tuple 表示，所以 *args: int 其實 Python 會轉成 tuple[int, ...] 處理，因此不需要特別以 Ellipsis 表示。

進階 Ellipsis 用法 #

另一種進階用法是使用 ... 作為傳入值，然後可以用 is 語法判斷是否為 Ellipsis 從而決定程式的行為，例如我們用 ... 代表取得所有值：

def iter_values(dictionary, keys):
    if keys is Ellipsis:
        keys = dictionary.keys()
    for k in keys:
        yield dictionary.get(k)


list(iter_values({'a': 1, 'b': 2}, ...))  # [1, 2]

如果不使用 Ellipsis 的話，那麽上述程式碼可能會變成：

def iter_values(dictionary, keys=None, all=False):
    if all:
        keys = dictionary.keys()
    for k in keys:
        yield dictionary.get(k)


list(iter_values({'a': 1, 'b': 2}, all=True))

兩者相較之下，我個人更喜歡使用 Ellipsis 的用法！

Numpy 的 Slicing 也使用 Ellipsis #

Ellipsis expands to the number of : objects needed for the selection tuple to index all dimensions.

Numpy 的多維 slicing 技巧也可以使用 Ellipsis 語法簡化表示式， ... 它代表所有維度(dimensions)，舉以下二維陣列為例：

x = np.array([
    [0, 1, 2],
    [3, 4, 5],
    [6, 7, 8],
])

如果我們想取得 1, 4, 7 這 3 個值，我們可以用以下語法取值：

x[0:3:1, 1]

# or

x[0:3, 1]

# or

x[::, 1]

上述 0:3:1 代表從 index 0 開始，到 index 3 結束（不含索引值 3），每次遞增 1。這種表示方法的壞處是我們每次都必須明確指定結束的索引值。

Numpy 提供我們用 Ellipsis 代表所有維度，因此可以簡化下列寫法：

x[..., 1]  # array([1, 4, 7])

再舉個例子，如果我們想要取得以下三維陣列的 [1][所有元素][0] 的值，也就是 9, 10, 11, 12, 13, 14, 15, 16, 17 的話，可以用 x[1, ..., 0] 進行表示：

x = np.array([
    [
        [0, 0], [1, 1], [2, 2],
        [3, 0], [4, 1], [5, 2],
        [6, 0], [7, 1], [8, 2],
    ],
    [
        [9, 0], [10, 1], [11, 2],
        [12, 0], [13, 1], [14, 2],
        [15, 0], [16, 1], [17, 2],
    ],
])

x[1, ..., 0]  # array([ 9, 10, 11, 12, 13, 14, 15, 16, 17])

Python 的 Ellipsis 只有一個 #

There is exactly one ellipsis object, named Ellipsis (a built-in name). type(Ellipsis)() produces the Ellipsis singleton.

It is written as Ellipsis or ....

最後，Ellipsis 其實在 Python 中是一個 singleton，所有的 Ellipsis 都引用自同一個 Ellipsis 實例：

>>> id(...) == id(Ellipsis)
True
>>> ... is Ellipsis
True
>>> type(Ellipsis)() is ... is Ellipsis
True

這也是為什麼可以用 is 判斷 Ellipsis 的原因。

總結 #

Ellipsis 是個鮮為人知的語法，不知道的話其實不會有任何影響，但如果能對它有些認識，將有助於我們寫出更 Pythonic 的程式碼。

以上！Happy Coding!

References #

When Do You Use an Ellipsis in Python?

Comprehensive Guide to the Ellipsis in Python: Usage, Examples, and Best Practices

Indexing on ndarrays — NumPy v2.2 Manual

Python