Docstring models¤

Main API¤

Docstring ¤

Docstring(
    value: str,
    *,
    lineno: int | None = None,
    endlineno: int | None = None,
    parent: Object | None = None,
    parser: DocstringStyle | Parser | None = None,
    parser_options: DocstringOptions | None = None,
)

This class represents docstrings.

Parameters:

value ¤
(str) –

The docstring value.
lineno ¤
(int | None, default: None ) –

The starting line number.
endlineno ¤
(int | None, default: None ) –

The ending line number.
parent ¤
(Object | None, default: None ) –

The parent object on which this docstring is attached.
parser ¤
(DocstringStyle | Parser | None, default: None ) –

The docstring parser to use. By default, no parsing is done.
parser_options ¤
(DocstringOptions | None, default: None ) –

Additional docstring parsing options.

Referenced by:

Guide User guide
- Manipulating APIs Navigating APIs Docstrings
- How-to Using Griffe as a docstring-parsing library
Reference griffe Docstrings

Returned by: Used by:

Reference Python API

Methods:

as_dict –

Return this docstring's data as a dictionary.
parse –

Parse the docstring into structured data.

Attributes:

endlineno (int | None) –

The ending line number of the docstring.
lineno (int | None) –

The starting line number of the docstring.
lines (list[str]) –

The lines of the docstring.
parent (Object | None) –

The object this docstring is attached to.
parsed (list[DocstringSection]) –

The docstring sections, parsed into structured data.
parser (DocstringStyle | Parser | None) –

The selected docstring parser.
parser_options (DocstringOptions) –

The configured parsing options.
source (str) –

The original, uncleaned value of the docstring as written in the source.
value (str) –

The original value of the docstring, cleaned by inspect.cleandoc.

endlineno `instance-attribute` ¤

endlineno: int | None = endlineno

The ending line number of the docstring.

lineno `instance-attribute` ¤

lineno: int | None = lineno

The starting line number of the docstring.

lines `property` ¤

lines: list[str]

The lines of the docstring.

parent `instance-attribute` ¤

parent: Object | None = parent

The object this docstring is attached to.

Referenced by:

Guide User guide Manipulating APIs Navigating APIs Docstrings

parsed `cached` `property` ¤

parsed: list[DocstringSection]

The docstring sections, parsed into structured data.

Referenced by:

Guide User guide Manipulating APIs Navigating APIs Docstrings

parser `instance-attribute` ¤

parser: DocstringStyle | Parser | None = parser

The selected docstring parser.

parser_options `instance-attribute` ¤

parser_options: DocstringOptions = parser_options or {}

The configured parsing options.

source `property` ¤

source: str

The original, uncleaned value of the docstring as written in the source.

It is a simple concatenation of the source lines. These source lines will include quotes (single/double/triple) and might include leading whitespace and indentation, as well as trailing comments.

Raises:

ValueError –

If the original docstring cannot be retrieved (no parent, no line numbers, or attached to namespace package).

value `instance-attribute` ¤

value: str = cleandoc(rstrip())

The original value of the docstring, cleaned by inspect.cleandoc.

as_dict ¤

as_dict(
    *, full: bool = False, **kwargs: Any
) -> dict[str, Any]

Return this docstring's data as a dictionary.

Parameters:

full ¤
(bool, default: False ) –

Whether to return full info, or just base info.
**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

parse ¤

parse(
    parser: DocstringStyle | Parser | None = None,
    **options: Any,
) -> list[DocstringSection]

Parse the docstring into structured data.

Advanced API: Sections¤

DocstringSectionKind ¤

Bases: str, Enum


              flowchart TD
              griffe.DocstringSectionKind[DocstringSectionKind]

              

              click griffe.DocstringSectionKind href "" "griffe.DocstringSectionKind"

Enumeration of the possible docstring section kinds.

Attributes:

admonition –

Admonition block.
attributes –

Attributes section.
classes –

Classes section.
deprecated –

Deprecation section.
examples –

Examples section.
functions –

Functions section.
modules –

Modules section.
other_parameters –

Other parameters (keyword arguments) section.
parameters –

Parameters section.
raises –

Raises (exceptions) section.
receives –

Received value(s) (generators) section.
returns –

Returned value(s) section.
text –

Text section.
type_aliases –

Type aliases section.
type_parameters –

Type parameters section.
warns –

Warnings section.
yields –

Yielded value(s) (generators) section.

admonition `class-attribute` `instance-attribute` ¤

admonition = 'admonition'

Admonition block.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionAdmonition kind

attributes `class-attribute` `instance-attribute` ¤

attributes = 'attributes'

Attributes section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionAttributes kind

classes `class-attribute` `instance-attribute` ¤

classes = 'classes'

Classes section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionClasses kind

deprecated `class-attribute` `instance-attribute` ¤

deprecated = 'deprecated'

Deprecation section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionDeprecated kind

examples `class-attribute` `instance-attribute` ¤

examples = 'examples'

Examples section.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionExamples value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionExamples kind

functions `class-attribute` `instance-attribute` ¤

functions = 'functions'

Functions section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionFunctions kind

modules `class-attribute` `instance-attribute` ¤

modules = 'modules'

Modules section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionModules kind

other_parameters `class-attribute` `instance-attribute` ¤

other_parameters = 'other parameters'

Other parameters (keyword arguments) section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionOtherParameters kind

parameters `class-attribute` `instance-attribute` ¤

parameters = 'parameters'

Parameters section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionParameters kind

raises `class-attribute` `instance-attribute` ¤

raises = 'raises'

Raises (exceptions) section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionRaises kind

receives `class-attribute` `instance-attribute` ¤

receives = 'receives'

Received value(s) (generators) section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionReceives kind

returns `class-attribute` `instance-attribute` ¤

returns = 'returns'

Returned value(s) section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionReturns kind

text `class-attribute` `instance-attribute` ¤

text = 'text'

Text section.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionExamples value

Used by:

Reference Python API Docstrings Docstring models
- DocstringSectionExamples
- DocstringSectionText kind

type_aliases `class-attribute` `instance-attribute` ¤

type_aliases = 'type aliases'

Type aliases section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionTypeAliases kind

type_parameters `class-attribute` `instance-attribute` ¤

type_parameters = 'type parameters'

Type parameters section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionTypeParameters kind

warns `class-attribute` `instance-attribute` ¤

warns = 'warns'

Warnings section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionWarns kind

yields `class-attribute` `instance-attribute` ¤

yields = 'yields'

Yielded value(s) (generators) section.

Used by:

Reference Python API Docstrings Docstring models DocstringSectionYields kind

DocstringSectionText ¤

DocstringSectionText(value: str, title: str | None = None)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionText[DocstringSectionText]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionText
                


              click griffe.DocstringSectionText href "" "griffe.DocstringSectionText"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a text section.

Parameters:

value ¤
(str) –

The section text.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (str) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = text

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: str = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionParameters ¤

DocstringSectionParameters(
    value: list[DocstringParameter],
    title: str | None = None,
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionParameters[DocstringSectionParameters]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionParameters
                


              click griffe.DocstringSectionParameters href "" "griffe.DocstringSectionParameters"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a parameters section.

Parameters:

value ¤
(list[DocstringParameter]) –

The section parameters.
title ¤
(str | None, default: None ) –

An optional title.

Subclassed by:

Reference Python API Docstrings Docstring models DocstringSectionOtherParameters

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringParameter]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = parameters

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringParameter] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionOtherParameters ¤

DocstringSectionOtherParameters(
    value: list[DocstringParameter],
    title: str | None = None,
)

Bases: DocstringSectionParameters


              flowchart TD
              griffe.DocstringSectionOtherParameters[DocstringSectionOtherParameters]
              griffe._internal.docstrings.models.DocstringSectionParameters[DocstringSectionParameters]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSectionParameters --> griffe.DocstringSectionOtherParameters
                                griffe._internal.docstrings.models.DocstringSection --> griffe._internal.docstrings.models.DocstringSectionParameters
                



              click griffe.DocstringSectionOtherParameters href "" "griffe.DocstringSectionOtherParameters"
              click griffe._internal.docstrings.models.DocstringSectionParameters href "" "griffe._internal.docstrings.models.DocstringSectionParameters"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents an other parameters section.

Parameters:

value ¤
(list[DocstringParameter]) –

The section parameters.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringParameter]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = other_parameters

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringParameter] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionTypeParameters ¤

DocstringSectionTypeParameters(
    value: list[DocstringTypeParameter],
    title: str | None = None,
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionTypeParameters[DocstringSectionTypeParameters]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionTypeParameters
                


              click griffe.DocstringSectionTypeParameters href "" "griffe.DocstringSectionTypeParameters"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a type parameters section.

Parameters:

value ¤
(list[DocstringTypeParameter]) –

The section type parameters.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringTypeParameter]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = type_parameters

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringTypeParameter] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionRaises ¤

DocstringSectionRaises(
    value: list[DocstringRaise], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionRaises[DocstringSectionRaises]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionRaises
                


              click griffe.DocstringSectionRaises href "" "griffe.DocstringSectionRaises"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a raises section.

Parameters:

value ¤
(list[DocstringRaise]) –

The section exceptions.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringRaise]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = raises

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringRaise] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionWarns ¤

DocstringSectionWarns(
    value: list[DocstringWarn], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionWarns[DocstringSectionWarns]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionWarns
                


              click griffe.DocstringSectionWarns href "" "griffe.DocstringSectionWarns"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a warns section.

Parameters:

value ¤
(list[DocstringWarn]) –

The section warnings.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringWarn]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = warns

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringWarn] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionReturns ¤

DocstringSectionReturns(
    value: list[DocstringReturn], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionReturns[DocstringSectionReturns]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionReturns
                


              click griffe.DocstringSectionReturns href "" "griffe.DocstringSectionReturns"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a returns section.

Parameters:

value ¤
(list[DocstringReturn]) –

The section returned items.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringReturn]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = returns

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringReturn] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionYields ¤

DocstringSectionYields(
    value: list[DocstringYield], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionYields[DocstringSectionYields]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionYields
                


              click griffe.DocstringSectionYields href "" "griffe.DocstringSectionYields"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a yields section.

Parameters:

value ¤
(list[DocstringYield]) –

The section yielded items.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringYield]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = yields

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringYield] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionReceives ¤

DocstringSectionReceives(
    value: list[DocstringReceive], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionReceives[DocstringSectionReceives]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionReceives
                


              click griffe.DocstringSectionReceives href "" "griffe.DocstringSectionReceives"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a receives section.

Parameters:

value ¤
(list[DocstringReceive]) –

The section received items.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringReceive]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = receives

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringReceive] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionExamples ¤

DocstringSectionExamples(
    value: list[tuple[Literal[text, examples], str]],
    title: str | None = None,
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionExamples[DocstringSectionExamples]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionExamples
                


              click griffe.DocstringSectionExamples href "" "griffe.DocstringSectionExamples"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents an examples section.

Parameters:

value ¤
(list[tuple[Literal[text, examples], str]]) –

The section examples.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[tuple[Literal[text, examples], str]]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = examples

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[tuple[Literal[text, examples], str]] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionAttributes ¤

DocstringSectionAttributes(
    value: list[DocstringAttribute],
    title: str | None = None,
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionAttributes[DocstringSectionAttributes]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionAttributes
                


              click griffe.DocstringSectionAttributes href "" "griffe.DocstringSectionAttributes"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents an attributes section.

Parameters:

value ¤
(list[DocstringAttribute]) –

The section attributes.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringAttribute]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = attributes

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringAttribute] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionFunctions ¤

DocstringSectionFunctions(
    value: list[DocstringFunction], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionFunctions[DocstringSectionFunctions]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionFunctions
                


              click griffe.DocstringSectionFunctions href "" "griffe.DocstringSectionFunctions"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a functions/methods section.

Parameters:

value ¤
(list[DocstringFunction]) –

The section functions.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringFunction]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = functions

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringFunction] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionClasses ¤

DocstringSectionClasses(
    value: list[DocstringClass], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionClasses[DocstringSectionClasses]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionClasses
                


              click griffe.DocstringSectionClasses href "" "griffe.DocstringSectionClasses"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a classes section.

Parameters:

value ¤
(list[DocstringClass]) –

The section classes.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringClass]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = classes

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringClass] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionTypeAliases ¤

DocstringSectionTypeAliases(
    value: list[DocstringTypeAlias],
    title: str | None = None,
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionTypeAliases[DocstringSectionTypeAliases]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionTypeAliases
                


              click griffe.DocstringSectionTypeAliases href "" "griffe.DocstringSectionTypeAliases"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a type aliases section.

Parameters:

value ¤
(list[DocstringTypeAlias]) –

The section classes.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringTypeAlias]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = type_aliases

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringTypeAlias] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionModules ¤

DocstringSectionModules(
    value: list[DocstringModule], title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionModules[DocstringSectionModules]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionModules
                


              click griffe.DocstringSectionModules href "" "griffe.DocstringSectionModules"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a modules section.

Parameters:

value ¤
(list[DocstringModule]) –

The section modules.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (list[DocstringModule]) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = modules

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: list[DocstringModule] = value

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionDeprecated ¤

DocstringSectionDeprecated(
    version: str, text: str, title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionDeprecated[DocstringSectionDeprecated]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionDeprecated
                


              click griffe.DocstringSectionDeprecated href "" "griffe.DocstringSectionDeprecated"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents a deprecated section.

Parameters:

version ¤
(str) –

The deprecation version.
text ¤
(str) –

The deprecation text.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (DocstringDeprecated) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = deprecated

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: DocstringDeprecated = DocstringDeprecated(
    annotation=version, description=text
)

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSectionAdmonition ¤

DocstringSectionAdmonition(
    kind: str, text: str, title: str | None = None
)

Bases: DocstringSection


              flowchart TD
              griffe.DocstringSectionAdmonition[DocstringSectionAdmonition]
              griffe._internal.docstrings.models.DocstringSection[DocstringSection]

                              griffe._internal.docstrings.models.DocstringSection --> griffe.DocstringSectionAdmonition
                


              click griffe.DocstringSectionAdmonition href "" "griffe.DocstringSectionAdmonition"
              click griffe._internal.docstrings.models.DocstringSection href "" "griffe._internal.docstrings.models.DocstringSection"

This class represents an admonition section.

Parameters:

kind ¤
(str) –

The admonition kind.
text ¤
(str) –

The admonition text.
title ¤
(str | None, default: None ) –

An optional title.

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (DocstringAdmonition) –

The section value.

kind `class-attribute` `instance-attribute` ¤

kind: DocstringSectionKind = admonition

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: DocstringAdmonition = DocstringAdmonition(
    annotation=kind, description=text
)

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

Advanced API: Section items¤

DocstringAdmonition ¤

DocstringAdmonition(
    *,
    description: str,
    annotation: str | Expr | None = None,
)

Bases: DocstringElement


              flowchart TD
              griffe.DocstringAdmonition[DocstringAdmonition]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringElement --> griffe.DocstringAdmonition
                


              click griffe.DocstringAdmonition href "" "griffe.DocstringAdmonition"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents an admonition.

Parameters:

annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
description ¤
(str) –

The element description.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionAdmonition value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionAdmonition value

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
contents (str) –

The contents of this admonition.
description (str) –

The element description.
kind (str | Expr | None) –

The kind of this admonition.

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

contents `property` `writable` ¤

contents: str

The contents of this admonition.

description `instance-attribute` ¤

description: str = description

The element description.

kind `property` `writable` ¤

kind: str | Expr | None

The kind of this admonition.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringDeprecated ¤

DocstringDeprecated(
    *,
    description: str,
    annotation: str | Expr | None = None,
)

Bases: DocstringElement


              flowchart TD
              griffe.DocstringDeprecated[DocstringDeprecated]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringElement --> griffe.DocstringDeprecated
                


              click griffe.DocstringDeprecated href "" "griffe.DocstringDeprecated"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented deprecated item.

Parameters:

annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
description ¤
(str) –

The element description.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionDeprecated value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionDeprecated value

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
version (str) –

The version of this deprecation.

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

version `property` `writable` ¤

version: str

The version of this deprecation.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringRaise ¤

DocstringRaise(
    *,
    description: str,
    annotation: str | Expr | None = None,
)

Bases: DocstringElement


              flowchart TD
              griffe.DocstringRaise[DocstringRaise]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringElement --> griffe.DocstringRaise
                


              click griffe.DocstringRaise href "" "griffe.DocstringRaise"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented raise value.

Parameters:

annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
description ¤
(str) –

The element description.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionRaises value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionRaises

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringWarn ¤

DocstringWarn(
    *,
    description: str,
    annotation: str | Expr | None = None,
)

Bases: DocstringElement


              flowchart TD
              griffe.DocstringWarn[DocstringWarn]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringElement --> griffe.DocstringWarn
                


              click griffe.DocstringWarn href "" "griffe.DocstringWarn"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented warn value.

Parameters:

annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
description ¤
(str) –

The element description.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionWarns value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionWarns

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringReturn ¤

DocstringReturn(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringReturn[DocstringReturn]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringReturn
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringReturn href "" "griffe.DocstringReturn"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented return value.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionReturns value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionReturns

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringYield ¤

DocstringYield(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringYield[DocstringYield]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringYield
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringYield href "" "griffe.DocstringYield"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented yield value.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionYields value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionYields

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringReceive ¤

DocstringReceive(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringReceive[DocstringReceive]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringReceive
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringReceive href "" "griffe.DocstringReceive"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented receive value.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionReceives value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionReceives

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringParameter ¤

DocstringParameter(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringParameter[DocstringParameter]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringParameter
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringParameter href "" "griffe.DocstringParameter"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represent a documented function parameter.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models
- DocstringSectionOtherParameters value
- DocstringSectionParameters value

Used by:

Reference Python API Docstrings Docstring models
- DocstringSectionOtherParameters
- DocstringSectionParameters

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
default (str | Expr | None) –

The default value of this parameter.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

default `property` `writable` ¤

default: str | Expr | None

The default value of this parameter.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringTypeParameter ¤

DocstringTypeParameter(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringTypeParameter[DocstringTypeParameter]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringTypeParameter
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringTypeParameter href "" "griffe.DocstringTypeParameter"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represent a documented type parameter.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionTypeParameters value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionTypeParameters

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
bound (str | Expr | None) –

The bound of this type parameter.
constraints (tuple[str | Expr, ...] | None) –

The constraints of this type parameter.
default (str | Expr | None) –

The default value of this type parameter.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

bound `property` `writable` ¤

bound: str | Expr | None

The bound of this type parameter.

constraints `property` `writable` ¤

constraints: tuple[str | Expr, ...] | None

The constraints of this type parameter.

default `property` `writable` ¤

default: str | Expr | None

The default value of this type parameter.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringAttribute ¤

DocstringAttribute(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringAttribute[DocstringAttribute]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringAttribute
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringAttribute href "" "griffe.DocstringAttribute"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented module/class attribute.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionAttributes value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionAttributes

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringFunction ¤

DocstringFunction(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringFunction[DocstringFunction]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringFunction
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringFunction href "" "griffe.DocstringFunction"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented function.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionFunctions value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionFunctions

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
signature (str | Expr | None) –

The function signature.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

signature `property` ¤

signature: str | Expr | None

The function signature.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringClass ¤

DocstringClass(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringClass[DocstringClass]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringClass
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringClass href "" "griffe.DocstringClass"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented class.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionClasses value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionClasses

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
signature (str | Expr | None) –

The class signature.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

signature `property` ¤

signature: str | Expr | None

The class signature.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringTypeAlias ¤

DocstringTypeAlias(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringTypeAlias[DocstringTypeAlias]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringTypeAlias
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringTypeAlias href "" "griffe.DocstringTypeAlias"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented type alias.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionTypeAliases value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionTypeAliases

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringModule ¤

DocstringModule(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringNamedElement


              flowchart TD
              griffe.DocstringModule[DocstringModule]
              griffe._internal.docstrings.models.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringNamedElement --> griffe.DocstringModule
                                griffe._internal.docstrings.models.DocstringElement --> griffe._internal.docstrings.models.DocstringNamedElement
                



              click griffe.DocstringModule href "" "griffe.DocstringModule"
              click griffe._internal.docstrings.models.DocstringNamedElement href "" "griffe._internal.docstrings.models.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This class represents a documented module.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Returned by:

Reference Python API Docstrings Docstring models DocstringSectionModules value

Used by:

Reference Python API Docstrings Docstring models DocstringSectionModules

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

Models base classes¤

DocstringElement ¤

DocstringElement(
    *,
    description: str,
    annotation: str | Expr | None = None,
)

This base class represents annotated, nameless elements.

Parameters:

annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
description ¤
(str) –

The element description.

Subclassed by:

Reference Python API Docstrings Docstring models

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringNamedElement ¤

DocstringNamedElement(
    name: str,
    *,
    description: str,
    annotation: str | Expr | None = None,
    value: str | Expr | None = None,
)

Bases: DocstringElement


              flowchart TD
              griffe.DocstringNamedElement[DocstringNamedElement]
              griffe._internal.docstrings.models.DocstringElement[DocstringElement]

                              griffe._internal.docstrings.models.DocstringElement --> griffe.DocstringNamedElement
                


              click griffe.DocstringNamedElement href "" "griffe.DocstringNamedElement"
              click griffe._internal.docstrings.models.DocstringElement href "" "griffe._internal.docstrings.models.DocstringElement"

This base class represents annotated, named elements.

Parameters:

name ¤
(str) –

The element name.
description ¤
(str) –

The element description.
annotation ¤
(str | Expr | None, default: None ) –

The element annotation, if any.
value ¤
(str | Expr | None, default: None ) –

The element value, as a string.

Subclassed by:

Reference Python API Docstrings Docstring models

Methods:

as_dict –

Return this element's data as a dictionary.

Attributes:

annotation (str | Expr | None) –

The element annotation.
description (str) –

The element description.
name (str) –

The element name.
value (str | Expr | None) –

The element value, if any

annotation `instance-attribute` ¤

annotation: str | Expr | None = annotation

The element annotation.

description `instance-attribute` ¤

description: str = description

The element description.

name `instance-attribute` ¤

name: str = name

The element name.

value `instance-attribute` ¤

value: str | Expr | None = value

The element value, if any

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this element's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

DocstringSection ¤

DocstringSection(title: str | None = None)

This class represents a docstring section.

Parameters:

title ¤
(str | None, default: None ) –

An optional title.

Returned by:

Reference Python API Docstrings
- Docstring models Docstring
  - parsed
  - parse
- Docstring parsers

Subclassed by:

Methods:

__bool__ –

Whether this section has a true-ish value.
as_dict –

Return this section's data as a dictionary.

Attributes:

kind (DocstringSectionKind) –

The section kind.
title (str | None) –

The section title.
value (Any) –

The section value.

kind `instance-attribute` ¤

kind: DocstringSectionKind

The section kind.

title `instance-attribute` ¤

title: str | None = title

The section title.

value `instance-attribute` ¤

value: Any = None

The section value.

bool ¤

__bool__() -> bool

Whether this section has a true-ish value.

as_dict ¤

as_dict(**kwargs: Any) -> dict[str, Any]

Return this section's data as a dictionary.

Parameters:

**kwargs ¤
(Any, default: {} ) –

Additional serialization options.

Returns:

dict[str, Any] –

A dictionary.

Docstring models¤

Main API¤

Docstring ¤

value ¤

lineno ¤

endlineno ¤

parent ¤

parser ¤

parser_options ¤

endlineno instance-attribute ¤

lineno instance-attribute ¤

lines property ¤

parent instance-attribute ¤

parsed cached property ¤

parser instance-attribute ¤

parser_options instance-attribute ¤

source property ¤

value instance-attribute ¤

as_dict ¤

full ¤

**kwargs ¤

parse ¤

parser ¤

**options ¤

Advanced API: Sections¤

DocstringSectionKind ¤

admonition class-attribute instance-attribute ¤

attributes class-attribute instance-attribute ¤

classes class-attribute instance-attribute ¤

deprecated class-attribute instance-attribute ¤

examples class-attribute instance-attribute ¤

functions class-attribute instance-attribute ¤

modules class-attribute instance-attribute ¤

other_parameters class-attribute instance-attribute ¤

parameters class-attribute instance-attribute ¤

raises class-attribute instance-attribute ¤

receives class-attribute instance-attribute ¤

returns class-attribute instance-attribute ¤

text class-attribute instance-attribute ¤

type_aliases class-attribute instance-attribute ¤

type_parameters class-attribute instance-attribute ¤

warns class-attribute instance-attribute ¤

yields class-attribute instance-attribute ¤

DocstringSectionText ¤

value ¤

title ¤

kind class-attribute instance-attribute ¤

title instance-attribute ¤

value instance-attribute ¤

__bool__ ¤

as_dict ¤

**kwargs ¤

DocstringSectionParameters ¤

value ¤

title ¤

kind class-attribute instance-attribute ¤

title instance-attribute ¤

value instance-attribute ¤

__bool__ ¤

as_dict ¤

**kwargs ¤

DocstringSectionOtherParameters ¤

value ¤

title ¤

kind class-attribute instance-attribute ¤

title instance-attribute ¤

value instance-attribute ¤

__bool__ ¤

as_dict ¤

**kwargs ¤

DocstringSectionTypeParameters ¤

value ¤

title ¤

kind class-attribute instance-attribute ¤

title instance-attribute ¤

value instance-attribute ¤

__bool__ ¤

as_dict ¤

**kwargs ¤

DocstringSectionRaises ¤

`value` ¤

`lineno` ¤

`endlineno` ¤

`parent` ¤

`parser` ¤

`parser_options` ¤

endlineno `instance-attribute` ¤

lineno `instance-attribute` ¤

lines `property` ¤

parent `instance-attribute` ¤

parsed `cached` `property` ¤

parser `instance-attribute` ¤

parser_options `instance-attribute` ¤

source `property` ¤

value `instance-attribute` ¤

`full` ¤

`kwargs`** ¤

`parser` ¤

`options`** ¤

admonition `class-attribute` `instance-attribute` ¤

attributes `class-attribute` `instance-attribute` ¤

classes `class-attribute` `instance-attribute` ¤

deprecated `class-attribute` `instance-attribute` ¤

examples `class-attribute` `instance-attribute` ¤

functions `class-attribute` `instance-attribute` ¤

modules `class-attribute` `instance-attribute` ¤

other_parameters `class-attribute` `instance-attribute` ¤

parameters `class-attribute` `instance-attribute` ¤

raises `class-attribute` `instance-attribute` ¤

receives `class-attribute` `instance-attribute` ¤

returns `class-attribute` `instance-attribute` ¤

text `class-attribute` `instance-attribute` ¤

type_aliases `class-attribute` `instance-attribute` ¤

type_parameters `class-attribute` `instance-attribute` ¤

warns `class-attribute` `instance-attribute` ¤

yields `class-attribute` `instance-attribute` ¤

`value` ¤

`title` ¤

kind `class-attribute` `instance-attribute` ¤

title `instance-attribute` ¤

value `instance-attribute` ¤

bool ¤

`kwargs`** ¤

`value` ¤

`title` ¤

kind `class-attribute` `instance-attribute` ¤

title `instance-attribute` ¤

value `instance-attribute` ¤

bool ¤

`kwargs`** ¤

`value` ¤

`title` ¤

kind `class-attribute` `instance-attribute` ¤

title `instance-attribute` ¤

value `instance-attribute` ¤

bool ¤

`kwargs`** ¤

`value` ¤

`title` ¤

kind `class-attribute` `instance-attribute` ¤

title `instance-attribute` ¤

value `instance-attribute` ¤

bool ¤

`kwargs`** ¤

`value` ¤

`title` ¤

kind `class-attribute` `instance-attribute` ¤

title `instance-attribute` ¤

value `instance-attribute` ¤

bool ¤

`kwargs`** ¤

`value` ¤

`title` ¤

kind `class-attribute` `instance-attribute` ¤

title `instance-attribute` ¤

value `instance-attribute` ¤

bool ¤

`kwargs`** ¤

`value` ¤

`title` ¤