Pythonでのコーディングに関するGoogleのヒント。 パート1：プログラミングのヒント

定義

PyCheckerは、Pythonプログラムのソースコードのバグを見つけるためのツールです。 彼は、CやC ++などのあまり動的ではない言語のコンパイラーによって識別される問題を見つけます。 これは非常に魅力的です。 Pythonの動的な性質により、一部の警告は公平ではないかもしれませんが、誤った警告が頻繁に発生することはありません。

長所

型エラーなど、検出しにくいエラーをキャッチし、変数を宣言する前に使用します。

短所

PyCheckerは完璧ではありません。 すべての利点を得るために必要なもの：

• 彼に目を向けて書く
• 彼の警告を抑制する
• バグ修正
• またはそれらを無視します

解決策

必ずコードでPyCheckerを実行してください。 PyCheckerの起動方法を学ぶには、そのホームページをご覧ください 。 警告を抑制するには、このモジュールで__pychecker__変数を作成し、どのエラーを抑制する必要があるかを示す必要があります。 例：

__pychecker__ = 'no-callinit no-classattr' 

この方法で警告を抑制することには、次の計画の利点があります。抑制を簡単に検索して、それらに戻ることができます。 次のように入力して、PyCheckerの警告のリストを表示できます。

 pychecker -- help 

未使用の引数は、未使用の引数の名前として「_」を使用するか、引数「unused_」のプレフィックスとして使用して省略できます。 引数名を変更できない状況では、関数の冒頭でそれらに言及することができます。 例：

 def foo(a, unused_b, unused_c, d=None, e=None): _ = d, e return a 

理想的には、「未使用の広告」が実際にそれらであると自信を持って述べることができるように、PyCheckerが改良されます。

定義

モジュール間でオープンソースコードを再利用するためのメカニズム。

長所

名前空間の規則は非常に単純です。 コード内の各オブジェクトの場所は、単一の方法で示されます。 x.Objは、オブジェクトObjがモジュールxで宣言されていると言います。

短所

モジュール名が競合する場合があります。 一部のモジュール名は不快なほど長い場合があります。

解決策

import xを使用して、パッケージとモジュールをインポートします。
xがパッケージプレフィックスで、 yがプレフィックスなしのモジュール名である場合、from x import yを使用します。
2つのモジュールの名前がyの場合、またはモジュール名が不快なほど長い場合は、 from x import yをzとして使用します。
たとえば、sound.effects.echoモジュールは次のようにインポートできます。

 from sound.effects import echo ... echo.EchoFilter(input, output, delay=0.7, atten=4) 

モジュールが同じパッケージにある場合でも、インポートで相対名を使用しないでください。 完全なパッケージ名のみを使用してください。 これにより、同じパッケージが2回インポートされる状況を防ぐことができます。

長所

モジュール名の競合は回避されます。 ディスク上のモジュールを見つけるのが簡単になっています。

短所

コードを移植するのが難しくなります モジュールの完全な階層を完全に再作成する必要があります。

解決策

新しいコードはすべて、パッケージ内のフルパスで各モジュールをインポートする必要があります。
インポートは次のようになります。

 #       import sound.effects.echo #        () from sound.effects import echo 

定義

例外は、コードブロックの通常の制御フローを終了して、エラーまたはその他の例外条件を処理する手段です。

長所

通常のコードの制御フローは、エラートラップコードと混ざり合いません。 また、特定の条件が満たされると、スレッドは特定のフレーム数をスキップできます。たとえば、複数のエラーコード処理の代わりに、Nネストされた関数から1ステップで戻ります。

短所

制御フローが誤って実行される可能性があります。 ライブラリから関数を呼び出すときにエラーが発生する状況をスキップするのは非常に簡単です。

解決策

例外処理は次の位置に従う必要があります。

• このように例外を発生させます： MyException（ 'エラーメッセージ'） を発生させるか、MyExceptionを発生させます。 2つの引数を持つ書き込みフォームを使用しないでください（ MyException、 'Error message'を発生させます ）。また、書き込みの文字列フォームを使用しません（ 'Error message'を発生させます ）。
• モジュール（またはパッケージ）は、独自のオブジェクト指向の例外クラスを定義する必要があり、組み込みの例外クラスから継承する必要があります。
  モジュールの主な例外はエラーと呼ばれるべきです。
  
  

   class Error(Exception): pass 

  
  
• 後で過度に興奮させない場合、またはスレッドの外部コードブロックにいない場合（およびエラーメッセージが出力される場合）にのみ、すべての例外をキャッチする例外を使用しないでください。 この点でPytnonは非常に寛容です。さらに、名前付けエラー、 sys.exit（）の呼び出し、 Ctrl + Cの中断、テストの失敗、および単にキャッチしたくないさまざまな種類の例外をキャッチできます。
• try / exceptブロックのコードの量を減らします。 tryブロックの本体が大きいほど、例外がスローされるとは思わないコード行で例外が発生する可能性が高くなります。 これらの場合、 try / exceptブロックは実際のエラーを隠します。
• finallyブロックをスライドして、 tryブロックで例外がスローされたかどうかに関係なくコードを実行します。 これは、ファイルを閉じるなどの最終アクションに役立つことがよくあります。
• 例外をキャッチするときは、コンマよりもasを使用することをお勧めします。
  
  

   try: raise Error except Error as error: pass 

  
  

定義

モジュールレベルで定義されている変数。

長所

時々役立つ。

短所

次のように、インポート中にモジュールの動作を誤って変更する可能性があります モジュールレベル変数の割り当ては、モジュールのインポート時に既に完了しています。

解決策

クラス変数を優先してグローバル変数を使用しないでください。 以下のいくつかの例外：

• 標準スクリプト設定。
• モジュールレベルの定数。 たとえば、 PI = 3.14159です。 定数には、大文字とアンダースコアのみを使用して名前を付ける必要があります。 以下の命名規則を参照してください。
• グローバル変数を使用して、関数に必要な値または関数によって返された値をキャッシュすると便利な場合があります。
• 必要に応じて、モジュール内にグローバル変数を作成し、パブリックモジュールレベルの関数からアクセスできるようにする必要があります。 以下の命名規則を参照してください。

定義

クラスは、メソッド、関数、または別のクラス内で定義できます。 関数は、メソッドまたは他の関数内で定義できます。 入れ子関数には、親領域で定義された変数への読み取り専用アクセスがあります。

長所

非常に限られたスペース内でのみ使用される補助クラスおよび関数を定義できます。 ADTの原則に準拠しています。

短所

ネストされたクラスまたはローカルクラスのインスタンスはシリアル化できません。

解決策

彼らは良いです。

定義

リストジェネレーターと式ジェネレーターは、 map（） 、 filter（）、またはlambda式に頼らずに、リストとイテレーターを作成するためのコンパクトで効率的な方法を提供します。

長所

単純なリストジェネレーターは、リストを作成する他の方法よりも簡潔でシンプルです。 式ジェネレータは非常に効率的です リスト全体が一度に作成されるわけではありません。

短所

複雑なリストジェネレーターまたは式ジェネレーターは読みにくい場合があります。

解決策

簡単な場合に使用できます。 各パーツは1行に配置する必要があります。 ステートメント、条件式の定義を表示します。 複数のforステートメントまたは条件は無効です。 式が複雑すぎる場合は、ループを使用します。

良い：

  result = [] for x in range(10): for y in range(5): if x * y > 10: result.append((x, y)) for x in xrange(5): for y in xrange(5): if x != y: for z in xrange(5): if y != z: yield (x, y, z) return ((x, complicated_transform(x)) for x in long_generator_function(parameter) if x is not None) squares = [x * x for x in range(10)] eat(jelly_bean for jelly_bean in jelly_beans if jelly_bean.color == 'black') 

悪い：

  result = [(x, y) for x in range(10) for y in range(5) if x * y > 10] return ((x, y, z) for x in xrange(5) for y in xrange(5) if x != y for z in xrange(5) if y != z) 

定義

辞書やリストなどのコンテナタイプは、標準イテレータ、テストオペレータのセットを定義します。

長所

標準のイテレータと演算子はシンプルで効率的です。 内部の再呼び出しなしで、操作を直接表現します。 そして、標準演算子を使用する関数は簡単です。 この操作をサポートするさまざまなタイプで使用できます。

短所

メソッドの名前でオブジェクトのタイプに名前を付けることはできません（たとえば、 has_key（）は、それが辞書であることを意味します）。 これも利点です。

解決策

リスト、辞書、ファイルなど、それらをサポートする型には標準のイテレータと演算子を使用します。 組み込み型もイテレータメソッドを定義します。 繰り返し中にコンテナ自体を変更する場合を除き、リストを返すメソッドよりもこれらのメソッドを優先してください。

良い：

  for key in adict: ... if key not in adict: ... if obj in alist: ... for line in afile: ... for k, v in dict.iteritems(): ... 

悪い：

  for key in adict.keys(): ... if not adict.has_key(key): ... for line in afile.readlines(): ... 

定義

ジェネレーター関数は、 yieldステートメントを実行するたびに値を生成する反復子を返します。 値が生成されると、次の値が必要になるまで関数の実行状態が一時停止されます。

長所

コードを次のように単純化します ローカル変数と制御フローの状態は、呼び出しごとに同じままです。 ジェネレータは、値のリストを一度に作成する関数よりも少ないメモリで済みます。

短所

短所はありません。

解決策

素晴らしい。 ジェネレーター関数のドキュメント行では、「Returns：」ではなく「Generates：」を優先してください。

定義

Lambda関数は、正規関数の構築の代替として、式で匿名関数を定義します。 これらは、 map（）やfilter（）などの高階関数のコールバック関数または演算子を宣言するためによく使用されます。

長所

便利に。

短所

ローカル関数よりも読み取りとデバッグが困難です。 名前がないと、コールスタックが読みにくくなります。 表現力は制限されています 関数には1つの式のみを含めることができます。

解決策

インライン式に適しています。 ラムダ関数内のコードが60〜80文字より長い場合、この関数を通常の（またはネストされた）関数として定義する方が適切な場合があります。 乗算などの単純な演算では、ラムダ関数の代わりに演算子モジュールの関数を使用します。 たとえば、 lambda x、y：x * yの代わりにoperator.mulを使用することをお勧めします。

定義

条件式は、 if構文に簡潔な構文を提供するメカニズムです。 たとえば、 cond else 2の場合 、 x = 1です 。

長所

if構造よりも短くて快適です。

短所

ifステートメントよりも読みにくい場合があります。 式が非常に長い場合、条件を記述するのが難しすぎる可能性があります。

解決策

インライン式にのみ使用します。 それ以外の場合は、本格的なifコンストラクトの使用を優先してください。

定義

関数引数リストの最後にある変数に値を割り当てることができます。たとえば、 def foo（a、b = 0）：
関数fooが1つの引数のみで呼び出された場合、引数bは0になります 。 2つの引数で呼び出された場合、 bは2番目の引数で渡された値を持ちます。

長所

多くの場合、多くのデフォルト値を使用する関数があります。 ただし、デフォルト値をオーバーライドする必要がある場合があります。 Pythonはメソッド/関数のオーバーロードもサポートしていません。標準の引数は、オーバーロードの動作を「シミュレート」する簡単な方法です。

短所

標準引数の値は、モジュールのロード中に1回計算されます。 引数がリストや辞書などの可変オブジェクトである場合、これにより問題が発生する可能性があります。 関数がオブジェクトを変更する場合（たとえば、リストに項目を追加することにより）、デフォルト値が変更されます。

解決策

次の警告とともに使用される場合があります。
可変オブジェクトを関数またはメソッド定義の標準値として使用しないでください。

良い：

 def foo(a, b=None): if b is None: b = [] 

悪い：

 def foo(a, b=[]): 

コード呼び出しでは、デフォルト値を持つ引数に名前付きの値を使用する必要があります。 これにより、コードを文書化することができ、必要以上の引数が渡されたときに欠陥を防止および検出できます。

 def foo(a, b=1): ... 

良い：

 foo(1) foo(1, b=2) 

悪い：

 foo(1, 2) 

プロパティを使用して、通常は単純なgetterまたはsetterメソッドを使用するデータにアクセスしたり、値を割り当てたりします。

定義

もちろん、計算がそれほど複雑でない場合は、アクセスメソッドの呼び出しと属性の割り当てを標準の属性アクセスとしてラップする方法。

長所

属性に簡単にアクセスするためのgetおよびsetメソッドの明示的な呼び出しを排除することにより、読みやすさが向上します。 遅延計算が可能です。 クラスインターフェイスを維持することは、Pythonパスの一部であると考えられています。 パフォーマンスの観点から、変数への直接アクセスが必要な場合、単純なゲッターメソッド（アクセサ）を介してプロパティにアクセスできます。 また、インターフェイスを変更せずに、後でアクセス方法を追加することもできます。

短所

プロパティは、getおよびsetメソッドが宣言された後に宣言され、コード内の以下のプロパティに使用されることを要求します（ @propertyデコレータを使用して作成された読み取り専用プロパティを除く、以下を参照）。 オブジェクトクラスから継承する必要があります。 オーバーロード演算子などの副作用が不明瞭になる場合があります。 子孫クラスは誤解を招くかもしれません。

解決策

作成したコードのプロパティを使用して、単純なgetメソッドまたはsetメソッドを使用するデータにアクセスまたは変更します。 読み取り専用プロパティは、 @ propertyデコレータを使用して作成する必要があります。 親プロパティがオーバーライドされない限り、プロパティの継承はあまり透明にならない場合があります。 したがって、プロパティを介して呼び出されるサブクラスのメソッドをオーバーライドするには、ゲッターメソッドが間接的に呼び出されることを確認する必要があります（ テンプレートメソッドパターンを使用）

良い：

 import math class Square(object): """A square with two properties: a writable area and a read-only perimeter. To use: >>> sq = Square(3) >>> sq.area 9 >>> sq.perimeter 12 >>> sq.area = 16 >>> sq.side 4 >>> sq.perimeter 16 """ def __init__(self, side): self.side = side def __get_area(self): """Calculates the 'area' property.""" return self.side ** 2 def ___get_area(self): """Indirect accessor for 'area' property.""" return self.__get_area() def __set_area(self, area): """Sets the 'area' property.""" self.side = math.sqrt(area) def ___set_area(self, area): """Indirect setter for 'area' property.""" self.__set_area(area) area = property(___get_area, ___set_area, doc="""Gets or sets the area of the square.""") @property def perimeter(self): return self.side * 4 

定義

ブール値のコンテキスト内にある場合、Pythonは特定の値をFalseで計算します。 これを覚える最も簡単な方法は、 False 、 0 、 None 、 [] 、 {}などのすべての「空の」値がブールコンテキストでFalseに評価されることを知ることです。

長所

Pythonのブール値を使用するこのような条件付き構造は読みやすく、エラーが発生しにくいです。 ほとんどの場合、より高速です。

短所

C / C ++開発者にとっては奇妙に見えるかもしれません。

解決策

可能であれば、明示的にFalseを使用します。 たとえば、 foo：が foo！= []：よりも優れている場合。 いくつかの例外を覚えておく必要があります。

• Noneなどのシングルトンオブジェクトを比較するには、 ==または！=を使用しないでください。 使用はisまたはnotです。
• if x：の記述に注意してください。xがNoneではない場合 、たとえば、デフォルトでNoneになっているが、値が別のものに変更されている変数または引数をテストする場合。 別の値は、ブールチェックを使用してFalseで計算できます。
• ==を使用してブール変数をFalseと比較しないでください。 代わりにxではなくifを使用してください。 FalseとNoneを区別する必要がある場合は 、 xが xで 、 xがNoneでない 場合などの文字列式を使用します。
• シーケンス（行、リスト、タプル）の場合、空のシーケンスがFalseに評価されるという事実を使用します。したがって、seqでない場合、またはseqが len（seq）またはlen（seq）でない場合よりも優れています。
• 整数を使用する場合、 Falseとの明示的な比較には、メリットよりもリスクが伴います（ Noneを0としてランダムに処理）。 整数である（ len（）関数の実行結果ではない）値をゼロと比較できます。

良い：

 if not users: print "no" if foo == 0: self.handle_zero() if i % 10 == 0: self.handle_multiple_of_ten() 

悪い：

 if len(users) == 0: print 'no users' if foo is not None and not foo: self.handle_zero() if not i % 10: self.handle_multiple_of_ten() 

“ 0”（つまり、文字列としての0）はTrueと評価されることに注意してください。

可能な場合は、 文字列モジュールの代わりにメソッドを使用します。 適用関数ではなく、構文を通じて関数呼び出しを使用します。 関数引数にインラインラムダ式があるフィルターおよびマップ関数の代わりに、リストジェネレーターとforループを使用します。 reduceの代わりにループを使用します。

定義

Pythonの現在のバージョンは、人々が間違いなく最高のものを見つける代替構成を提供します。

解決策

これらの機能をサポートしないPythonのバージョンは使用しないため、新しいスタイルを使用する理由はありません。

良い：

 words = foo.split(':') [x[1] for x in my_list if x[2] == 5] map(math.sqrt, data) #   -     fn(*args, **kwargs) 

悪い：

 words = string.split(foo, ':') map(lambda x: x[1], filter(lambda x: x[2] == 5, my_list)) 

定義

Pythonの入れ子関数は、囲んでいる関数で定義された変数を参照できますが、それらを割り当てることはできません。 変数の関係は、プログラムの静的テキストに基づく字句コンテキストを使用して解決されます。 コードブロック内で名前が割り当てられると、Pythonがその名前へのすべての参照を処理します（宣言が使用の前にある場合でも）。 グローバル宣言が存在する場合、名前はグローバル変数として扱われます。
この機能の使用例：

 def get_adder(summand1): """Returns a function that adds numbers to a given number.""" def adder(summand2): return summand1 + summand2 return adder 

長所

多くの場合、よりクリーンでエレガントなコードになります。 LispとScheme（およびHaskellとMLと..）プログラマーがこれを扱うのは特に快適です。

短所

PEP-0227から取得したこの例のように、奇妙なエラーにつながる可能性があります。

 i = 4 def foo(x): def bar(): print i, # ... #    # ... for i in x: # ,  i   Foo,  - Bar  . print i, bar() 

したがって、 foo（[1,2,3]）は1 2 3 4ではなく1 2 3 3を出力します。

解決策

使用できます。