ドキュメントとテストの実践

Pythonで学ぶSoftware Engineeringの原則

Adam Spannbauer

Machine Learning Engineer at Eastman

Sphinxによるプロジェクトのドキュメント化

  Sphinxページの例

Pythonで学ぶSoftware Engineeringの原則

クラスのドキュメント化

class Document:
    """Analyze text data

    :param text: text to analyze

    :ivar text: text originally passed to the instance on creation
    :ivar tokens: Parsed list of words from text
    :ivar word_counts: Counter containing counts of hashtags used in text
    """
    def __init__(self, text):
        ...
Pythonで学ぶSoftware Engineeringの原則

継続的インテグレーションテスト

    Travis CIのロゴ

Travis出力の例 - 失敗

Pythonで学ぶSoftware Engineeringの原則

継続的インテグレーションテスト

  Travis出力の例 - 成功

Pythonで学ぶSoftware Engineeringの原則

リンクと追加ツール

  • Sphinx - 美しいドキュメントを生成
  • Travis CI - コードを継続的にテスト
  • GitHub & GitLab - Gitでプロジェクトをホスト
  • Codecov - テストの改善箇所を発見
  • Code Climate - 可読性向上のためのコード分析
Pythonで学ぶSoftware Engineeringの原則

練習しましょう!

Pythonで学ぶSoftware Engineeringの原則

Preparing Video For Download...