GitHubじゃ!Pythonじゃ!

GitHubからPython関係の優良リポジトリを探したかったのじゃー、でも英語は出来ないから日本語で読むのじゃー、英語社会世知辛いのじゃー

trekhleb

learn-python – 📚 Pythonを学習するためのプレイグラウンドとチートシート

投稿日:

📚 Pythonを学習するためのプレイグラウンドとチートシート

Pythonを学習するためのプレイグラウンドとチートシート

これは、 トピック別に分割されたPythonスクリプトのコレクションであり、説明、さまざまな使用事例、およびさらなる読み上げへのリンクを含むコード例を含んでいます。

コードを変更したり追加したりして、動作の仕組みを見てアサーションを使用テストすることができるため、これは遊び場です。 また書いたコードlintして、 Pythonコードスタイルガイドに適合しているかどうかを確認することもできます。 総合的には、学習プロセスをよりインタラクティブにすることができ、初めからコード品質をかなり高く保つのに役立つかもしれません。

Python標準的な文と構文の構文を要約すると、これらのコード例に戻ることができるので、 チートシートです。 また、コードにアサーションがいっぱいであるため、期待している機能や文をすぐに表示することができます。

このリポジトリを使用する方法

このリポジトリの各Pythonスクリプトの構造は次のとおりです。

"""Lists  <--- Name of the topic here

# @see: https://www.learnpython.org/en/Lists  <-- Link to further readings goes here

Here might go more detailed explanation of the current topic (i.e. general info about Lists).
"""


def test_list_type():
    """Explanation of sub-topic goes here.
    
    Each file contains test functions that illustrate sub-topics (i.e. lists type, lists methods).
    """
    
    # Here is an example of how to build a list.  <-- Comments here explain the action
    squares = [1, 4, 9, 16, 25]
    
    # Lists can be indexed and sliced. 
    # Indexing returns the item.
    assert squares[0] == 1  # <-- Assertions here illustrate the result.
    # Slicing returns a new list.
    assert squares[-3:] == [9, 16, 25]  # <-- Assertions here illustrate the result.

だから、通常は次のことをしたいと思うかもしれません:

  • あなたが学びたい、または要約したいトピック見つけます。
  • 上記の例のように、各スクリプトのdocstringにリンクされているコメントやドキュメントを読んでください。
  • 使用例と予想される出力を確認するには、コード例とアサーションを参照してください。
  • コードを変更するか、新しいアサーションを追加して、どのように動作するかを確認します。
  • テスト実行し 、コードが正しく機能するかどうかを調べるためにコードlintします

目次

  1. 入門
  2. 演算子
  3. データ型
  4. 制御フロー
  5. 機能
  6. クラス
  7. モジュール
  8. エラーと例外
  9. ファイル
  10. 追加
  11. 標準ライブラリの概要

前提条件

Pythonのインストール

あなたのマシンにPython3がインストールされていることを確認してください。

venv標準のPythonライブラリを使用して仮想環境を作成し、Python、pipおよびすべての依存パッケージをローカルプロジェクトディレクトリからインストールして提供することで、システム全体のパッケージとそのバージョンの混乱を避けることができます。

インストールに応じて、Python3インタプリタにアクセスするには、 pythonまたはpython3実行します。 pipパッケージマネージャーにも同じことが言います – pipまたはpip3実行してアクセス可能かもしれません。

次のコマンドを実行してPythonのバージョンを確認することができます:

python --version

このリポジトリでは、Pythonを参照するたびにPython 3であるとみなされます。

依存関係のインストール

次のコマンドを実行して、プロジェクトに必要なすべての依存関係をインストールします。

pip install -r requirements.txt

コードのテスト

テストはpytestフレームワークを使用して行われます。

test_接頭辞付きのファイルと関数を追加することで、新しいテストを自分自身に追加することができます( def test_sub_topic()関数が内部にあるdef test_sub_topic() )。

すべてのテストを実行するには、プロジェクトのルートフォルダから次のコマンドを実行してください。

pytest

特定のテストを実行するには、次を実行してください:

pytest ./path/to/the/test_file.py

コードのリンチング

リンティングは、 pylintライブラリを使用して行われます。

コードがPEP 8のスタイル・ガイドに関して書かれているかどうかを調べるには、以下を実行してください:

pylint ./src/

もしlinterがエラー(すなわちmissing-docstring )を検出した場合は、次のコマンドを実行して特定のエラーの詳細を読むことができます:

pylint --help-msg=missing-docstring







-trekhleb
-, , , , ,

執筆者:

関連記事

関連記事はありませんでした