クラスを書くのをやめる

オブジェクトがクラスであってはならないという兆候-オブジェクトが2つしかなく、そのうちの1つが初期化__init__である場合。 これを見るたびに、「おそらく1つの関数が必要なだけだ」と考えてください。



記述されたクラスからインスタンスを1つだけ作成し、それを1回だけ使用し、すぐに破棄するたびに、次のことを考える必要があります。 簡単に、もっと簡単にできます！」



Python言語の主要な開発者の1人であるJack Didrichによるレポートの翻訳。 レポートは 2012年3月9日にPyCon USカンファレンスで配信されました。



皆さんは、おそらく何度もZen Pythonを読んだことがあります。 以下にいくつかのポイントを示します。

• 単純なものは複雑なものよりも優れている
• ネスティングよりフラットの方が良い
• 読みやすさが重要です
• プログラムを説明するのが難しい場合、それは悪いです
• プログラムの説明が簡単な場合は、おそらく良いでしょう

このテキストはティムピーターズによって書かれました。 彼はあなたと私より賢い。 ソートアルゴリズムの名前を知っている人は何人いますか？ こちらがZen Pythonを書いた人です。 そして、すべてのポイントはこう読みます。「難しいことをしないでください。 まさにそれを行う。」これが議論されるものです。



だから、まず第一に、それを難し​​くしないでください。 クラスは非常に複雑であるか、非常に複雑な場合があります。 しかし、私たちはそれをさらに困難にしています。 したがって、このレポートでは、少しのコードを読み、間違った方向に進んでいることに気付く方法と、戻る方法を学びます。



私の職場では、同僚に次のように伝えています。「私はコードが嫌いです。製品ではできるだけ小さくしたいのです。」私たちはコードではなく機能を販売しています。 私たちの顧客はコードのためではなく、幅広い機能のためです。 コードが削除されるたびに、それは良いことです。 私たちは4人で、昨年は製品の行数のカウントを停止しましたが、新しい機能を導入し続けています。

クラス

このレポートから、最初にこのコードを覚えておく必要があります。 これは、自然界で見られる最大のクラス乱用です。

class Greeting(object): def __init__(self, word='Hello'): self.word = word def greet(self, name): return '%s, %s!' % (self.word, name) >>> greeting = Greeting('Hola') >>> greeting.greet('Jorge') Hola, Jorge!
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

クラスのように見えますが、これはクラスではありません。 名前は名詞、「あいさつ」です。 引数を取り、__ init__に保存します。 はい、クラスのように見えます。 彼には、オブジェクトの状態を読み取り、クラスのように他のことを行うメソッドがあります。 以下に、このクラスの使用方法を示します。Greetingsのインスタンスを作成してから、このGreetingsを使用して他のことを行います。



しかし、これはクラスではないか、クラスであってはなりません。 この兆候は、メソッドが2つしかないことであり、そのうちの1つは初期化__init__です。 これを見るたびに、「おそらく1つの関数が必要なだけだ」と考えてください。



記述されたクラスからインスタンスを1つだけ作成し、それを1回だけ使用し、すぐに破棄するたびに、次のことを考える必要があります。 簡単に、もっと簡単にできます！」

 def greet(name): ob = Greeting('') print ob.greet(name) return
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この関数は4行のコードで構成されています。 そして、次の2行で同じことができます。

 def greet(greeting, name): return '%s, %s!' % (greeting, name) import functools greet = functools.partial(greet, '') greet('')
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

常に同じ最初の引数で関数を呼び出す場合、標準ライブラリにはツールがあります！ functools.partial。 上記のコードを見てください：引数を追加すると、結果を複数回呼び出すことができます。



ITの学位を持っている人がどれだけいるのかわかりません。 私は次のような概念を教えました



-権力の分離

-コード接続の削減

-カプセル化

-販売の分離



卒業して以来、これらの用語を15年間使用していません。 これらの言葉を聞いて、あなたはだまされています。 これらの用語自体は必要ありません。 それらが使用される場合、人々は会話を妨害するだけの完全に異なるものを意味します。

例：パンツターン...

あなたの多くは、日常業務でサードパーティのライブラリを使用しています。 他の人のコードを使用する必要があるたびに、最初にすることはそれを読むことです。 結局のところ、そこにどのような品質があるか、テストなどがあるかどうかは不明です。 電源を入れる前にコードを確認する必要があります。 コードを読むのが難しい場合があります。



サードパーティのAPIライブラリ、それをShaurMailと呼びましょう。1つのパッケージ、22のモジュール、20のクラス、660行のコードが含まれています。 製品に含める前に、これらすべてを読む必要がありました。 しかし、それは彼らの公式APIであったため、それを使用しました 。 APIの更新が来るたびに、差分を確認する必要がありました。何が変更されたのかわからなかったためです。 パッチを送信しました-アップデートに表示されましたか？



660行のコード、20クラスは、プログラムが電子メールアドレスのリスト、手紙のテキストを提供し、配信されなかった手紙と購読解除した人を見つけるだけでよい場合、少し多くなります。



クラス虐待とは何ですか？ 多くの場合、人々は将来、何かが必要になると考えます。 必要なときにすべてを書きます。 ShaurMailライブラリにはShaurHashモジュールがあり、次の2行のコードが含まれます。

 class ShaurHash(dict): pass
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

誰かが辞書のアドオンが後で必要になると決めました。 必要ではありませんでしたが、コードのどこにでも最初の行がありました。

 my_hash = ShaurMail.ShaurHash.ShaurHash(id='cat') d = dict(id='cat') d = {'id': 'cat'}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コードの2行目と3行目-誰も説明する必要はありません。 しかし、そこでは、このマントラ「ShaurMail-ShaurHash-ShaurHash」がどこでも繰り返されました。 「Shaur」という単語の3回の繰り返しは、過剰の別の兆候です。 繰り返しからすべての害まで。 ユーザーに「Shaur」を3回書くように強制することでユーザーを困らせます。 （これは実際の会社名ではなく、架空のものです。）



それから彼らはこの男を解雇し、彼が何をしているかを知っている人を雇った。 APIの2番目のバージョンは次のとおりです。

 class API: def __init__(self, key): self.header = dict(apikey=key) def call(self, method, params): request = urllib2.Request( self.url + method[0] + '/' + method[1], urllib.urlencode(params), self.header ) try: response = json.loads(urllib2.urlopen(request).read()) return response except urllib2.HTTPError as error: return dict(Error=str(error))
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコードには660行、このコードには15行があります。このコードが行うことはすべて、標準ライブラリのメソッドを使用しています。 数秒で簡単に全体を読むことができ、何をしているのかすぐに理解できます。 ちなみに、20行のテストもありました。 書き方は次のとおりです。 彼らがAPIを更新したとき、私は文字通り数秒で変更を読むことができました。



しかし、ここで問題に気づくことができます。 クラスには2つのメソッドがあり、そのうちの1つは__init__です。 著者はこれを隠しませんでした。 2番目の方法は、呼び出し、「呼び出し」です。 このAPIの使用方法は次のとおりです。

 ShaurMail.API(key=' ').call(('mailing', 'statistics'), {'id': 1})
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

行が長いため、エイリアスを作成して何度も呼び出します。

 ShaurMail.request = ShaurMail.API(key=' ').call ShaurMail.request(('mailing', 'statistics'), {'id': 1})
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このクラスを関数として使用していることに注意してください。 それがあるはずです。 これが表示された場合、ここではクラスが必要ないことを知ってください。 そこで、私は彼らにAPIの3番目のバージョンを送信しました。

 ShaurMail_API = url = 'https://api.shaurmail.com/%s/%s' ShaurMail_API_KEY = ' ' def request(noun, verb, **params): headers = {'apikey': ShaurMail_API_KEY} request = urllib2.Request(ShaurMail_API % (noun, verb), urllib.urlencode(params), headers) return json.loads(urllib2.urlopen(request).read())
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

使用するモジュールにファイルを挿入したため、プロジェクトにファイルを作成しません。 15文字列APIが実行したすべての処理と、660文字列APIが実行したすべての処理を実行します。



これが私たちが始めた場所であり、私たちが来た目的です：

• 1パッケージ+ 20モジュール=> 1モジュール
• 20クラス=> 1クラス=> 0クラス
• 130メソッド=> 2メソッド=> 1関数
• コード660行=> 15行=> 5行

使いやすく、書きやすく、何が起こっているのかを理解する必要はありません。

標準ライブラリ

Java言語から来た人は誰でも、分類に名前空間が必要であると考えるかもしれません。 これは真実ではありません。 名前の一致を防ぐために必要です。 スペースの深い階層がある場合、誰にも何も提供しません。 ShaurMail.ShaurHash.ShaurHashは、人々が覚えて書く必要がある単なる追加の単語です。



Python標準ライブラリでは、モジュールの名前を覚えているか、ドキュメントを参照する必要があるため、名前空間は非常に浅くなっています。 チェーン、検索するパッケージ、そのパッケージ、次のパッケージ、およびその中のモジュールの名前を把握する必要がある場合は、何も良いことはありません。 モジュールの名前を知る必要があるだけです。



残念なことに、ここにコードの例を示します。同じ罪がここにあります。

 services.crawler.crawlerexceptions.ArticleNotFoundException
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2行のモジュール、例外クラス、および「パス」があるパッケージ。 この例外を使用するには、「クローラー」を2回、「例外」という単語の2倍記述する必要があります。 ArticleNotFoundExceptionという名前は繰り返されます。 そうしないでください。 例外を呼び出す場合は、EmptyBeer、BeerError、BeerNotFoundにしますが、BeerNotFoundErrorはすでにたくさんあります。



標準ライブラリの例外を単純に使用できます。 それらは誰にでも明らかです。 特定の状態をキャッチする必要がない限り、LookupErrorは問題ありません。 あなたがメールでたわごとを受け取った場合、あなたはそれをまだ読まなければならないので、例外が何と呼ばれるかは関係ありません。



さらに、コード内の例外は通常、raiseおよびexceptの後にあり、誰もがこれらが例外であることをすぐに理解します。 したがって、名前に「例外」を追加する必要はありません。



Python標準ライブラリにも錆びた部分がありますが、コード編成の非常に良い例です。

• 200,000行のコード
• 200の最上位モジュール
• パッケージごとに平均10ファイル
• 165例外

パッケージ内の10個のファイルは大量ですが、これはライブラリに追加されたいくつかのサードパーティプロジェクトが原因で、2つのファイルのみのパッケージがありました。 新しい例外を作成することにした場合、標準ライブラリは1200行のコードに対して1つの例外を要するため、よく考えてください。



私は原則としてクラスに反対ではありません。 クラスが必要です-変化するデータと関連する関数がたくさんあるとき。 ただし、これは日常業務ではまれにしか発生しません。 標準ライブラリを定期的に使用する必要があり、すでに適切なクラスがあります。 それらはすでにあなたのために書かれています。



Pythonライブラリの唯一の例外はheapqモジュールです。 ヒープキュー、ヒープキューは、常にソートされる配列です。 heapqモジュールには多数のメソッドがあり、それらはすべて同じヒープで動作します。 最初の引数は常に同じままです。つまり、クラスは本当にそれを頼みます。

 heapify(data) pushleft(data, item) popleft(data) pushright(data, item) popright(data)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

など



heapqを使用する必要があるたびに、このクラスの実装をツールキットから取得します。

 class Heap(object): def __init__(self, data=None, key=lambda x: None): self.heap = data or [] heapq.heapify(self.heap) self.key = key def pushleft(self, item): if self.key: item = (self.key(item), item) heapq.pushleft(self.heap, item) def popleft(self): return heapq.popleft(self.heap)[1]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

クラスは雑草のように成長する

PythonのOAuthステータスは重要ではありません。 繰り返しますが、サードパーティのライブラリがあり、プロジェクトで使用する前に、それらを読む必要があります。



GoogleのURLレデューサーを使用しようとしました。URLを取得して短縮する必要がありました。 Googleには、10,000行のコードを含むプロジェクトがあります。 115モジュールと207クラス。 Google +でre責を書きましたが、 それを見た人はほとんどいませんでした。Guido（Van Rossum-およそPer。）はコメントしました：「私はGoogleのAPIコードに責任を負います。」10,000行のコード- -ShaurMaleのようなもの。 たとえば、ここには、他のクラスが継承するFlowクラスがあります。

 class Flow(object): pass class Storage(object): def put(self, data): _abstract() def get(self): _abstract() def _abstract(): raise NotImplementedError
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

彼は空です。 しかし、彼には独自のモジュールがあり、それを継承するクラスを読み取るたびに、外出し、そのファイルをチェックし、そのクラスが空であることを確認する必要があります。 誰かが未来を見つめ、「今から3行のコードを書くので、将来これらの3行が変わらないようにする」と決めました。そして、彼のライブラリを読むすべての人から時間をかけました。 Storageクラスもあり、ほとんど何もしません。 標準の例外を使用してエラーを正しく処理しますが、エイリアスを使用するため、コードを読んで動作を確認する必要があります。



OAuth2を実装するのに1週間かかりました。 1万行のコードを読むのに数日かかりました。その後、他のライブラリを探し始めました。 python-oauth2が見つかりました。 これはpython-oauthの2番目のバージョンですが、OAuth2の操作方法が実際にはわかりません。 ただし、このライブラリはGoogleよりわずかに優れています：540行と15クラスのみです。



さらに簡単に書き直して、 python-foauth2と呼びました 。 135行のコードと3つのクラス、そしてそれはまだたくさんあります。私はそれを十分にリファクタリングしませんでした。 これら3つのクラスの1つを次に示します。

 class Error(Exception): pass
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

恥！

人生

最後の例。 ConwayのLifeゲームは 、名前がわからなくても見たことある人はすべています。 市松模様のフィールドがあり、あなたが考える各動きは各セルに隣接しており、それらに応じて、それは生きているか死んでいるでしょう。 そして、グライダーのような美しい安定したパターンが得られます。細胞は前で生き返り、後ろで死に、グライダーはフィールドを横切って飛んでいるようです。



ゲームの「ライフ」は非常にシンプルです。フィールドといくつかのルールです。 インタビューでこのタスクを依頼します。これを行う方法がわからない場合は、何も話すことができません。 多くの人はすぐに、「細胞は名詞です。 クラスが必要です。「このクラスのプロパティは何ですか？ 場所、生きているかどうか、次のターンの状態、すべて？ まだ隣人がいます。 次に、フィールドの説明を開始します。 フィールドは多数のセルであるため、グリッドであり、内部のセルをカウントする「カウント」メソッドがあります。

 class Cell(object): def __init__(self, x, y, alive=True): self.x = x self.y = y self.alive = alive self.next = None def neigbors(self): for i, j in itertools.product(range(-1, 2), repeat=2): if (i, j) != (0, 0): yield (self.x + i, self.y + j) class Board(object): def __init__(self): self.cells = {} # { (x, y): Cell() } def advance(self): for (x, y), cell in self.cells.items(): alive_neighbors = len(cell.neighbors) cell.next = (alive_neighbors == 3 or (alive_neighbors == 2 and cell.alive))
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この時点で、「stop」と言う必要があります。Fieldクラスがあり、その中に__init__と「make a move」の2つのメソッドがあります。 その中に1つのプロパティがあります-辞書です。これは、辞書を操作する必要があることを意味します。 ポイントの近傍を保存する必要はないことに注意してください、それらは既に辞書にあります。 生きているかどうかは単なるブール値であるため、生きている細胞の座標のみを保存します。 また、辞書にはTrueのみが格納されているため、辞書は必要なく、単に座標のセットが必要です。 最後に、新しい状態は必要ありません。生細胞のリストを簡単に再作成できます。

 def neigbors(point): x, y = point for i, j in itertools.product(range(-1, 2), repeat=2): if any((i, j)): yield (x + i, y + j) def advance(board): newstate = set() recalc = board | set(itertools.chain(*map(neighbors, board))) for point in recalc: count = sum((neigh in board) for neigh in neighbors(point)) if count == 3 or (count == 2 and point in board): newstate.add(point) return newstate glider = set([(0, 0), (1, 0), (2, 0), (0, 1), (1, 2)]) for i in range(1000): glider = advance(glider) print glider
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ゲームの非常にシンプルで簡潔な実装が判明しました。 ここでは2つのクラスは必要ありません。 下-グライダーの座標、フィールドに挿入され、グライダーが飛行します。 それだけです これは、ゲーム「ライフ」の完全な実装です。

まとめ

1. __init__を含む2つのメソッドを持つクラスが表示される場合、これはクラスではありません。

2.必要でない場合（および不要な場合）、新しい例外を作成しないでください。

3.簡素化します。



翻訳者から：コメントでは、多くの人がこのレポートをPLOの完全な否定だと認識していることがわかりました。 これは間違いです。 結果のポイント1は、これがクラスではないことを明確に示しています。 クラスが必要ですが、レポートの本質は、クラスが乱用されるべきではないということです。