Docstring models¤

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 ¤

  (dict[str, Any] | None, default: None ) –

  Additional docstring parsing options.

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 (dict[str, Any]) –

  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: int | None = endlineno

lineno: int | None = lineno

lines: list[str]

parent: Object | None = parent

parsed: list[DocstringSection]

parser: DocstringStyle | Parser | None = parser

parser_options: dict[str, Any] = parser_options or {}

source: str

value: str = cleandoc(rstrip())

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

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

              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.

• warns –

  Warnings section.

• yields –

  Yielded value(s) (generators) section.

admonition = 'admonition'

attributes = 'attributes'

classes = 'classes'

deprecated = 'deprecated'

examples = 'examples'

functions = 'functions'

modules = 'modules'

other_parameters = 'other parameters'

parameters = 'parameters'

raises = 'raises'

receives = 'receives'

returns = 'returns'

text = 'text'

warns = 'warns'

yields = 'yields'

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

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


              click griffe.DocstringSectionText href "" "griffe.DocstringSectionText"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = text

title: str | None = title

value: str = value

__bool__() -> bool

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

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

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


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

This class represents a 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: DocstringSectionKind = parameters

title: str | None = title

value: list[DocstringParameter] = value

__bool__() -> bool

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

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

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



              click griffe.DocstringSectionOtherParameters href "" "griffe.DocstringSectionOtherParameters"
              click _griffe.docstrings.models.DocstringSectionParameters href "" "_griffe.docstrings.models.DocstringSectionParameters"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = other_parameters

title: str | None = title

value: list[DocstringParameter] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionRaises href "" "griffe.DocstringSectionRaises"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = raises

title: str | None = title

value: list[DocstringRaise] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionWarns href "" "griffe.DocstringSectionWarns"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = warns

title: str | None = title

value: list[DocstringWarn] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionReturns href "" "griffe.DocstringSectionReturns"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = returns

title: str | None = title

value: list[DocstringReturn] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionYields href "" "griffe.DocstringSectionYields"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = yields

title: str | None = title

value: list[DocstringYield] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionReceives href "" "griffe.DocstringSectionReceives"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = receives

title: str | None = title

value: list[DocstringReceive] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionExamples href "" "griffe.DocstringSectionExamples"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = examples

title: str | None = title

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

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionAttributes href "" "griffe.DocstringSectionAttributes"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = attributes

title: str | None = title

value: list[DocstringAttribute] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionFunctions href "" "griffe.DocstringSectionFunctions"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = functions

title: str | None = title

value: list[DocstringFunction] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionClasses href "" "griffe.DocstringSectionClasses"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = classes

title: str | None = title

value: list[DocstringClass] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionModules href "" "griffe.DocstringSectionModules"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = modules

title: str | None = title

value: list[DocstringModule] = value

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionDeprecated href "" "griffe.DocstringSectionDeprecated"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = deprecated

title: str | None = title

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

__bool__() -> bool

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

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

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


              click griffe.DocstringSectionAdmonition href "" "griffe.DocstringSectionAdmonition"
              click _griffe.docstrings.models.DocstringSection href "" "_griffe.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: DocstringSectionKind = admonition

title: str | None = title

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

__bool__() -> bool

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

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

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


              click griffe.DocstringAdmonition href "" "griffe.DocstringAdmonition"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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.

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: str | Expr | None = annotation

contents: str

description: str = description

kind: str | Expr | None

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

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

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


              click griffe.DocstringDeprecated href "" "griffe.DocstringDeprecated"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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.

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: str | Expr | None = annotation

description: str = description

version: str

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

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

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


              click griffe.DocstringRaise href "" "griffe.DocstringRaise"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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.

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: str | Expr | None = annotation

description: str = description

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

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

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


              click griffe.DocstringWarn href "" "griffe.DocstringWarn"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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.

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: str | Expr | None = annotation

description: str = description

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

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

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



              click griffe.DocstringReturn href "" "griffe.DocstringReturn"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

value: str | None = value

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

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

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



              click griffe.DocstringYield href "" "griffe.DocstringYield"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

value: str | None = value

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

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

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



              click griffe.DocstringReceive href "" "griffe.DocstringReceive"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

value: str | None = value

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

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

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



              click griffe.DocstringParameter href "" "griffe.DocstringParameter"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

Methods:

• as_dict –

  Return this element's data as a dictionary.

Attributes:

• annotation (str | Expr | None) –

  The element annotation.

• default (str | None) –

  The default value of this parameter.

• description (str) –

  The element description.

• name (str) –

  The element name.

• value (str | None) –

  The element value, if any

annotation: str | Expr | None = annotation

default: str | None

description: str = description

name: str = name

value: str | None = value

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

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

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



              click griffe.DocstringAttribute href "" "griffe.DocstringAttribute"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

value: str | None = value

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

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

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



              click griffe.DocstringFunction href "" "griffe.DocstringFunction"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

signature: str | Expr | None

value: str | None = value

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

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

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



              click griffe.DocstringClass href "" "griffe.DocstringClass"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

signature: str | Expr | None

value: str | None = value

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

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

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



              click griffe.DocstringModule href "" "griffe.DocstringModule"
              click _griffe.docstrings.models.DocstringNamedElement href "" "_griffe.docstrings.models.DocstringNamedElement"
              click _griffe.docstrings.models.DocstringElement href "" "_griffe.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 | None, default: None ) –

  The element value, as a string.

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 | None) –

  The element value, if any

annotation: str | Expr | None = annotation

description: str = description

name: str = name

value: str | None = value

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