開発でより良いコードを書くために

pythonで開発する場合に、どのようにコードを書くべきかまとめました。

Transcript

1. 開発でより良いコードを書くために
2. 参考文献
3. 変数名で中身がわかるようにする 例えばresultやgraphだけでは対象が何かわからないので、対象をつけるもしくは、 resultは使わない 例 result → detection_rate_result、total_detection_rate 例 graph → loss_graph
4. 導入 開発での良いコードとは ☓短いこと △最速で動くこと ◦他の人(１年後の自分含めて)が最短時間で理解できること
5. 名前は短くしない 他の人が読んですぐに意味が理解できるように、一般的ではない、誤解を招く省略形は使わない bad examples ・gen→generate ・no → number ・epoch→ep good examples ・directory→ dir ・maximize→max 例外・iterator→i (for i, name in enumerate(names))
6. 関数名で処理内容がわかるようにする おすすめは def 動詞_名詞() 動詞は具体的にする 例 get_score()→calculate_score() 例 def loss_graph() → def draw_loass_graph()、def draw_save_loss_graph()
7. 変数の型は書いておく intやstrと型の指定も重要だが、最低限 data frameなのか、listなのかは書いて置くとわかりやすい names_df names_list names_dic names_set names_array names 型チェックするmypy https://qiita.com/k-saka/items/8f05c89f675af219e081
8. 単数と複数の区別を明確に イテレータでの単数と複数を明確にしておくとわかりやすい name_list = [“Mike”, “Taro”] for name in name_list: name XXXX names_list = [“Mike”, “Taro”] for name in names_list: name XXXX
9. 同じ変数に繰り返し違うものを代入しない 同じ変数に繰り返し違うものを代入すると中身が把握しづらくなる data = pd.read_csv(data.csv) data = f1(data) data=f2(data) total_price=f3(data) return total_price data = pd.read_csv(data.csv) price = f1(data) price_including_tax = f2(price) total_price=f3(price_including_tax) return total_price
10. 処理２ Detect 構造ごとにコードを分ける (class文で分けることをおすすめします) 前処理 処理１ グラフ作成 main main文 from preprocess import Preprocess from detect import Detect from praph import Graph data = pd.read_csv(data.csv) for epoch in epochs: preprocess = Preprocess(data) detction = Detect(data) Preprocess Graph
11. 処理２ Detect 構造ごとにコードを分ける 上位概念でまとめるとより良い 前処理 処理１ グラフ作成 main main文 from object_detection import ObjectDtection data = pd.read_csv(data.csv) for epoch in epochs: obj = ObjectDtection(data) object_detection Preprocess Graph
12. フローは手書き画像のほうがわかりやすい アルゴリズムやコードの流れはコメントではなく、手書き画像が入れるのが Best ・手書きの画像をコードに入れられる VSCodeの拡張機能がある ・手書きできるデバイスが必要になる https://qiita.com/tkrkt/items/2fc9a9a59ce679aab728
13. PEP8に従っているかは拡張機能で確認 書いたコードがPEP8に従っているかはFlake8やBlackで自動検証すべき ・Flake8 Flake8はコードがこの規約通りに書けているか、シンタックスエラーがないかなどをチェックしてくれるツール ・Black Blackはpep8に関するエラーをチェックするだけでなく、自動で修正してくれる。さらに、改行の仕方やクォー テーションの使い方まで統一してくれる。 多人数開発でコードを合わせるのなら Blackがよい？ https://www.macky-studio.com/entry/2019/07/04/152323
14. 読みやすさも 考えないとね 人間だもの