型ヒントTypingで、「str以外のSequence」を表す型がないか知りたい

Question

前提・実現したいこと

タイトルの通りです。
Pythonの型ヒントを利用したいと考えています。
「list, tuple, numpy.ndarray」の中にstrが含まれている型、を表現する方法が存在するのか知りたいと考えています。

イメージとしては、typing.Sequence[str]なのですが、
pycharmの型チェックでは、strを許容してしまいます。
（strがsequenceであると同時に、その成分一つ一つもstr型であるからだと認識しています。）

なにか良案がありましたらご教示いただけますと幸いです。
どうぞよろしくお願いいたします。

Comments

[nico25]

自分もそのように思います。

> （strがsequenceであると同時に、その成分一つ一つもstr型であるからだと認識しています。）

```python
s = 'Hello, world!'
assert type(s[0]) is str
assert type(s[0][0]) is str
assert type(s[0][0][0]) is str
```

typing.Sequence[str] で str を **除外** したいということだと思うのですが、
Union を使って Sequence を繋ぎ合わせるしかなさそうです...

```python
# このような具合で
from typing import Union, Sequence, List, Tuple
var: Union[Sequence[List], Sequence[Tuple]]
```

既に調べられているかもしれませんが、１ヶ月前の Stackoverflow に
似たような質問が上がってました。

> Python type hinting can't exclude types.
> You can't exclude Nones, strs or any another type.
>
> The only thing you can use to try to emulate None exclusion
> is to use Union and write every type you are actually using in the dictionary.
>
> https://stackoverflow.com/questions/57854871/exclude-type-in-python-typing-annotation

[nikori]

コメントありがとうございます。

除外ができないこと、Unionで結合ができることは把握しておりましたが、
型ヒントの利用上、「numpyのマニュアルでいうところのarray_likeな型」ならばなんでもよい、という状況は多いかと思ったので、標準で実現されていないか気になったという次第です。

ありがとうございました。

[nico25]

いえいえ、お役に立てず口惜しい限りです :)

[nikori]

いえ！ご丁寧にありがとうございました！

Answer 1

numpy.ndarrayを除くと、

SequenceNotStr = Union[List[str], Tuple[str, ...]]

で済みそうです。

#!/usr/bin/env python
from typing import List, Tuple, Union

SequenceNotStr = Union[List[str], Tuple[str, ...]]


def a(foo: SequenceNotStr):
    return len(foo)


if __name__ == '__main__':
    a([1, 2, 3])  # 12
    a(['a', 'b'])
    a((1, 2, 3))  # 14
    a(('a', 'b'))
    a("abc")  # 16
    a(list("abc"))

結果

% mypy seq_typing.py
seq_typing.py:12: error: List item 0 has incompatible type "int"; expected "str"
seq_typing.py:12: error: List item 1 has incompatible type "int"; expected "str"
seq_typing.py:12: error: List item 2 has incompatible type "int"; expected "str"
seq_typing.py:14: error: Argument 1 to "a" has incompatible type "Tuple[int, int, int]"; expected "Union[List[str], Tuple[str, ...]]"
seq_typing.py:16: error: Argument 1 to "a" has incompatible type "str"; expected "Union[List[str], Tuple[str, ...]]"
Found 5 errors in 1 file (checked 1 source file)

---

参考
https://github.com/python/cpython/blob/v3.7.5/Lib/_collections_abc.py#L926
https://github.com/python/cpython/blob/v3.7.5/Lib/_collections_abc.py#L1010

Comments

[nikori]

ご回答ありがとうございます。

参考としていただいたソースコードを読んだのですが、
あるクラスが抽象基底クラスに属するかどうかは、実装レベルの段階からリストアップ形式なのですね。

また、サンプルコードもありがとうございます。
数値計算の文脈で利用したいため、numpy.ndarrayが含まれていてほしいのですが、
標準の型ではないため難しそうですね...。

ご教授いただきました内容で、かなり問題の見通しがよくなり、
numpy.ndarrayをジェネリック化したNDArrayを定義し、Union[List[str], Tuple[str], NDArray[str,...]]などとすれば私の実施したいことが実現できるのかもしれないと思いました。

現状上手くいっていないのですが、研究してみようと思います。
取り急ぎお礼申し上げます。ありがとうございました！