プロパティのgetterの引数について

Question

Python初心者です。後学のためにブログを見漁っていたところ気になったコードがあったので質問させていただきます。

引用元: https://qiita.com/Yukimura127/items/c04e5498b82cd69d19fc

ソースコード

「実装」という節で載せてあったソースコードです。

PythonでのPriorityQueueではキューに追加したアイテム同士を数値として比較できる場合，その数値が低い方が優先度が高くなります．
この性質を利用して，intの優先度の他にキューに追加した時間もキューアイテムに保持して比較対象とします．
そうすることで，キューに追加した順番でアイテムを取得できます．

import time
from typing import Any, Tuple, Optional
from dataclasses import dataclass, field, asdict
import queue


@dataclass(order=True)
class QueueItem:
    """
    キューアイテム
    """
    priority: int
    item: Any = field(compare=False)
    occurred: float = field(default=0.0, compare=True)


class PriorityQueue(queue.PriorityQueue):
    """
    時間を加味した優先度付きキュークラス
    """

    def __init__(self, priority_name: str = "priority"):
        """
        Args:
            priority_name: 優先度の変数名
        """
        self.priority_name: str = priority_name
        super().__init__()

    @property
    def max_priority(self, priority_name: Optional[str] = None) -> int:
        """
        最大のpriorityを取得
        """
        if not self.queue:
            return 0
        priority_name = priority_name or self.priority_name
        assert hasattr(self.queue[0], priority_name)

        max_priority = max([queue_item.priority for queue_item in self.queue])
        return max_priority

    def put_item(self, **kwargs):
        """
        put override
        """
        # プライオリティ＋登録順で優先順位を決めたい
        if kwargs.get("occurred", None) is None:
            kwargs["occurred"] = time.perf_counter()

        # アイテム作成・追加
        queue_item = QueueItem(**kwargs)
        super().put(queue_item)

    def get_item(self) -> Tuple[Any, ...]:
        """
        get override
        """
        queue_item: QueueItem = super().get()
        item = tuple(asdict(queue_item).values())
        return item

質問

気になったのが30行目のプロパティ定義のコードなのですが……

@property
def max_priority(self, priority_name: Optional[str] = None) -> int:
    """
    最大のpriorityを取得
    """
    if not self.queue:
        return 0
    priority_name = priority_name or self.priority_name
    assert hasattr(self.queue[0], priority_name)

    max_priority = max([queue_item.priority for queue_item in self.queue])
    return max_priority

プロパティの getterなのにも関わらず、引数 priority_nameを持っています。
getterは self以外の引数を持たず、また引数を渡す方法もないと勉強したので何故引数が……？と混乱しています。そこで質問なのですが

• getterに引数を渡すことはできるのか
• また、渡せるとしてどのような場面で推奨されるのか

この2点をお答えいただければ幸いです。回答よろしくお願いします。

---

引用元のブログ様、無断で引用してしまい申し訳ございません。

Answer 1

getterに引数を渡すことはできるのか

できなくはないのですが、getter としての意味(意義)は薄くなるので、引数を付けるくらいなら @property デコレータを外して通常のインスタンスメソッドにすればよいのでは？と思います。

以下は Built-in Functions: class property に記載されているサンプルコードを一部改変したものです。

from typing import Optional

class Parrot:
    def __init__(self):
        self._voltage = 100000

    @property
    def voltage(self, factor: Optional[int] = 1) -> int:
        return self._voltage * factor

if __name__ == '__main__':
    p = Parrot()
    print(p.voltage)
    print(Parrot.voltage.fget(p, -1))

# =>
100000
-100000

Comments

[scarlet256]

なるほど……プロパティ.fget経由でメソッドにアクセスすれば引数を渡せるのですね！
引数の(p, -1)はそれぞれgetterに設定された関数voltageの仮引数(self, factor: Optional[int] = 1)に渡され、p._voltage * -1が返される……という感じでしょうか。selfにインスタンス名を指定して参照できるのは初めて知りました。

>getter としての意味(意義)は薄くなるので
やはり引数を渡すなら普通のメソッドとして実装したほうが良いのですね。
とても参考になりました。回答ありがとうございます！

Answer 2

getterに引数を渡すことはできます。
取り出す値を選択したり加工したり、用途はいろいろあると思いますよ。

Comments

[scarlet256]

回答ありがとうございます！getterに引数を渡すことができるのですね。差し支えなければどのように引数を渡すのか例文を書いていただけないでしょうか……調べてみてもちょっとよく分からなくて……すいません。