search

A03ki / uecbbs

@uec_bbsを支えるPythonパッケージTwissifyの管理
https://twitter.com/uec_bbs
MIT License
0 stars 0 forks source link

プロパティの命名に動詞を用いない方がいい #35

Closed A03ki closed 4 years ago

A03ki commented 4 years ago

前提

Timelineクラスのget_home_timeline_idsはプロパティである。

問題点

動詞がつくと関数っぽい。そのためget_home_timeline_ids()としたくなる。 しかしながら、get_home_timeline_idsはプロパティのため、返り値のTimelineIndexを呼び出すことになる。

TypeError: 'TimelineIndex' object is not callable

解決方法

動詞をなくしてhome_timeline_idsにする。

加えて、Attributesとしてdocstringに記述する。

Properties created with the @property decorator should be documented in the property's getter method. Example NumPy Style Python Docstrings — napoleon 0.7 documentation