Skip to content

docstring.md

Latest commit

 

History

History
173 lines (150 loc) · 8.35 KB

docstring.md

File metadata and controls

173 lines (150 loc) · 8.35 KB

docstringドキュメント

コード中に # から始まるコメントを書くことでもコードに対する補足を伝えることができるが、これはどちらかというと「APIドキュメントとしては蛇足だが、コード上の補足を伝える」目的で使うことが多い。これに対してAPIドキュメントのように関数の仕様や使用方法を記述するのが docstringによるドキュメンテーション だ。

  • コメント
    • コードに対する補足。
    • 書き方
      • 1行コメントなら # で記述。
      • 複数行コメントなら '''〜''' で記述。（ダブルクォートも可）
  • ドキュメント
    • 補足する文という点ではコメントと一緒。「マニュアル」としての側面が強い。
    • 書き方

ドキュメントの参照方法

  • 方法1：pydoc3コマンドで参照。
    • pydoc3コマンドはPythonの命令文 ではない。コマンドである。ターミナル上から使おう。
    • ソースコードが test.py なら、ターミナル上で pydoc3 test として参照。拡張子 .py を付けずに指定する点に注意。この拡張子を取り除いた名前を モジュール名 と呼ぶ。
      • 以前利用した random モジュールや、random.randint 関数についても pydoc3 コマンドでドキュメントを参照できる。試してみよう。
    • pydoc3 を終了するには q を入力しよう。quit（終了）の頭文字。
  • 方法2：HTML形式でドキュメントを生成し、ブラウザで参照。
    • pydoc3コマンド実行時に、-wオプション付きで実行。エラーが無ければ「モジュール名.html」が生成される。
    • 生成されたHTMLファイルを open コマンドで開くか、Finderからダブルクリックで開くと参照できる。
ドキュメント参照する際にはモジュール名を指定する点に注意しよう。

ドキュメントを書いてみよう

import matplotlib.pyplot as plt
import copy #for deepcopy

data = [[ 0.,  0., 0., 0.,15., 0., 0., 0.],
        [ 0.,  0., 0.,15.,15., 0., 0., 0.],
        [ 0.,  0.,15.,15.,15., 0., 0., 0.],
        [ 0.,  0., 0.,15.,15., 0., 0., 0.],
        [ 0.,  0., 0.,15., 0., 0., 0., 0.],
        [ 0.,  0., 0.,15.,15., 0., 0., 0.],
        [ 0.,  0., 0.,15.,15., 0., 0., 0.],
        [ 0.,  0.,15.,15.,15.,15., 0., 0.]]

def plot_image(image1, image2):
    plt.subplot(2,2,1)
    plt.imshow(image1, cmap="gray_r")
    plt.subplot(2,2,2)
    plt.imshow(image2, cmap="gray_r")
    plt.show()

def averaging(img, w, h, window_size):
    count = 0
    sum = 0.0
    relative_index = range(-window_size, window_size+1)
    for x in relative_index:
        for y in relative_index:
            relative_x = w + x
            relative_y = h + y
            if 0 <= relative_x and relative_x < len(img[0]) and 0 <= relative_y and relative_y < len(img):
                sum += img[relative_y][relative_x]
                count += 1
    result = sum / count
    return result

def blur_filter(image, window_size=1):
    width = len(image[0])
    height = len(image)
    new_image = copy.deepcopy(image)
    for w in range(width):
        for h in range(height):
            new_image[h][w] = averaging(image, w, h, window_size)
    return new_image

if __name__ == '__main__':
    new_img = blur_filter(data)
    plot_image(data, new_img)
  • 手順0：環境構築。
    • この手順は、上記コード例でmatplotlibモジュールを利用しているためにやっているだけであり、ドキュメントそのものとは独立した話である点に注意しよう。普段は手順1から行うことになる。
    • matplotlibのインストール。
      • 2021年度の学生:
        • source ~/.venv/prog1/bin/activate
        • pip install -U matplotlib
        • その後でvscodeをreload。
      • minicondaを使っている学生: `conda install matplotlib``
      • anacondaを使っている学生: インストール済みのため不要。
  • 手順1：コードの準備。
    • 上記コードを averaging.py として保存。
  • 手順2：ドキュメント生成＆参照。（docstring書く前の状態を確認）
    • pydoc3 -w averaging
    • open averaging.html
  • 手順3-1：ドキュメント記述1（ファイル全体）
    • ファイル冒頭に下記を記述。
    • 保存したらドキュメント生成し、どのように反映されるか確認してみよう。
'''画像データを平滑化するプログラム。
画像データはピクセルごとに0〜255のグレイスケール値を取る。
'''
  • 手順3-2：ドキュメント生成2（関数plot_image）
    • 関数plot_imageのdefブロックに下記を記述。インデントを関数ブロックに揃えること。
    • 保存したらドキュメント生成し、どのように反映されるか確認してみよう。
def plot_image(image1, image2):
  '''2つの画像を横に並べて描画。

  Argments:
    image1 (list): 横方向に並んだピクセル値を一つのリストとして保持し、そのリストを複数保持した2重リスト。
    image2 (list): 同上。
  Returns:
    なし。
  '''

-　手順3-3：ドキュメント生成3（関数averaging）

  • 関数averaging冒頭に下記を記述。インデントを関数ブロックに揃えること。
  • 保存したらドキュメント生成し、どのように反映されるか確認してみよう。
def averaging(img, w, h, window_size):
  '''対象画素値を周囲画素値の平均値に置き換えることで滑らかにする（平滑化）。

  Argments:
    img (list): 画像データ。plot_image参照。
    w (int): 平滑化する中心の横座標（横インデックス）。
    h (int): 平滑化する中心の縦座標（縦インデックス）。
    window_size (int): 平滑化サイズ。
  Returns:
    result (float): 平滑化した値。
  '''

参考：ドキュメント付きソースコードと生成したドキュメントの例

  • 今回の例: [ averaging.py | averaging.html ]
  • docstringのstyle3種の例
    • docstringの書き方に代表的なスタイルがいくつかある。上記リンク先では reStructuredTextスタイル、Googleスタイル、Numpyスタイルが紹介されている。本授業では（當間が）比較的読みやすいと感じるGoogleスタイルでの記述例を取り上げた。
**docstring形式で書いているつもりでも実際にはドキュメントとして扱われない** ことがある。例えば以下のコードを3でドキュメント生成して確認してみよう。

```python
def multiply(value1, value2):
    result = value1 * value2
    '''multiplyは2つの引数を積を求めます
    Argments:
      value1 (int, float): 数値。
      value2 (int, float): 数値。
    Returns:
      result (int, float): 積
    '''
    return result
```

上記がドキュメントとして扱われていない理由は「記述場所が誤っている」ことにある。関数に関するドキュメントならばかならずdef文の次の行から書き始めよう。コード中にdocstringを書いたとしても、それはドキュメントとしては扱われない。

上記に限らず **やったことが想定通りに動作しているかどうかを確認する** ようにしよう。手軽に確認できるのがプログラミングの大きなメリットだ。