とりあえず自分用に書き方を整理
コメント
def fnc_hoge(args1, args2 = 1, args3 ):
'''
関数の説明
Parameters
--------------
args1 : str
説明
args2 : int, default 1
説明
args3 : array-like ※配列であるケース
args3 : list of int ※配列に格納している型記載するケース
Attributes ※Classの場合
----------
attr1 : dict
説明
See Also ※関連して参照してほしいもの
--------
関連説明
Notes
-----
特記事項
Raises ※エラーが起きる条件
------
DatabaseError
データベース関連エラー
Returns
-------
ret1 : int
説明
return ret1
一行の長さ
- 一行は79文字、複数行に継続させる場合はバックスラッシュ(¥)
- コメントなど制約の少ないコメントブロックは72行
二項演算子改行位置
- 二項演算子の前で改行
int_var = (var1
+ var2
+ var3
ソースファイルのエンコーディング
UTF-8
UTF-8の時はエンコーディング宣言をしない
import文
- 行を分ける
- fromで同一モジュール内のクラス等をimportする時は一行
- 標準ライブラリ、サードパーティーライブラリ、個人独自ライブラリ順にグループ毎宣言しグループ毎に1行空ける
- 絶対importを推奨（例 import hogepkg.hogelib）
- ワイルドカードを使用したimportはしない
モジュールレベルの二重アンダースコア変数
- docstringとimport文間に宣言する
- import __futture__がある場合はその前
インラインコメント
- 文と#の間には2つ以上のスペース入れる(自分の場合は4つ)
- #とコメント文の間には1つスペースを入れる
命名規則
- 外部から使用させたくない変数の場合は頭に"_"を付ける※実際に使用できない訳ではない
- 外部から使用させたくない変数の場合は頭に"__"を付ける※絶対使用できない訳ではない
- モジュールとパッケージは小文字、"_"は使用しない
- クラス名は単語の頭文字を大文字にする(CapWords方式)
- 関数名、変数名は小文字と単語を"_"でつなげる
- メソッドとインスタンス変数は小文字と単語を"_"でつなげる
- 定数は大文字と単語は"_"でつなげる
プログラミングでの推奨
- ブール型の値とTrue、Falseを比較する時に "=="は使用しない(例 if var:)
アノテーション
def 関数名(引数:[型]) -> 戻り[値の型]:
help(関数名)で引数や戻り値の型について確認出来るようになる
参考
0 件のコメント:
コメントを投稿