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 ¤

  (DocstringOptions | 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 (DocstringOptions) –

  The configured parsing options.

• source (str) –

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

• value (str) –

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

 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

def __init__(
    self,
    value: str,
    *,
    lineno: int | None = None,
    endlineno: int | None = None,
    parent: Object | None = None,
    parser: DocstringStyle | Parser | None = None,
    parser_options: DocstringOptions | None = None,
) -> None:
    """Initialize the docstring.

    Parameters:
        value: The docstring value.
        lineno: The starting line number.
        endlineno: The ending line number.
        parent: The parent object on which this docstring is attached.
        parser: The docstring parser to use. By default, no parsing is done.
        parser_options: Additional docstring parsing options.
    """
    self.value: str = inspect.cleandoc(value.rstrip())
    """The original value of the docstring, cleaned by `inspect.cleandoc`.

    See also: [`source`][griffe.Docstring.source].
    """

    self.lineno: int | None = lineno
    """The starting line number of the docstring.

    See also: [`endlineno`][griffe.Docstring.endlineno]."""

    self.endlineno: int | None = endlineno
    """The ending line number of the docstring.

    See also: [`lineno`][griffe.Docstring.lineno]."""

    self.parent: Object | None = parent
    """The object this docstring is attached to."""

    self.parser: DocstringStyle | Parser | None = parser
    """The selected docstring parser.

    See also: [`parser_options`][griffe.Docstring.parser_options],
    [`parse`][griffe.Docstring.parse].
    """

    self.parser_options: DocstringOptions = parser_options or {}
    """The configured parsing options.

    See also: [`parser`][griffe.Docstring.parser],
    [`parse`][griffe.Docstring.parse].
    """

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: DocstringOptions = parser_options or {}

source: str

value: str = inspect.cleandoc(value.rstrip())

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

201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

def as_dict(
    self,
    *,
    full: bool = False,
    **kwargs: Any,  # noqa: ARG002
) -> dict[str, Any]:
    """Return this docstring's data as a dictionary.

    Parameters:
        full: Whether to return full info, or just base info.
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    base: dict[str, Any] = {
        "value": self.value,
        "lineno": self.lineno,
        "endlineno": self.endlineno,
    }
    if full:
        base["parsed"] = self.parsed
    return base

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

181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

def parse(
    self,
    parser: DocstringStyle | Parser | None = None,
    **options: Any,
) -> list[DocstringSection]:
    """Parse the docstring into structured data.

    See also: [`parser`][griffe.Docstring.parser],
    [`parser_options`][griffe.Docstring.parser_options].

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

    Returns:
        The parsed docstring as a list of sections.
    """
    return parse(self, parser or self.parser, **(options or self.parser_options))

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'

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'

type_aliases = 'type aliases'

type_parameters = 'type parameters'

warns = 'warns'

yields = 'yields'

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.

286
287
288
289
290
291
292
293
294

def __init__(self, value: str, title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section text.
        title: An optional title.
    """
    super().__init__(title)
    self.value: str = value

kind: DocstringSectionKind = DocstringSectionKind.text

title: str | None = title

value: str = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

302
303
304
305
306
307
308
309
310

def __init__(self, value: list[DocstringParameter], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section parameters.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringParameter] = value

kind: DocstringSectionKind = DocstringSectionKind.parameters

title: str | None = title

value: list[DocstringParameter] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

302
303
304
305
306
307
308
309
310

def __init__(self, value: list[DocstringParameter], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section parameters.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringParameter] = value

kind: DocstringSectionKind = (
    DocstringSectionKind.other_parameters
)

title: str | None = title

value: list[DocstringParameter] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

324
325
326
327
328
329
330
331
332

def __init__(self, value: list[DocstringTypeParameter], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section type parameters.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringTypeParameter] = value

kind: DocstringSectionKind = (
    DocstringSectionKind.type_parameters
)

title: str | None = title

value: list[DocstringTypeParameter] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

340
341
342
343
344
345
346
347
348

def __init__(self, value: list[DocstringRaise], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section exceptions.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringRaise] = value

kind: DocstringSectionKind = DocstringSectionKind.raises

title: str | None = title

value: list[DocstringRaise] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

356
357
358
359
360
361
362
363
364

def __init__(self, value: list[DocstringWarn], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section warnings.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringWarn] = value

kind: DocstringSectionKind = DocstringSectionKind.warns

title: str | None = title

value: list[DocstringWarn] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

372
373
374
375
376
377
378
379
380

def __init__(self, value: list[DocstringReturn], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section returned items.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringReturn] = value

kind: DocstringSectionKind = DocstringSectionKind.returns

title: str | None = title

value: list[DocstringReturn] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

388
389
390
391
392
393
394
395
396

def __init__(self, value: list[DocstringYield], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section yielded items.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringYield] = value

kind: DocstringSectionKind = DocstringSectionKind.yields

title: str | None = title

value: list[DocstringYield] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

404
405
406
407
408
409
410
411
412

def __init__(self, value: list[DocstringReceive], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section received items.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringReceive] = value

kind: DocstringSectionKind = DocstringSectionKind.receives

title: str | None = title

value: list[DocstringReceive] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

420
421
422
423
424
425
426
427
428
429
430
431
432

def __init__(
    self,
    value: list[tuple[Literal[DocstringSectionKind.text, DocstringSectionKind.examples], str]],
    title: str | None = None,
) -> None:
    """Initialize the section.

    Parameters:
        value: The section examples.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[tuple[Literal[DocstringSectionKind.text, DocstringSectionKind.examples], str]] = value

kind: DocstringSectionKind = DocstringSectionKind.examples

title: str | None = title

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

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

440
441
442
443
444
445
446
447
448

def __init__(self, value: list[DocstringAttribute], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section attributes.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringAttribute] = value

kind: DocstringSectionKind = DocstringSectionKind.attributes

title: str | None = title

value: list[DocstringAttribute] = value

__bool__() -> bool

258
259
260

def __bool__(self) -> bool:
    """Whether this section has a true-ish value."""
    return bool(self.value)

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

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278

def as_dict(self, **kwargs: Any) -> dict[str, Any]:
    """Return this section's data as a dictionary.

    Parameters:
        **kwargs: Additional serialization options.

    Returns:
        A dictionary.
    """
    if hasattr(self.value, "as_dict"):  # noqa: SIM108
        serialized_value = self.value.as_dict(**kwargs)
    else:
        serialized_value = self.value
    base = {"kind": self.kind.value, "value": serialized_value}
    if self.title:
        base["title"] = self.title
    return base

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.

456
457
458
459
460
461
462
463
464

def __init__(self, value: list[DocstringFunction], title: str | None = None) -> None:
    """Initialize the section.

    Parameters:
        value: The section functions.
        title: An optional title.
    """
    super().__init__(title)
    self.value: list[DocstringFunction] = value