#【コメント】
# coding【エンコード宣言】
'''【ドキュメンテーション文字列】
pass【処理なし】
assert【診断 (デバッグ)】
#【コメント】
メモ
- コメントの記述
- 単一行のみ (単独・コード後方 で使用可)
コード途中のコメント構文はなし・連続したコメント行は個々に指定 - バックスラッシュ (
\) による継続行には使用不可 - 構文的なインデントの考慮不要 (インデント量は関係なくエラーなし)
- コード後方で使用する場合、２個以上のスペース・#・１個のスペース の後にコメントを推奨 (PEP8： Inline Comments)
- 単一行のみ (単独・コード後方 で使用可)
- 関連
構文
# コメント (行末まで)
例
# コメント
value = 123 # コメント
# coding【エンコード宣言】
メモ
構文
１行目か２行目(１行目もコメントのみ)のコメントが、下記の正規表現 (参照：re：正規表現パターン)
coding[=:]\s*([-\w.]+)
下記を推奨
# -*- coding: エンコーディング名 -*-
# vim:fileencoding=エンコーディング名
エンコーディング名下記表参照
エンコーディング名 (一部)
※大文字と小文字の区別なし・ハイフンとアンダースコアの区別なし (別名として有効)| エンコーディング名 | 別名 |
|---|---|
| 英語・UTF | |
| ascii | 646 us-ascii |
| cp037 | IBM037 IBM039 |
| cp437 | 437 IBM437 |
| utf-7 | U7 unicode-1-1-utf-7 |
| utf-8 (デフォルト) | U8 UTF utf8 |
| utf-8-sig | |
| utf-16 | U16 utf16 |
| utf-16be | UTF-16BE |
| utf-16le | UTF-16LE |
| utf_32 | U32 utf32 |
| utf_32_be | UTF-32BE |
| utf_32_le | UTF-32LE |
| 日本語関連 | |
| cp932 | 932 ms932 mskanji ms-kanji |
| euc-jis-2004 | jisx0213 eucjis2004 |
| euc-jisx0213 | eucjisx0213 |
| euc-jp | eucjp ujis u-jis |
| iso-2022-jp | csiso2022jp iso2022jp iso-2022-jp |
| iso-2022-jp-1 | iso2022jp-1 iso-2022-jp-1 |
| iso-2022-jp-2 | iso2022jp-2 iso-2022-jp-2 |
| iso-2022-jp-3 | iso2022jp-3 iso-2022-jp-3 |
| iso-2022-jp-2004 | iso2022jp-2004 iso-2022-jp-2004 |
| iso-2022-jp-ext | iso2022jp-ext iso-2022-jp-ext |
| shift-jis | csshiftjis shiftjis sjis s_jis |
| shift-jis-2004 | shiftjis2004 sjis_2004 sjis2004 |
| shift-jisx0213 | shiftjisx0213 sjisx0213 s_jisx0213 |
例
# -*- coding: shift-jis -*-
'''【ドキュメンテーション文字列】
メモ
- ドキュメンテーション用に文字列を記述
- ３個のダブルクォーテーション (""") または シングルクォーテーション (''') で囲む
- 実体は改行付きリテラル文字列で複数行可 (開始位置はインデントの考慮が必要)
- 複数行の場合、終わりは単独の３個のクォーテーションを推奨 (参考： PEP 8：Documentation Strings (英語))
- __doc__ 属性 または help() で参照可能
- ドキュメント化：各種ツールで可能 (通常のコメントを利用してDoxygen でも可)
- 関連
構文
"""ドキュメンテーション (複数行可)"""
'''ドキュメンテーション (複数行可)'''
例
class DocClass:
"""クラスの説明"""
def method(p1):
"""メソッドの説明
p1 -- パラメータ１の説明
"""
print("【DocClass.__doc__】")
print(DocClass.__doc__)
print("【DocClass.method.__doc__】")
print(DocClass.method.__doc__)
print("【help(DocClass)】")
help(DocClass)
【出力例】
【DocClass.__doc__】
クラスの説明
【DocClass.method.__doc__】
メソッドの説明
p1 -- パラメータ１の説明
【help(DocClass)】
Help on class DocClass in module __main__:
class DocClass(builtins.object)
| クラスの説明
|
| Methods defined here:
|
| method(p1)
| メソッドの説明
|
| p1 -- パラメータ１の説明
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables (if defined)
|
| __weakref__
| list of weak references to the object (if defined)
pass【処理なし】
メモ
- 構文的に文が必要な位置に、処理なしとして記述
- 実装までのプレースホルダとして有用
- 関連
構文
pass
例
def new_func():
pass
class NewClass:
pass
assert【診断 (デバッグ)】
メモ
- デバッグ時の診断
- 条件に合わない場合にエラー出力
- 関連
構文
assert 判定式
下記と等価
if __debug__:
if not 判定式: raise AssertionError
assert 判定式, メッセージ
下記と等価
if __debug__:
if not 判定式: raise AssertionError(メッセージ)
例
flag = False
assert flag
【出力例】
Traceback (most recent call last):
File "～.py", line NNN, in <module>
assert flag
AssertionError
flag = False
assert flag, "メッセージ"
【出力例】
Traceback (most recent call last):
File "～.py", line NNN, in <module>
assert flag, "メッセージ"
AssertionError: メッセージ