python で type の設計

Question

3.7 のリリースでtypeが改善されているらしいと読んだので、ドキュメンを確認していたのですが。 自分で新しいtypeを作るときどうしたらいいのですか。

他の言語ですが、elmだたこのようなものがあります。
Elm Union types

type Answer = Yes | No

やりたいのは　 TOP か ALL　を受け取り、２００だった場合はListを返す関数の場合のtypeを自分で定義することです。

TOP = NewType('TOP', str)
ALL = NewType('ALL', str)
Depth = Union[TOP, ALL]

Contract = NewType('Contract', str)
Contracts = Union[List[Contract], None]

def get_list_contracts(depth: Depth) -> Contracts:
    """ Contract API Resources depth is TOP or ALL"""
    r = s.get(urljoin(BASEURL,
                      f'/contract-api/v1/contracts/identifiers?depth={depth}'))
    return r.json() if 200 == r.status_code else None
    .....

Comments

[quickquip]

"やりたいのは　 Yes か No　を受け取り、２００だった場合はListを返す関数の場合" と ソースに関連がないんですが、やりたいことのイメージはソースの方ですか?

[Kentaro0919]

ご指摘有難うございます。　コード自体は正しく動いているコードで　それにtypeを追加していきたいというのが希望です、ここの関数は短く、受け取っているのが２つにきまっているのですがboolではないので、その場合はどう書くのか　質問です

[quickquip]

このコードは「こんな感じのことができたらいい（けどまだ変な）」コードのイメージ」ですか? 「今こう書いてみている（けどまだ変な）コード」ですか?

[Kentaro0919]

このコードはtypeなし版は正しく動いています。　これにtype をつけるならどうすればいいのですか？　引き数の可能性は2つしかないのですが、その場合typeはそうするのですか？　boolは根拠もなく、違和感があるのです、bool が良いんですか？

自分で書いてみたんですけど、他の人が読むと変ですか？　

type　に価値を感じるのですが、どうか書いたらいいのかよく分かっていません。

[quickquip]

動いているコードはまったくtypeヒントがついてない（つまりこのコードからtypeヒントを全部取っ払った）状態なんでしょうか。元は、strを引数にとって、strのリストかNoneを返す、という関数なんですね。

[Kentaro0919]

はい　それが現状です。それでも動いているんですけど、渡すのはDepthのうちどちらか、返しているのは　str のリストじゃなくて　意味のわかる　Contracts　 にして可読性をあげられればと思っています

Answer 1

これでどうでしょう。

from typing import NewType


Answer = NewType("Answer", bool)
Yes, No = Answer(True), Answer(False)


def test(ans: Answer):
    pass


test(Yes)
test(No)
test(True)
test(False)
test(1)
test(0)
test(None)
test("Yes")

mypy結果

test.py:14: error: Argument 1 to "test" has incompatible type "bool"; expected "Answer"
test.py:15: error: Argument 1 to "test" has incompatible type "bool"; expected "Answer"
test.py:16: error: Argument 1 to "test" has incompatible type "int"; expected "Answer"
test.py:17: error: Argument 1 to "test" has incompatible type "int"; expected "Answer"
test.py:18: error: Argument 1 to "test" has incompatible type "None"; expected "Answer"
test.py:19: error: Argument 1 to "test" has incompatible type "str"; expected "Answer"

個人的な感想

test(True)やtest(False)もmypyを通らないのはちょっと意外でした。

Comments

[Kentaro0919]

この場合要素が2つだから　それでもいけるのかと思ったんですけど、じゃあ要素が3つ以上になったら？　そもそもBoolは違うのかと思ったんですよね

むしろ　こうなんですねか

Depth = NewType("Depth", str)
TOP, ALL = Depth("TOP"), Depth("ALL")

[YouheiSakurai]

非対称だったり3つ以上だったりするんだったらenumでいいんじゃないですか？

Answer 2

Elmでのtype Answer = Yes | NoはAnswerが型で、YesとNoがコンストラクタですが、
PythonでAnswer = Union[Yes, No]と書いたら、AnswerもYesもNoも全部型で、値は別に必要です。

def_type.py

from typing import List, NewType, Union

Top = NewType('Top', str)  # これは型
All = NewType('All', str)

Depth = Union[Top, All]

TOP = Top('TOP')  # これはインスタンス
ALL = All('ALL')

Contract = NewType('Contract', str)
Contracts = Union[List[Contract], None]


def get_list_contracts(depth: Depth) -> Contracts:
    return [Contract(f'/contract-api/v1/contracts/identifiers?depth={depth}')]

と定義して

from def_type import ALL, TOP, get_list_contracts

get_list_contracts(TOP)

get_list_contracts(ALL)

# mypyやPyCharmで警告がでる（がもちろん実行できる!!)
get_list_contracts('ALL')

とするのがいいのでは。

---

もっとも

from typing import List, NewType, Union

Depth = NewType('Depth', str)  # これは型

TOP = Depth('TOP')  # これはインスタンス
ALL = Depth('ALL')

Contract = NewType('Contract', str)
Contracts = Union[List[Contract], None]


def get_list_contracts(depth: Depth) -> Contracts:
    return [Contract(f'/contract-api/v1/contracts/identifiers?depth={depth}')]

で十分でしょ、と思います。

---

私は、strを渡すと実行時エラーが出る分Enumの方が好ましく思いますが。

def_enum.py

from enum import Enum
from typing import List, NewType, Union


class Depth(Enum):
    Top = 'TOP'
    All = 'ALL'


Contract = NewType('Contract', str)
Contracts = Union[List[Contract], None]


def get_list_contracts(depth: Depth) -> Contracts:
    return [Contract(f'/contract-api/v1/contracts/identifiers?depth={depth.value}')]

と定義して

from def_enum import get_list_contracts, Depth


get_list_contracts(Depth.Top)

get_list_contracts(Depth.All)

# mypyやPyCharmで警告がでて、実行時エラーにもなる
get_list_contracts('ALL')

Comments

[Kentaro0919]

quiquiさん　腑に落ちました、enumもとってもメリットがありそうですね。　有難うございます。

Answer 3

やりたいことは特別な型を使わずとも Enum で解決すると思うのですが…。

Comments

[Kentaro0919]

type　を使って　バグが他のところで入り込むのを阻止したいので　その回答ではあまり意味がないようです

サンプルのコードはタイプをぬいて普通に動いているのですが　引数を間違えたりを阻止したいと思っています

[mather]

意味がない、と感じるなら無視していただいていいのですが、Pythonでは型ヒントのみなので実行時には型の情報は役に立たないのでお気をつけください。

[Kentaro0919]

表現が拙くて嫌な思いをさせてすみません。

from enum import Enum

Depth = Enum('Depth', 'TOP ALL')

確かにこれでもmypyは満足するようで、何も言われないようです。

[mather]

いえ、なぜかはわかりませんが、Enumをすごく誤解してます。これは型ヒントではありません。

https://docs.python.org/ja/3/library/enum.html#module-enum

from enum import Enum, auto
class Depth(Enum):
TOP = auto()
ALL = auto()

Depth.TOP
Depth.ALL

使い方はよく調べてみてください。