python - 确保数组参数正确维数的 Python 3 方法是什么？

Question

在我的新手 Python 3.7 项目中，许多函数中的参数都是 numpy.ndarray 的。这些必须是二维 r x n 矩阵。行维度 r 是必不可少的:一些函数需要 1 x n 向量，其他函数需要 2 x n 矩阵，r 向上到三个甚至更多。还为任何 r x n 数组定义了函数。 (列维度 n 对于设计目的不是必需的。)

根据我的 Matlab 经验，此要求可能会让人感到困惑且容易出错。所以我考虑了以下方法:

1. 记录方法参数(当然!)
2. 单元测试(当然!)
3. 在某些函数中进行验证并抛出异常。 (但是，这不是很实用，也不是很高效。)
4. 定义数据类:OneRow、TwoRows、ThreeRows 和 FourPlusRows。每个都有一个 ndarray 字段，在构造函数中验证。好处包括类型提示和更好的领域建模，如 DDD。缺点是额外的复杂性。

问题鉴于 Python 3 中引入的类型提示和函数式编程的趋势，当前 pythonic 方法是什么来解决这个问题？

Answer 1

关于 Python 的最好的事情之一是 duck typing ，并且 Numpy 通常与该设计方法非常兼容。假设您有一个纯向量函数 vecfunc。您可以在函数的开头添加一些样板，将任何一维数组膨胀为 1 x n 向量:

def vecfunc(arr):
    if arr.ndim==1:
        arr = arr[None, :]

    ...function body goes here...

这将避免由于 arr 的维度太少而导致的任何问题，并且在大多数情况下仍可能给出正确的行为。但是，它不会阻止用户传入一个 r x n x m 数组或 15 x n 数组。最终，您将不得不采用 3. 方法处理这些东西，并在适当的地方抛出一些异常。例如:

def vecfunc(arr):
    if not 0 < arr.ndim < 3:
        raise ValueError("arr must have ndim of 1 or 2. arr.ndim: %d" % arr.ndim)
    elif arr.ndim==1:
        arr = arr[None, :]

如果这能让你感觉好些，numpy 的代码库和 scipy在需要的时间和地点对许多函数进行基于形状的异常检查。

当然，您始终可以在开发任何给定函数的最后阶段之前不添加这些类型的异常检查。您可能会对产生合理行为的输入范围感到惊讶。

如果您对类型注释死心塌地，可以通过 writing your code using Cython 获得类似的东西.例如，如果您想要一个只接受二维整数数组的 add 函数，您可以在 .pyx 文件中编写以下函数:

import numpy as np

def add(long[:, :] arr1, long[:, :] arr2):
    assert tuple(arr1.shape) == tuple(arr2.shape)

    result = np.zeros((arr1.shape[0], arr1.shape[1]), dtype=np.long)
    cdef long[:, :] result_view = result

    for x in range(arr1.shape[0]):
        for y in range(arr1.shape[1]):
            result_view[x, y] = arr1[x, y] + arr2[x, y]

    return result

有关编写和编译 Cython 的更多详细信息，请参阅上面链接的文档。

这与其说是“类型注释”，还不如说是真正的强类型，但它可以满足您的要求。遗憾的是，我无法找到一种方法来固定单个维度的大小，只能固定维度的总数。