クラスのユーザーに、その属性の1つの予想されるタイプを説明する方法を教えてください。

Question

私は、その属性の1つがニューラルネットワークを表すと思われるPythonでクラスを開発しています。私はこの属性を実際に別のクラスのインスタンスにしたいと思います。NNという名前のメソッドをいくつか用意しています（例えば、train()、予測のためにpredict()など）。さらに、私はこの属性を初期化する合理的な方法は、引数の1つとしてNNクラスのインスタンスを期待するクラスのコンストラクタを使用することだと考えました。

これを解決する方法について私が最初に考えたのは、インターフェイスを実装し、ユーザーがクラスコンストラクタに提供するものを何でもチェックして、それが期待されるNNクラスのものであることを確認することでした。しかし、どちらのインターフェース（1）も型チェック（2,、4、5）もPythonの優れた方法ではないようです。

代わりにDuck typingを使用し、オブジェクトメソッドを使用できない（実行時の型チェックを延期する）まで試してみることにします。しかし、私の場合、NNクラスは、いくつかのメソッドと属性を使って、かなり複雑になるかもしれません。私がインターフェースのアイデアを破棄して、クラスのユーザーがオブジェクトに必要なメソッドと属性をすべて提供することを期待している場合、このオブジェクトに対してどのようなことが予想されますか？この情報をクラスdocstring、コンストラクタdocstring、または他の場所に記述する必要がありますか？あるいは、このシナリオを解決する良い方法がありますか？

Answer 1

Python 3.5では、type hintsを使用できます。これにより、予想されるタイプがユーザに記録され、オプションのオフラインタイプのチェックが可能になります。

Answer 2

私は__init__と言います。docstringは、NNオブジェクトが提供される場所なので、入れたい場所です。

何かのように：

""" 
(...) 
:param NN: an object supporting run(), train() and validate() methods 
(...) 
""" 

ここでの利点は、あなたが引数として何を供給することができるということです - 地獄、あなたもクラスが、関数、または変更されたインスタンスではありませんNN引数を書くことができますあなたが正しく動作するものを提供している限り、あなたのニューラルネットワークとしてが動作します。