gI4ddlmZddlmZddlmZerddlmZmZddlm 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'yB)C) annotations) TYPE_CHECKING)DocstringSectionKind)AnyLiteral)Exprc&eZdZdZddddZddZy)DocstringElementz8This base class represents annotated, nameless elements.N annotationc"||_ ||_y)zInitialize the element. Parameters: annotation: The element annotation, if any. description: The element description. N descriptionr )selfrr s N/var/www/openai/venv/lib/python3.12/site-packages/_griffe/docstrings/models.py__init__zDocstringElement.__init__s!,&-7%c 4|j|jdS)Return this element's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. r rr)rkwargss ras_dictzDocstringElement.as_dicts//++  r)rstrr str | Expr | NonereturnNonerrrzdict[str, Any])__name__ __module__ __qualname____doc__rrrrr r sBLP &  rr cJeZdZdZddd dfdZdfd ZxZS)DocstringNamedElementz5This base class represents annotated, named elements.N)r valuecFt|||||_ ||_y)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)superrnamer%)rr(rr r% __class__s rrzDocstringNamedElement.__init__1s+ [ZH !& 'rc xd|jit|di|}|j|j|d<|S)rr(r%r")r(r'rr%)rrbaser)s rrzDocstringNamedElement.as_dictGs@ ?UW_%>v%>? :: ! JJDM r) r(rrrr rr% str | Nonerrr)rrr r!rr __classcell__r)s@rr$r$.sM?)- (( ( & (  ( (,  rr$ceZdZdZeddZej ddZed dZej d dZy) DocstringAdmonitionz$This class represents an admonition.c|jS)zThe kind of this admonition.r rs rkindzDocstringAdmonition.kindYrc||_yNr rr%s rr3zDocstringAdmonition.kind^ rc|jS)z The contents of this admonition.rr2s rcontentszDocstringAdmonition.contentsbsrc||_yr6r:r7s rr;zDocstringAdmonition.contentsgs  rNrr)r%z str | Exprrrrrr%rrr)rrr r!propertyr3setterr;r"rrr0r0Vs[.  [[    __!!rr0cHeZdZdZeddZej ddZy)DocstringDeprecatedz3This class represents a documented deprecated item.c|jS)z The version of this deprecation.r r2s rversionzDocstringDeprecated.versionor4rc||_yr6r r7s rrEzDocstringDeprecated.versiontr8rNr>r?)rrr r!r@rErAr"rrrCrCls/=  ^^  rrCceZdZdZy)DocstringRaisez/This class represents a documented raise value.Nrrr r!r"rrrHrHy9rrHceZdZdZy) DocstringWarnz.This class represents a documented warn value.NrIr"rrrLrL}s8rrLceZdZdZy)DocstringReturnz0This class represents a documented return value.NrIr"rrrNrNs:rrNceZdZdZy)DocstringYieldz/This class represents a documented yield value.NrIr"rrrPrPrJrrPceZdZdZy)DocstringReceivez1This class represents a documented receive value.NrIr"rrrRrRs;rrRcHeZdZdZeddZej ddZy)DocstringParameterz5This class represent a documented function parameter.c|jS)z$The default value of this parameter.r%r2s rdefaultzDocstringParameter.defaultszzrc||_yr6rVr7s rrWzDocstringParameter.defaults  rN)rr,r?)rrr r!r@rWrAr"rrrTrTs/?  ^^rrTceZdZdZy)DocstringAttributez:This class represents a documented module/class attribute.NrIr"rrrZrZsDrrZc"eZdZdZeddZy)DocstringFunctionz,This class represents a documented function.c|jS)zThe function signature.r r2s r signaturezDocstringFunction.signaturer4rNr=rrr r!r@r^r"rrr\r\s6 rr\c"eZdZdZeddZy)DocstringClassz)This class represents a documented class.c|jS)zThe class signature.r r2s rr^zDocstringClass.signaturer4rNr=r_r"rrraras3 rraceZdZdZy)DocstringModulez*This class represents a documented module.NrIr"rrrdrds4rrdc8eZdZUdZded< dd dZd dZd dZy) DocstringSectionz*This class represents a docstring section.rr3Nc"||_ d|_y)z[Initialize the section. Parameters: title: An optional title. N)titler%)rrhs rrzDocstringSection.__init__s "'    rc,t|jS)z*Whether this section has a true-ish value.)boolr%r2s r__bool__zDocstringSection.__bool__sDJJrc 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)r3r%rhr")hasattrr%rr3rh)rrserialized_valuer+s rrzDocstringSection.as_dictsb 4::y )1tzz11;F; #zz  2BC :: JJDM rr6)rhr,rr)rrjr)rrr r!__annotations__rrkrr"rrrfrfs4  ! rrfcJeZdZUdZej Zded<ddfd ZxZ S)DocstringSectionTextz%This class represents a text section.rr3c2t||||_y)zInitialize the section. Parameters: value: The section text. title: An optional title. Nr'rr%rr%rhr)s rrzDocstringSectionText.__init__s  rr6)r%rrhr,rr) rrr r!rtextr3rorr-r.s@rrqrqs!/!5!:!:D :  rrqcJeZdZUdZej Zded<ddfd ZxZ S)DocstringSectionParametersz+This class represents a parameters section.rr3c2t||||_y)zInitialize the section. Parameters: value: The section parameters. title: An optional title. Nrsrts rrz#DocstringSectionParameters.__init__ /4 rr6)r%zlist[DocstringParameter]rhr,rr) rrr r!r parametersr3rorr-r.s@rrwrws!5!5!@!@D @55rrwc4eZdZUdZej Zded<y)DocstringSectionOtherParametersz2This class represents an other parameters section.rr3N)rrr r!rother_parametersr3ror"rrr|r|s!>D >33rrcVeZdZUdZej Zded< d dfd ZxZ S)DocstringSectionExamplesz*This class represents an examples section.rr3c2t||||_y)zInitialize the section. Parameters: value: The section examples. title: An optional title. Nrsrts rrz!DocstringSectionExamples.__init__Xs jo rr6)r%zSlist[tuple[Literal[DocstringSectionKind.text, DocstringSectionKind.examples], str]]rhr,rr) rrr r!rexamplesr3rorr-r.s@rrrSsG4!5!>!>D > ! pb p p  p prrcJeZdZUdZej Zded<ddfd ZxZ S)DocstringSectionAttributesz,This class represents an attributes section.rr3c2t||||_y)zInitialize the section. Parameters: value: The section attributes. title: An optional title. Nrsrts rrz#DocstringSectionAttributes.__init__lryrr6)r%zlist[DocstringAttribute]rhr,rr) rrr r!r attributesr3rorr-r.s@rrrgs!6!5!@!@D @55rrcJeZdZUdZej Zded<ddfd ZxZ S)DocstringSectionFunctionsz2This class represents a functions/methods section.rr3c2t||||_y)zInitialize the section. Parameters: value: The section functions. title: An optional title. Nrsrts rrz"DocstringSectionFunctions.__init__|s .3 rr6)r%zlist[DocstringFunction]rhr,rr) rrr r!r functionsr3rorr-r.s@rrrws!rs# 5#(  <%,%P!*!,  *  :%:9$9;+;:*:<,< . E.E-*5+5 %%P  +  5!1 5 G&@G 1- 1 0, 0 2. 2 1- 1 3/ 3 p/p( 5!1 5 4 0 4 1. 1 2. 2 d!1d"a!1ar