docstring で型を指定する

導入

あなたのコードを永久にデバッグし、今デバッグの過程でまた型情報を集めそして docstrings でこれらの型を指定することができます。

PyCharm は、実行時に型情報を収集し、型指定を定義できるインテンションアクションを提供します。

ただし、デバッガーを使用せずにパラメーターの種類を手動で指定することは可能です。

どちらのケースも Examplesセクションで説明しています。

Docstring 内の型構文

次の例では、サポートされている各 docstring 形式で、同じ関数のパラメーターの型と戻り値の型を指定しています。 PyCharm は docstring テキストから形式を認識します。形式を認識できない場合は、統合ツールで選択された形式を使用します。

def area(width, height):
    """Calculate the area of a rectangle.

    :param width: The width of the rectangle.
    :type width: float
    :param height: The height of the rectangle.
    :type height: float
    :return: The area of the rectangle.
    :rtype: float
    """
    return width * height
                
    

パラメーターの型をその説明と同じ行に指定することもできます。たとえば、 :param float width: The width of the rectangle.

def area(width, height):
    """Calculate the area of a rectangle.

    Args:
        width (float): The width of the rectangle.
        height (float): The height of the rectangle.

    Returns:
        float: The area of the rectangle.
    """
    return width * height
                
    

def area(width, height):
    """Calculate the area of a rectangle.

    Parameters
    ----------
    width : float
        The width of the rectangle.
    height : float
        The height of the rectangle.

    Returns
    -------
    float
        The area of the rectangle.
    """
    return width * height
                
    

組み込み型エンジンは docstring の型を使用します。 Pyrefly などの外部型エンジンは、型ヒントを使用します。

タイプの指定

パラメーター型を指定する

Ctrl+Alt+S を押して、エディター | 一般 | スマートキー | Python に移動します。
型コメントをスタブに挿入するチェックボックスを選択します。
関数名にキャレットを置き、 Alt+Enter を押します。
開いたインテンションアクションのリストで、ドキュメント文字列スタブを挿入するを選択します。 PyCharm は、デバッガーセッション中に収集した型指定で、選択した docstring 形式に従ってドキュメントスタブを作成します。

戻り値の型を指定する

関数が返す内容をドキュメント化することもできます。 PyCharm は、 :return: セクションと :rtype: セクション（または選択した docstring 形式での同等のもの）を生成します。

関数名にキャレットを置き、 Alt+Enter を押します。
開いたインテンションアクションのリストで、 docstring に戻り値の型を指定するを選択します。

サンプル

次のコードを考えてみましょう:

            import math

            class SimpleEquation:
                def demo(self, a, b, c):
                    d = math.sqrt(abs(b ** 2 - 4 * a * c))
                    root1 = (-b + d) / (2 * a)
                    root2 = (-b - d) / (2 * a)
                    return root1, root2

            SimpleEquation().demo(3, 2, 1)
        
  

型を手動で指定する

関数名 (ここでは demo) にキャレットを置きます。推奨されるインテンションアクションはドキュメント文字列スタブを挿入するです。詳細はドキュメントコメントを作成するをご参照ください。
このインテンションをクリックすると、 reStructuredText 形式のドキュメントコメントスタブが生成されます。
必要なパラメーターの型を手動で指定します。
ちなみに、この関数についてはクイックドキュメントを使用できます。関数名にキャレットを置き、 Ctrl+Q を押すと、次のように表示されます。

reStructuredText の場合、次の 2 つの形式で型を指定できることに注意してください。

:param param_type param_name: parameter description （型記述はパラメーター記述と同じ行にあります）。
:type param_name: param_type (型の説明は別の行にあります)

両方の変種を以下に示します:

デバッガーを使用して型を指定する

Ctrl+Alt+S を押して、ビルド、実行、デプロイ | Python デバッガーに移動します。デバッガーページで、コードインサイトのためにランタイム情報を収集するチェックボックスを選択します。
関数呼び出しをデバッグします。関数名にキャレットを置き、 Alt+Enter を押します。表示されるインテンションアクションの一覧から、ドキュメント文字列スタブを挿入するを選択します。
デバッグセッション中に取得された引数と戻り値に関する情報は、docstring 内の型アノテーションを事前に入力するために使用されます。
結果を確認します。

2026 年 10 月 30 日