Python コードの可読性を向上させるための 5 つの重要なヒント

Python には、コードの内部動作を理解するのに役立つメソッドが多数あります。プログラミングの習慣を身につけることで、半分の労力で作業の効率を高めることができます。

たとえば、次の画像によく似たコードが完成する可能性があります。ただし、最悪の状況ではありませんが、次のようないくつかのことを拡張する必要があります。

• load_las_file 関数の f と d は何を表しますか?
• なぜ粘土関数で結果を確認するのでしょうか?
• これらの関数にはどのような型が必要ですか? Floats? DataFrames?

この記事では、ドキュメント、プロンプト入力、正しい変数名を通じてアプリケーション/スクリプトの読みやすさを向上させる方法に焦点を当てます。 . セックスに欠かせない5つのヒント。

1. コメント

コードに対して最初にできることは、コードにコメントを追加することですが、コメントを使いすぎないようにしてください。コメントでは、コードがどのように機能するかではなく、なぜそのコードが機能するのか、またはなぜ特定の方法で実行されるのかを説明する必要があります。

Python のコメントは通常ポンド記号 (#) を使用して行われ、単一行または複数行にまたがることができます。

# Comment using the hashtag
# Another comment using the hashtag

複数行のコメントの場合は、3 つの二重引用符を使用することもできます。

"""
This is an example of
a multi-line comment
"""

以下の例では、ワークフローとコードの特定の行の背後にある理由を説明するために、いくつかのコメントがコードに追加されています

2. 明示的な型付け

Python 言語は動的に型指定されます。つまり、変数の型は実行時にのみチェックされます。さらに、変数はコードの実行中に型を変更する可能性があります。

一方、静的型付けでは、変数の型を明示的に指定する必要があり、コードの実行中に変更することはできません。

2014 年に PEP 484 で型ヒントの概念が導入され、後に Python バージョン 3.5 で導入されました。これにより、変数の型を明示的に指定できるようになります。

型ヒントを追加すると、コードの読みやすさを大幅に向上させることができます。次の例では、次の情報を簡単に取得できます。

• この関数には 2 つのパラメータが必要です
• ファイル名パラメータは文字列型である必要があります
• start_ Depth パラメータこれは float 型で、デフォルト値は None です。
• この関数は pandas DataFrame オブジェクトを返します

すぐに正確に判断できます。関数は、何を返すかという型のヒントに基づいて必要とします。

3. docstrings (ドキュメント文字列)

ドキュメント文字列は、関数またはクラス定義に続く文字列リテラルです。ドキュメント文字列は、関数の動作を詳細に説明する優れた方法です。何を、どのようなパラメーターを使用するか取得する例外、スローする例外、返す内容など。

さらに、Sphinx などのツールを使用してコードのオンライン ドキュメントを作成すると、ドキュメント文字列が自動的に取得され、適切なドキュメントに変換されます。

次の例は、clay_volume という名前の関数の docstring を示しています。

ここでは、各パラメーターが何であるかを指定できます。これは、基本的な型のヒントよりも詳細であり、学術的な参考文献や方程式など、関数の背後にあるメソッドに関する詳細情報を含めることもできます。

#docstring があると、コード内の他の場所から関数を呼び出すときにも非常に役立ちます。たとえば、Visual Studio を使用してコードを編集する場合、関数呼び出しの上にマウスを置くと、関数の動作と関数に必要な内容のポップアップが表示されます。

Visual Studio Code (VSCode) を使用して Python コードを編集する場合は、autoDocstring などの拡張機能を使用して、docstring の作成プロセスを簡素化できます。このプラグインを使用すると、3 つの二重引用符を入力すると、テンプレートの残りの部分が自動的に入力されます。入力する必要があるその他の詳細に集中するだけで済みます。

4. 読みやすい変数名

コードを書くとき、特に特定の関数を完了させたいときは、変数の名前にあまり注意を払いません。しかし、コードが x1 または var123 という名前の一連の変数を返した場合、一見しただけでは誰もそれらが何を表しているのか理解できません。

次の例には、2 つの変数 f と d があります。コードの他の部分を見ることでこれらが何を意味するかを推測することは可能ですが、特にコードが長い場合は時間がかかります。

これらの変数に適切な名前を割り当てると、そのうちの 1 つが lasio.read() 呼び出しによって読み取られた data_file であり、最も重要な名前であることがわかります。おそらく元のデータです。データ変数は、これが作業している実際のデータであることを示しています。

5. マジック ナンバーの回避

#​​##マジック ナンバーは、背後に多くの説明されていない意味を持つコード内の値であり、定数を表すことができます。これらをコードで使用すると、特に数値を使用する計算に慣れていない人にとっては曖昧さが生じる可能性があります。

また、同じマジックナンバーが複数の場所にあり、それを更新する必要がある場合は、そのすべてのインスタンスを更新する必要があります。ただし、適切に名前を付けた変数に番号を割り当てれば、プロセス全体がはるかに簡単になります。

以下の例には、result という値を計算し、0.6 を乗算する関数があります。コードからはそのコードの意味を正確に知ることはできません

変数を宣言してそれに値を代入すると、何が意味するのかをよりよく知ることができます。それ。この場合、ガンマ線指数を粘土の体積に変換するために使用される粘土と頁岩の比率です。

概要

コメントやドキュメント文字列を通じてコードにドキュメントを追加すると、自分自身や他の人がコードの動作を理解するのに大いに役立ちます。確かに、最初は面倒に感じるかもしれませんが、ツールを使用し、定期的に練習することで、それが自然になる可能性があります。

以上がPython コードの可読性を向上させるための 5 つの重要なヒントの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。