タグ

docsとtestingに関するsh19910711のブックマーク (2)

  • pytest-htmlでテスト関数のdocstringをレポートに出力する - Qiita

    テスト関数の詳細情報としてdocstringをpytest-htmlのレポートに出力する方法をまとめます。 1. conftest.pyを編集 testsディレクトリ直下のconftest.py(なければ作成)に以下の設定を追記します。 テーブルヘッダーの3列目にタイトル、テーブルボディの3列目にテスト関数のdocstringの情報を挿入しています。 import pytest from py.xml import html def pytest_html_results_table_header(cells): cells.insert(2, html.th('Description')) def pytest_html_results_table_row(report, cells): cells.insert(2, html.td(report.description)) @pyte

    pytest-htmlでテスト関数のdocstringをレポートに出力する - Qiita
    sh19910711
    sh19910711 2024/06/17
    "テスト関数の詳細情報としてdocstringをpytest-htmlのレポートに出力する / testsディレクトリ直下のconftest.py(なければ作成)に以下の設定を追記 / pytest_html_results_table_header + pytest.hookimpl(hookwrapper=True)" 2020
  • ドキュメントの場所を知らせるために、落ちるテストを作る - $shibayu36->blog;

    今回はドキュメントの場所をどうやって気づかせるかという話を書く。 ドキュメントがあるときの問題 以前開発のドキュメントをどこに置くか問題 - $shibayu36->blog;に書いたとおり、僕の意見としては 基は実装に一番近いところにコメントとしてドキュメント書くのが良いと思う いろんなパーツが絡みあうような大きな機能の場合、導入部分だけ別の場所に書く 出来るだけrepository内に入れておくと探しやすく、更新しやすいと思う というものだった。 基的には一番近いコメントにすると、見つけやすさ・更新しやすさともにある程度担保することが出来る。しかし、メインの部分が明確に決まらない*1いろんなパーツが関係しあう機能の場合は、ドキュメントを書かないと全体の概要が分からないということもある。このような時、ドキュメントを書いても結局そのドキュメントに気づかれないし、そのため更新されないとい

    ドキュメントの場所を知らせるために、落ちるテストを作る - $shibayu36->blog;
  • 1