Python 指令中的预期类型 'Union[ndarray, Iterable]' 警告

Question

我已经翻译了一个 Matlab 函数来创建一个过完备离散余弦变换矩阵来表示这种矢量 space 中的一维信号到 Python 语言。

Matlab 函数

function D = odctdict(n,L)
%ODCTDICT Overcomplete DCT dictionary.
%  D = ODCTDICT(N,L) returns the overcomplete DCT dictionary of size NxL
%  for signals of length N.
%
%  See also ODCT2DICT, ODCT3DICT, ODCTNDICT.    

D = zeros(n,L);
D(:,1) = 1/sqrt(n);
for k = 2:L
  v = cos((0:n-1)*pi*(k-1)/L)';
  v = v-mean(v);
  D(:,k) = v/norm(v);
end

Python 翻译函数

import numpy as np


def odct1dict(n, l):
    """
    1-D Overcomplete DCT dictionary.

    D = odct1dict(N, L) returns the overcomplete DCT dictionary of size NxL
    for signals of length N.

    :param n: signal size
    :type n: int
    :param l: number of atoms
    :type l: int
    :return: 1-D Overcomplete DCT dictionary NumPy array
    """

    d = np.zeros((n, l))
    d[:, 0] = 1 / np.sqrt(n)

    for k in range(1, l):
        v = np.transpose(np.cos(np.arange(0, n) * np.pi * k * l))
        v = v - np.mean(v)
        d[:, k] = v / np.linalg.norm(v)

    return d

我将 PyCharm 用作 Python IDE，并且该软件在指令 v = np.transpose(np.cos(np.arange(0, n) * np.pi * k * l)) 中发出警告，我不明白for循环，专门针对np.transpose函数的参数，np.cos(np.arange(0, n) * np.pi * k * l).

Expected type 'Union[ndarray, Iterable]', got 'int' instead less...

This inspection detects type errors in function call expressions. Due to dynamic dispatch and duck typing, this is possible in a limited but useful number of cases. Types of function parameters can be specified in docstrings or in Python 3 function annotations.

你能为我解释一下这个警告吗？以及如何纠正它？编写此类指令的正确方法是什么？

Answer 1

我猜 PyCharm 没有完全理解 numpy。它看起来和行为都像有效的 Python:

使用我的 IDE、Ipython，我可以：

In [84]: n,k,l=3, .4, 1

In [85]: v = np.transpose(np.cos(np.arange(0, n) * np.pi * k * l))

In [86]: v
Out[86]: array([ 1.        ,  0.30901699, -0.80901699])

Answer 2

这些误报在 PyCharm 中的 numpy 代码中经常发生。在 thread discussing this issue with JetBrains support 中，他们说：

Almost any code written in reasonably elegant numpy style gets drowned in warning messages.

对于您自己的函数的参数，您可以 write docstrings to let PyCharm know what type to expect。然而，对于很多 numpy 代码，这将不相关。我找到了两个解决方案：

在出现警告的行或函数之前使用行 # noinspection PyTypeChecker 抑制每行或每个函数的警告。有关抑制警告的更多详细信息，请参阅 official guide

使用type hinting as in :

transpose_arg = np.cos(np.arange(0, n) * np.pi * k * l)  # type: np.ndarray
v = np.transpose(transpose_arg)

Answer 3

追加到 buzjwa 的回答：

选项 3： 使用 mypy 进行类型检查并手动添加为 numpy 创建的第 3 方存根文件 here

您需要将此存根文件添加到您的内部 python 类型中。让我们知道您的进展情况！

Python 指令中的预期类型 'Union[ndarray, Iterable]' 警告

Expected type 'Union[ndarray, Iterable]' warning in Python instruction

python

warnings

numpy

translate

pycharm

Matlab 函数

Python 翻译函数