Pythonで、オブジェクトの型を容易に知る方法、わかりやすい命名規則

Question

Pythonのソースコードを読んでいて、わかりにくいと思うのが、
オブジェクトの型が明示されていないことです。
そのため、オブジェクトの型が何なのか知るために、
obj.__class__やobj.shapeを実行しているのですが、面倒に思っています。
他にもっと良い方法があるのか、それともPythonでの開発とはこういうものなのかが
現状よくわかっていません。

また、自分がオブジェクトを定義する際、型がひと目でわかるように
わかりやすい命名規則にしたいと思っていますが
どのようにしたらわかりやすいかで悩んでいます。

このあたり、解説や助言を頂けたら幸いです。

Answer 1

型を知る場合は puroko3さん の回答にもある通り type を使うことで調べることができます。

また、自分がオブジェクトを定義する際、型がひと目でわかるように
わかりやすい命名規則にしたいと思っていますが
どのようにしたらわかりやすいかで悩んでいます。

PythonではPEP8というオフィシャルのコーディングスタイルがあります。そちらに命名規則などの話も書いてありますので参考にしてみるのはいかがでしょうか。

• https://pep8-ja.readthedocs.io/ja/latest/

ただ PEP8 は基本的に変数名に型をつける ハンガリアン記法 のようなことは特に決められていませんので、そういったものが必要であれば別途ご自身で決める必要はあると思います。

またコーディングスタイルのチェックを行ってるくれる flake8 というツールもあるので合わせて記載いたします。

• https://flake8.readthedocs.io/en/latest/

ここからは私見ですが、ハンガリアン記法 でも システムハンガリアン と アプリケーションハンガリアン の二つの考え方がありますが、「変数名に型をつける」のは、前者のシステムハンガリアンの考え方なので、あまり個人的にはオススメしないかなという印象です。

なぜシステムハンガリアンをオススメしないかは下記URLに詳しく記載されておりますので、ご参照ください

• http://local.joelonsoftware.com/wiki/間違ったコードは間違って見えるようにする
• http://blogs.itmedia.co.jp/yohei/2008/04/post-fcac.html

また、最近のPythonでは Type Hint と呼ばれる型チェックの仕組みが導入されましたので、それを活用すると人の目の代わりにツールが自動的に型チェックを行ってくれるので多少、楽になるかもしれません。

• http://qiita.com/icoxfog417/items/c17eb042f4735b7924a3

何かの参考になれば幸いです。

Comments

[Obayashi]

詳細な解説ありがとうございました。

Answer 2

型を知る場合、type関数を使われてはどうでしょうか？

x=10
y="鉛筆"
n=1.0

class python():
    def __init__(self,name):
        self.name=name

class python2():
    def xxx(self):
        print("python2")

a=python("パイソン")
a2=python2().xxx

print(type(x))
print(type(y))
print(type(n))
print(type(python))
print(type(a))
print(type(a.name))
print(type(a2))

実行結果
<class 'int'>
<class 'str'>
<class 'float'>
<class 'type'>
<class 'main.python'>
<class 'str'>
<class 'method'>

Answer 3

isinstance(obj, (ClassA, ClassB))を使って条件分岐したり、hasattr(obj, 'method')とだけチェックして後はオブジェクトの型をあえて厳密に精査せずに使っていくダックタイピングが一般的だと思います。後はpydocで型情報をドキュメンテーションに記載してあげればPython的には良い感じです。あと名付け(命名)は型よりも目的に重きを置いて、ここでもあえて型を縛らずにゆるく処理を書いていくことが良いと思います。