o h=@s|ddlmZddlmZddlmZddlmZer.ddlm Z ddlm Z m Z ddlm Z Gdd d Z Gd d d e ZGd d d e ZGddde ZGddde ZGddde ZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGd d!d!eZGd"d#d#eZGd$d%d%eZGd&d'd'eZGd(d)d)ZGd*d+d+eZGd,d-d-eZGd.d/d/eZ Gd0d1d1eZ!Gd2d3d3eZ"Gd4d5d5eZ#Gd6d7d7eZ$Gd8d9d9eZ%Gd:d;d;eZ&Gdd?d?eZ(Gd@dAdAeZ)GdBdCdCeZ*GdDdEdEeZ+GdFdGdGeZ,GdHdIdIeZ-GdJdKdKeZ.dLS)M) annotations) TYPE_CHECKING)DocstringSectionKind) ExprTuple)Sequence)AnyLiteral)Exprc@s*eZdZdZdddd d ZdddZdS)DocstringElementz8This base class represents annotated, nameless elements.N annotation descriptionstrr str | Expr | NonereturnNonecCs||_ ||_dS)zInitialize the element. Parameters: annotation: The element annotation, if any. description: The element description. Nr r )selfr r rc/var/www/html/openai_agents/venv/lib/python3.10/site-packages/griffe/_internal/docstrings/models.py__init__szDocstringElement.__init__kwargsrdict[str, Any]cKs|j|jdS)Return this element's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. r r r)rrrrras_dict!s zDocstringElement.as_dict)r rr rrrrrrr)__name__ __module__ __qualname____doc__rrrrrrr s r cs8eZdZdZddddfd d Zdfdd ZZS)DocstringNamedElementz5This base class represents annotated, named elements.N)r valuenamerr r rr"rrcs"tj||d||_ ||_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__rrr3s zDocstringNamedElement.__init__rrrc s4d|jitjdi|}|jdur|j|d<|S)rr#Nr"r)r#r$rr")rrbaser%rrrIs  zDocstringNamedElement.as_dict) r#rr rr rr"rrrr)rrrr rr __classcell__rrr%rr!0s r!c@sLeZdZdZedddZejdd dZedd d Zejdd d ZdS)DocstringAdmonitionz$This class represents an admonition.rrcC|jS)zThe kind of this admonition.r rrrrkind[zDocstringAdmonition.kindr" str | ExprrcC ||_dSNr rr"rrrr,` rcCr*)z The contents of this admonition.r r+rrrcontentsdr-zDocstringAdmonition.contentscCr/r0r3r1rrrr4ir2Nrr)r"r.rrrrr"rrr)rrrr propertyr,setterr4rrrrr)Xs   r)c@s.eZdZdZed ddZejd ddZd S) DocstringDeprecatedz3This class represents a documented deprecated item.rrcCr*)z The version of this deprecation.r r+rrrversionqr-zDocstringDeprecated.versionr"rcCr/r0r r1rrrr;vr2Nr6r7)rrrr r8r;r9rrrrr:n  r:c@eZdZdZdS)DocstringRaisez/This class represents a documented raise value.Nrrrr rrrrr>{r>c@r=) DocstringWarnz.This class represents a documented warn value.Nr?rrrrrAr@rAc@r=)DocstringReturnz0This class represents a documented return value.Nr?rrrrrBr@rBc@r=)DocstringYieldz/This class represents a documented yield value.Nr?rrrrrCr@rCc@r=)DocstringReceivez1This class represents a documented receive value.Nr?rrrrrDr@rDc@s.eZdZdZed ddZejd d dZd S) DocstringParameterz5This class represent a documented function parameter.rrcCr*)z$The default value of this parameter.r"r+rrrdefaultr-zDocstringParameter.defaultr"rrcCr/r0rFr1rrrrGr2Nr5r7)rrrr r8rGr9rrrrrEr<rEc@sjeZdZdZedddZejdd dZedd d Zejdd d ZedddZejdddZdS)DocstringTypeParameterz1This class represent a documented type parameter.rrcCr*)z)The default value of this type parameter.rFr+rrrrGr-zDocstringTypeParameter.defaultr"rrcCr/r0rFr1rrrrGr2cCst|jts |jSdS)z!The bound of this type parameter.N) isinstancer rr+rrrbounds zDocstringTypeParameter.boundrJcCr/r0r )rrJrrrrJr2tuple[str | Expr, ...] | NonecCst|jtr t|jjSdS)z'The constraints of this type parameter.N)rIr rtupleelementsr+rrr constraintss  z"DocstringTypeParameter.constraintsrNSequence[str | Expr] | NonecCs |dur t||_dSd|_dSr0)rr )rrNrrrrNs Nr5r7)rJrrr)rrK)rNrOrr) rrrr r8rGr9rJrNrrrrrHs     rHc@r=)DocstringAttributez:This class represents a documented module/class attribute.Nr?rrrrrPr@rPc@eZdZdZedddZdS)DocstringFunctionz,This class represents a documented function.rrcCr*)zThe function signature.r r+rrr signaturer-zDocstringFunction.signatureNr5rrrr r8rSrrrrrRrRc@rQ)DocstringClassz)This class represents a documented class.rrcCr*)zThe class signature.r r+rrrrSr-zDocstringClass.signatureNr5rTrrrrrVrUrVc@r=)DocstringTypeAliasz.This class represents a documented type alias.Nr?rrrrrWr@rWc@r=)DocstringModulez*This class represents a documented module.Nr?rrrrrXr@rXc@s<eZdZUdZded< ddd d Zdd d ZdddZdS)DocstringSectionz*This class represents a docstring section.rr,Ntitle str | NonerrcCs||_ d|_dS)z[Initialize the section. Parameters: title: An optional title. N)rZr")rrZrrrrszDocstringSection.__init__boolcCs t|jS)z*Whether this section has a true-ish value.)r\r"r+rrr__bool__r2zDocstringSection.__bool__rrrcKsHt|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)r,r"rZNr)hasattrr"rr,rZ)rrserialized_valuer'rrrrs  zDocstringSection.as_dictr0)rZr[rr)rr\r)rrrr __annotations__rr]rrrrrrYs   rYc4eZdZUdZejZded<d dfd d ZZ S)DocstringSectionTextz%This class represents a text section.rr,Nr"rrZr[rrct|||_dS)zInitialize the section. Parameters: value: The section text. title: An optional title. Nr$rr"rr"rZr%rrr  zDocstringSectionText.__init__r0)r"rrZr[rr) rrrr rtextr,r`rr(rrr%rrb  rbcra)DocstringSectionParametersz+This class represents a parameters section.rr,Nr"list[DocstringParameter]rZr[rrcrc)zInitialize the section. Parameters: value: The section parameters. title: An optional title. Nrdrer%rrrrfz#DocstringSectionParameters.__init__r0)r"rjrZr[rr) rrrr r parametersr,r`rr(rrr%rrirhric@s eZdZUdZejZded<dS)DocstringSectionOtherParametersz2This class represents an other parameters section.rr,N)rrrr rother_parametersr,r`rrrrrl)s rlcra)DocstringSectionTypeParametersz0This class represents a type parameters section.rr,Nr"list[DocstringTypeParameter]rZr[rrcrc)zInitialize the section. Parameters: value: The section type parameters. title: An optional title. Nrdrer%rrr4rfz'DocstringSectionTypeParameters.__init__r0)r"rorZr[rr) rrrr rtype_parametersr,r`rr(rrr%rrn/rhrncra)DocstringSectionRaisesz'This class represents a raises section.rr,Nr"list[DocstringRaise]rZr[rrcrc)zInitialize the section. Parameters: value: The section exceptions. title: An optional title. Nrdrer%rrrDrfzDocstringSectionRaises.__init__r0)r"rrrZr[rr) rrrr rraisesr,r`rr(rrr%rrq?rhrqcra)DocstringSectionWarnsz&This class represents a warns section.rr,Nr"list[DocstringWarn]rZr[rrcrc)zInitialize the section. Parameters: value: The section warnings. title: An optional title. Nrdrer%rrrTrfzDocstringSectionWarns.__init__r0)r"rurZr[rr) rrrr rwarnsr,r`rr(rrr%rrtOrhrtcra)DocstringSectionReturnsz(This class represents a returns section.rr,Nr"list[DocstringReturn]rZr[rrcrc)zInitialize the section. Parameters: value: The section returned items. title: An optional title. Nrdrer%rrrdrfz DocstringSectionReturns.__init__r0)r"rxrZr[rr) rrrr rreturnsr,r`rr(rrr%rrw_rhrwcra)DocstringSectionYieldsz'This class represents a yields section.rr,Nr"list[DocstringYield]rZr[rrcrc)zInitialize the section. Parameters: value: The section yielded items. title: An optional title. Nrdrer%rrrtrfzDocstringSectionYields.__init__r0)r"r{rZr[rr) rrrr ryieldsr,r`rr(rrr%rrzorhrzcra)DocstringSectionReceivesz)This class represents a receives section.rr,Nr"list[DocstringReceive]rZr[rrcrc)zInitialize the section. Parameters: value: The section received items. title: An optional title. Nrdrer%rrrrfz!DocstringSectionReceives.__init__r0)r"r~rZr[rr) rrrr rreceivesr,r`rr(rrr%rr}rhr}cs6eZdZUdZejZded< d dfd d ZZ S)DocstringSectionExamplesz*This class represents an examples section.rr,Nr"Slist[tuple[Literal[DocstringSectionKind.text, DocstringSectionKind.examples], str]]rZr[rrcrc)zInitialize the section. Parameters: value: The section examples. title: An optional title. Nrdrer%rrrs z!DocstringSectionExamples.__init__r0)r"rrZr[rr) rrrr rexamplesr,r`rr(rrr%rrs rcra)DocstringSectionAttributesz,This class represents an attributes section.rr,Nr"list[DocstringAttribute]rZr[rrcrc)zInitialize the section. Parameters: value: The section attributes. title: An optional title. Nrdrer%rrrrfz#DocstringSectionAttributes.__init__r0)r"rrZr[rr) rrrr r attributesr,r`rr(rrr%rrrhrcra)DocstringSectionFunctionsz2This class represents a functions/methods section.rr,Nr"list[DocstringFunction]rZr[rrcrc)zInitialize the section. Parameters: value: The section functions. title: An optional title. Nrdrer%rrrrfz"DocstringSectionFunctions.__init__r0)r"rrZr[rr) rrrr r functionsr,r`rr(rrr%rrrhrcra)DocstringSectionClassesz(This class represents a classes section.rr,Nr"list[DocstringClass]rZr[rrcrczInitialize the section. Parameters: value: The section classes. title: An optional title. Nrdrer%rrrrfz DocstringSectionClasses.__init__r0)r"rrZr[rr) rrrr rclassesr,r`rr(rrr%rrrhrcra)DocstringSectionTypeAliasesz-This class represents a type aliases section.rr,Nr"list[DocstringTypeAlias]rZr[rrcrcrrdrer%rrrrfz$DocstringSectionTypeAliases.__init__r0)r"rrZr[rr) rrrr r type_aliasesr,r`rr(rrr%rrrhrcra)DocstringSectionModulesz(This class represents a modules section.rr,Nr"list[DocstringModule]rZr[rrcrc)zInitialize the section. Parameters: value: The section modules. title: An optional title. Nrdrer%rrrrfz DocstringSectionModules.__init__r0)r"rrZr[rr) rrrr rmodulesr,r`rr(rrr%rrrhrcs4eZdZUdZejZded<ddfd d ZZ S)DocstringSectionDeprecatedz+This class represents a deprecated section.rr,Nr;rrgrZr[rrct|t||d|_dS)zInitialize the section. Parameters: version: The deprecation version. text: The deprecation text. title: An optional title. rN)r$rr:r")rr;rgrZr%rrr z#DocstringSectionDeprecated.__init__r0)r;rrgrrZr[rr) rrrr r deprecatedr,r`rr(rrr%rrrhrcra)DocstringSectionAdmonitionz,This class represents an admonition section.rr,NrrgrZr[rrcr)zInitialize the section. Parameters: kind: The admonition kind. text: The admonition text. title: An optional title. rN)r$rr)r")rr,rgrZr%rrr rz#DocstringSectionAdmonition.__init__r0)r,rrgrrZr[rr) rrrr r admonitionr,r`rr(rrr%rrrhrN)/ __future__rtypingrgriffe._internal.enumerationsrgriffe._internal.expressionsrcollections.abcrrrr r r!r)r:r>rArBrCrDrErHrPrRrVrWrXrYrbrirlrnrqrtrwrzr}rrrrrrrrrrrrsT      (  &  (