-hI4ddlmZddlmZddlmZerddlmZmZddlm Z GddZ Gdd e Z Gd d e Z Gd d e Z Gdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGd d!e ZGd"d#ZGd$d%eZGd&d'eZGd(d)eZGd*d+eZGd,d-eZGd.d/eZGd0d1eZGd2d3eZ Gd4d5eZ!Gd6d7eZ"Gd8d9eZ#Gd:d;eZ$Gd<d=eZ%Gd>d?eZ&Gd@dAeZ'dBS)C) annotations) TYPE_CHECKING)DocstringSectionKind)AnyLiteral)Exprc(eZdZdZdddd ZddZdS)DocstringElementz8This base class represents annotated, nameless elements.N annotation descriptionstrr str | Expr | NonereturnNonec$||_ ||_dS)zInitialize the element. Parameters: annotation: The element annotation, if any. description: The element description. Nr r )selfr r s V/var/www/FlaskApp/flask-venv/lib/python3.11/site-packages/_griffe/docstrings/models.py__init__zDocstringElement.__init__s!,&-7%%kwargsrdict[str, Any]c  |j|jdS)Return this element's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. r r r)rrs ras_dictzDocstringElement.as_dicts/+   r)r rr rrrrrrr)__name__ __module__ __qualname____doc__rrrrr r sOBBLP & & & & & &       rr c8eZdZdZddddfd Zdfd ZxZS)DocstringNamedElementz5This base class represents annotated, named elements.N)r valuenamerr r rr& str | Nonerrclt||||_ ||_dS)zInitialize the element. Parameters: name: The element name. description: The element description. annotation: The element annotation, if any. value: The element value, as a string. rN)superrr'r&)rr'r r r& __class__s rrzDocstringNamedElement.__init__1s9 [ZHHH !& ''rrrrc nd|jitjdi|}|j |j|d<|S)rr'Nr&r#)r'r*rr&)rrbaser+s rrzDocstringNamedElement.as_dictGsD ?_UWW_%>%>v%>%>? : ! JDM r) r'rr rr rr&r(rrr)rr r!r"rr __classcell__r+s@rr%r%.ss??)- ((((((((,          rr%ceZdZdZed dZejddZedd Zejdd Zd S)DocstringAdmonitionz$This class represents an admonition.rrc|jS)zThe kind of this admonition.r rs rkindzDocstringAdmonition.kindY rr& str | Exprrc||_dSNr rr&s rr4zDocstringAdmonition.kind^ rrc|jS)z The contents of this admonition.r r3s rcontentszDocstringAdmonition.contentsbs rc||_dSr8r<r9s rr=zDocstringAdmonition.contentsgs rNrr)r&r6rrrrr&rrr)rr r!r"propertyr4setterr=r#rrr1r1Vs.. X [   [    X _!!!_!!!rr1cLeZdZdZed dZejd dZdS) DocstringDeprecatedz3This class represents a documented deprecated item.rrc|jS)z The version of this deprecation.r r3s rversionzDocstringDeprecated.versionor5rr&rc||_dSr8r r9s rrGzDocstringDeprecated.versiontr:rNr@rA)rr r!r"rBrGrCr#rrrErElsZ== X ^   ^   rrEceZdZdZdS)DocstringRaisez/This class represents a documented raise value.Nrr r!r"r#rrrJrJy9999rrJceZdZdZdS) DocstringWarnz.This class represents a documented warn value.NrKr#rrrNrN}s8888rrNceZdZdZdS)DocstringReturnz0This class represents a documented return value.NrKr#rrrPrPs::::rrPceZdZdZdS)DocstringYieldz/This class represents a documented yield value.NrKr#rrrRrRrLrrRceZdZdZdS)DocstringReceivez1This class represents a documented receive value.NrKr#rrrTrTs;;;;rrTcLeZdZdZed dZejd dZd S) DocstringParameterz5This class represent a documented function parameter.rr(c|jS)z$The default value of this parameter.r&r3s rdefaultzDocstringParameter.defaults zrr&rrc||_dSr8rXr9s rrYzDocstringParameter.defaults  rN)rr(rA)rr r!r"rBrYrCr#rrrVrVsZ?? X ^^rrVceZdZdZdS)DocstringAttributez:This class represents a documented module/class attribute.NrKr#rrr\r\sDDDDrr\c*eZdZdZeddZdS)DocstringFunctionz,This class represents a documented function.rrc|jS)zThe function signature.r r3s r signaturezDocstringFunction.signaturer5rNr?rr r!r"rBr`r#rrr^r^s866 Xrr^c*eZdZdZeddZdS)DocstringClassz)This class represents a documented class.rrc|jS)zThe class signature.r r3s rr`zDocstringClass.signaturer5rNr?rar#rrrcrcs833 XrrcceZdZdZdS)DocstringModulez*This class represents a documented module.NrKr#rrrfrfs4444rrfc:eZdZUdZded< ddd Zdd ZddZdS)DocstringSectionz*This class represents a docstring section.rr4Ntitler(rrc$||_ d|_dS)z[Initialize the section. Parameters: title: An optional title. N)rir&)rris rrzDocstringSection.__init__s "'     rboolc*t|jS)z*Whether this section has a true-ish value.)rkr&r3s r__bool__zDocstringSection.__bool__sDJrrrrc t|jdr|jjdi|}n|j}|jj|d}|jr |j|d<|S)zReturn this section's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. r)r4r&rir#)hasattrr&rr4ri)rrserialized_valuer-s rrzDocstringSection.as_dictsj 4:y ) ) *1tz1;;F;;  #z  2BCC : ' JDM rr8)rir(rr)rrkr)rr r!r"__annotations__rrmrr#rrrhrhsl44 ! ! ! ! !    rrhc@eZdZUdZejZded<d d fd ZxZ S)DocstringSectionTextz%This class represents a text section.rr4Nr&rrir(rrcXt|||_dS)zInitialize the section. Parameters: value: The section text. title: An optional title. Nr*rr&rr&rir+s rrzDocstringSectionText.__init__s(  rr8)r&rrir(rr) rr r!r"rtextr4rqrr.r/s@rrsrss^//!5!:D::::           rrsc@eZdZUdZejZded<d d fd ZxZ S)DocstringSectionParametersz+This class represents a parameters section.rr4Nr&list[DocstringParameter]rir(rrcXt|||_dS)zInitialize the section. Parameters: value: The section parameters. title: An optional title. Nrurvs rrz#DocstringSectionParameters.__init__( /4 rr8)r&rzrir(rr) rr r!r"r parametersr4rqrr.r/s@rryrys^55!5!@D@@@@55555555555rryc,eZdZUdZejZded<dS)DocstringSectionOtherParametersz2This class represents an other parameters section.rr4N)rr r!r"rother_parametersr4rqr#rrrrs,<D>>>>33333333333rrcBeZdZUdZejZded< d d fd ZxZ S)DocstringSectionExamplesz*This class represents an examples section.rr4Nr&Slist[tuple[Literal[DocstringSectionKind.text, DocstringSectionKind.examples], str]]rir(rrcXt|||_dS)zInitialize the section. Parameters: value: The section examples. title: An optional title. Nrurvs rrz!DocstringSectionExamples.__init__Xs( jo rr8)r&rrir(rr) rr r!r"rexamplesr4rqrr.r/s@rrrSsn44!5!>D>>>> ! p p p p p p p p p p prrc@eZdZUdZejZded<d d fd ZxZ S)DocstringSectionAttributesz,This class represents an attributes section.rr4Nr&list[DocstringAttribute]rir(rrcXt|||_dS)zInitialize the section. Parameters: value: The section attributes. title: An optional title. Nrurvs rrz#DocstringSectionAttributes.__init__lr|rr8)r&rrir(rr) rr r!r"r attributesr4rqrr.r/s@rrrgs^66!5!@D@@@@55555555555rrc@eZdZUdZejZded<d d fd ZxZ S)DocstringSectionFunctionsz2This class represents a functions/methods section.rr4Nr&list[DocstringFunction]rir(rrcXt|||_dS)zInitialize the section. Parameters: value: The section functions. title: An optional title. Nrurvs rrz"DocstringSectionFunctions.__init__|s( .3 rr8)r&rrir(rr) rr r!r"r functionsr4rqrr.r/s@rrrws^<rs#""""" 555555)########((((((        <%%%%%,%%%P!!!!!*!!!,      *    :::::%:::99999$999;;;;;+;;;:::::*:::<<<<<,<<<     .   EEEEE.EEE-*55555+555 %%%%%%%%P      +    5 5 5 5 5!1 5 5 5 GGGGG&@GGG 1 1 1 1 1- 1 1 1 0 0 0 0 0, 0 0 0 2 2 2 2 2. 2 2 2 1 1 1 1 1- 1 1 1 3 3 3 3 3/ 3 3 3 ppppp/ppp( 5 5 5 5 5!1 5 5 5 4 4 4 4 4 0 4 4 4 1 1 1 1 1. 1 1 1 2 2 2 2 2. 2 2 2 ddddd!1ddd"aaaaa!1aaaaar