![flake8 の設定ファイル
.flake8 か setup.cfg, tox.ini など
ツール独自のファイルだとトップディレクトリに散らかるの
で汎用的なのが好み
[flake8]
max-line-length = 88
ignore = E203,W503,W504](https://image.slidesharecdn.com/pyconjp2019-beginners-session-190916051123/85/Python-10-320.jpg)
![mypy の設定ファイル
mypy.ini, setup.cfg
ignore_missing_imports は今のところ必須
type hint を提供していないライブラリを許す
[mypy]
ignore_missing_imports=1](https://image.slidesharecdn.com/pyconjp2019-beginners-session-190916051123/85/Python-24-320.jpg)
![mypy 実行例
from typing import Optional
def f():
return add(None, 0)
def add(a: Optional[int], b: int):
c = a if a else 0
return a + b](https://image.slidesharecdn.com/pyconjp2019-beginners-session-190916051123/85/Python-25-320.jpg)
![修正しましょう
from typing import Optional
def f():
return add(None, 0)
def add(a: Optional[int], b: int):
c = a if a else 0
return c + b](https://image.slidesharecdn.com/pyconjp2019-beginners-session-190916051123/85/Python-27-320.jpg)
![tox.ini
[tox]
envlist = py36,py37
[testenv]
deps = pytest
commands = pytest](https://image.slidesharecdn.com/pyconjp2019-beginners-session-190916051123/85/Python-43-320.jpg)
Pythonでの開発を効率的に進めるためのツール設定
- 1. Python での開発を効率的に進めるためのツー ル設定 pycon jp 2019 ビギナーセッション Atsushi Odagiri September 16, 2019
- 6. はじめの準備 いつでも venv で作業しましょう $ python3.7 -m venv .venv $ source .venv/bin/activate > py -3.7 -m venv .venv > .venvScriptsactivate.ps1
- 9. flake8 のインストール方法 $ pip install flake8
- 10. flake8 の設定ファイル .flake8 か setup.cfg, tox.ini など ツール独自のファイルだとトップディレクトリに散らかるの で汎用的なのが好み [flake8] max-line-length = 88 ignore = E203,W503,W504
- 11. flake8 実行例 def add(a, b): return a + b def f(): return add(None, 0) def add(a, b): c = a if a else 0 return a + b
- 12. flake8 実行結果 flake8 .flake8_violated.py .flake8_violated.py:9:1: F811 redefinition of unused 'add' .flake8_violated.py:10:5: F841 local variable 'c' is assig
- 13. 修正しましょう def f(): return add(None, 0) def add(a, b): c = a if a else 0 return c + b
- 14. black とは PEP8 準拠なコードフォーマッター autopep8, yapf などの既存のフォーマッターとの違い ほとんど設定できない たとえ pep8 に準拠しているコードでも問答無用で black スタ イルにフォーマットされる もう設定で悩むのはやめよう (プロジェクトごとにちょっと 設定が違うとかもやめよう)
- 16. black のインストール方法 $ pip install black
- 17. black の設定ファイル 一応 pyproject.toml が設定ファイル 行長と除外ファイルくらい設定できる
- 18. black の使い方 そのまま実行するとフォーマット実行 --check オプションでフォーマットされるファイルがあるか チェック --diff オプションでどのようにフォーマットされるか差分 表示
- 19. black 実行例 def add(a, b): c = ( a + b) return a + b
- 20. black 実行結果 black --diff .black_diff.py --- black_diff.py 2019-09-16 01:11:41.391055 +0000 +++ black_diff.py 2019-09-16 01:11:47.066582 +0000 @@ -1,7 +1,4 @@ def add(a, b): - c = ( - a - + - b) + c = a + b return a + b reformatted black_diff.py All done! black --diff .black_diff.py
- 21. mypy とは type hint チェック 実行時は関係ない
- 22. なぜ type hint チェッカーを使うのか ドキュメントやコメントで書くより厳密 正しくない type hint はエディターの補完などで有害 実行しなくても型チェッカーで間違いがわかる
- 23. mypy のインストール $ pip install mypy
- 24. mypy の設定ファイル mypy.ini, setup.cfg ignore_missing_imports は今のところ必須 type hint を提供していないライブラリを許す [mypy] ignore_missing_imports=1
- 25. mypy 実行例 from typing import Optional def f(): return add(None, 0) def add(a: Optional[int], b: int): c = a if a else 0 return a + b
- 26. mypy 実行結果 mypy .mypy_violated.py mypy_violated.py:9: error: Unsupported operand types for + mypy_violated.py:9: note: Left operand is of type "Optional
- 27. 修正しましょう from typing import Optional def f(): return add(None, 0) def add(a: Optional[int], b: int): c = a if a else 0 return c + b
- 29. なぜ pytest か。unittest との違い。 詳細なテストレポート アドオン fixture の仕組み 関数 + assert 文 vs TestCase クラスの assert メソッド
- 30. pytest のインストール $ pip install pytest
- 31. pytest アドオンの例 pytest-cov coverage 情報収集 pytest-django request や client などの fixture を提供 pytest-mock mock を pytest 向けに使いやすくした fixture pytest-freezegun 時間関連のモックツール freezegun の pytest fixture
- 33. 使い方 (1) テスト対象 # loader.py import json FILENAME = "value.json" def load(): with open(FILENAME) as f: return json.load(f) def save(v): with open(FILENAME, "w") as f: json.dump(v, f)
- 34. 使い方 (1) テストコード # test_loader.py import json from loader import save, load def test_save(): v = {"value": 1} save(v) with open("value.json") as f: assert json.load(f) == {"value": 1} def test_load(): result = load() assert result == {"value": 1}
- 35. 問題点 test_load は test_save 実行後じゃないと成功しない test_save だけ単独実行できない いつもテストを全部実行しないといけない？
- 37. 全体実行 pytest-randomly なしだといつもうまくいってしまう $ pytest .test_loader.py
- 38. テスト指定で実行 $ pytest .test_loader.py::test_load $ rm value.json $ pytest .test_loader.py::test_load
- 39. pytest-randomly を入れて実行 テスト順がシャッフルされるので複数回実行してみましょう $ pip install pytest-randomly $ pytest .test_loader.py $ pytest .test_loader.py $ pytest .test_loader.py $ pytest .test_loader.py
- 40. tox とは テスト用 virtualenv の管理 テストタスクの管理
- 41. tox を使う意味 様々なバージョンの python でテストする CI 上でもローカルでも tox で同じテストを実行する
- 42. tox のインストール $ pip install tox
- 43. tox.ini [tox] envlist = py36,py37 [testenv] deps = pytest commands = pytest
- 44. 実行 -e オプションで実行したい env を指定する (指定しなければ 全部) $ tox -e py37
- 48. エディタで設定したいこと 編集中に flake8/mypy の警告を表示 保存したら black でフォーマット テスト実行結果からエラー箇所にジャンプ テストでカバーされた行をマーカーで表示
- 49. vs code python.linting.flake8.enabled python.linting.mypy.enabled python.linting.pylint.enabled false python.format.provider = ”black” editor.formatOnSave
- 50. emacs 静的チェックのフレームワーク flycheck や flymake flycheck はデフォルトで flake8 対応 save フック save フックで black を適用
- 54. 自分でやってみてほしいこと 自分のプロジェクトに導入できそうな pytest アドオンを調べ てみましょう pytest-django, pytest-mock… プロジェクトの CI に導入してみましょう