Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://mkdocstrings.github.io/griffe/reference/api/docstrings/models/ below:

Models - Griffe

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.

The ending line number of the docstring.

See also: lineno.

The starting line number of the docstring.

See also: endlineno.

The lines of the docstring.

See also: source.

The object this docstring is attached to.

The docstring sections, parsed into structured data.

The configured parsing options.

See also: parser, parse.

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

See also: value.

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

See also: source.

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 the docstring into structured data.

See also: parser, parser_options.

Parameters:

• parser ¤ (DocstringStyle | Parser | None, default: None ) –

  The docstring parser to use. In order: use the given parser, or the self parser, or no parser (return a single text section).

• **options ¤ (Any, default: {} ) –

  Additional docstring parsing options.

Returns:

• list[DocstringSection] –

  The parsed docstring as a list of sections.

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 = 'admonition'

Admonition block.

attributes = 'attributes'

Attributes section.

Classes section.

deprecated = 'deprecated'

Deprecation section.

Examples section.

Functions section.

Modules section.

other_parameters = 'other parameters'

Other parameters (keyword arguments) section.

parameters = 'parameters'

Parameters section.

Raises (exceptions) section.

Received value(s) (generators) section.

Returned value(s) section.

Text section.

type_aliases = 'type aliases'

Type aliases section.

type_parameters = 'type parameters'

Type parameters section.

Warnings section.

Yielded value(s) (generators) section.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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.

The element annotation.

The contents of this admonition.

The element description.

The kind of this admonition.

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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.

The element annotation.

The element description.

The version of this deprecation.

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

Methods:

• as_dict –

  Return this element's data as a dictionary.

Attributes:

• annotation (str | Expr | None) –

  The element annotation.

• description (str) –

  The element description.

The element annotation.

The element description.

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

Methods:

• as_dict –

  Return this element's data as a dictionary.

Attributes:

• annotation (str | Expr | None) –

  The element annotation.

• description (str) –

  The element description.

The element annotation.

The element description.

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The default value of this parameter.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The bound of this type parameter.

The constraints of this type parameter.

The default value of this type parameter.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The function signature.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The class signature.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

This base class represents annotated, nameless elements.

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.

The element annotation.

The element description.

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

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.

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

The element annotation.

The element description.

The element name.

The element value, if any

Return this element's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

DocstringSection(title: str | None = None)

This class represents a docstring 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 (Any) –

  The section value.

The section kind.

The section title.

The section value.

Whether this section has a true-ish value.

Return this section's data as a dictionary.

Parameters:

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

  Additional serialization options.

Returns:

• dict[str, Any] –

  A dictionary.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4