o w!gI4@s$ddlmZddlmZddlmZer"ddlmZmZddlm Z GdddZ Gdd d e Z Gd d d e Z Gd d d e Z Gddde ZGddde ZGddde ZGddde ZGddde ZGddde ZGddde ZGddde ZGddde ZGd d!d!e ZGd"d#d#ZGd$d%d%eZGd&d'd'eZGd(d)d)eZGd*d+d+eZGd,d-d-eZGd.d/d/eZGd0d1d1eZGd2d3d3eZ Gd4d5d5eZ!Gd6d7d7eZ"Gd8d9d9eZ#Gd:d;d;eZ$Gdd?d?eZ&Gd@dAdAeZ'dBS)C) annotations) TYPE_CHECKING)DocstringSectionKind)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 r[/mnt/skqttb/ctump_chatbot/chatbot/lib/python3.10/site-packages/_griffe/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_dicts zDocstringElement.as_dict)r r r r rrrrrr)__name__ __module__ __qualname____doc__rrrrrrrs rcs8eZdZdZddddfd dZdfdd ZZS)DocstringNamedElementz5This base class represents annotated, named elements.N)r valuenamer r r r r str | Nonerrcs"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__rrr1s zDocstringNamedElement.__init__rrrc s4d|jitjdi|}|jdur|j|d<|S)rr!Nr r)r!r#rr )rrbaser$rrrGs  zDocstringNamedElement.as_dict) r!r r r r r r r"rrr)rrrrrr __classcell__rrr$rr.s rc@sLeZdZdZedddZejdd dZedd d Zejdd d ZdS)DocstringAdmonitionz$This class represents an admonition.rr cC|jS)zThe kind of this admonition.r rrrrkindYzDocstringAdmonition.kindr str | ExprrcC ||_dSNr rr rrrr+^ r cCr))z The contents of this admonition.r r*rrrcontentsbr,zDocstringAdmonition.contentscCr.r/r2r0rrrr3gr1Nrr )r r-rrrr r r rr)rrrrpropertyr+setterr3rrrrr(Vs   r(c@s.eZdZdZed ddZejd ddZd S) DocstringDeprecatedz3This class represents a documented deprecated item.rr cCr))z The version of this deprecation.r r*rrrversionor,zDocstringDeprecated.versionr rcCr.r/r r0rrrr:tr1Nr5r6)rrrrr7r:r8rrrrr9l  r9c@eZdZdZdS)DocstringRaisez/This class represents a documented raise value.Nrrrrrrrrr=yr=c@r<) DocstringWarnz.This class represents a documented warn value.Nr>rrrrr@}r?r@c@r<)DocstringReturnz0This class represents a documented return value.Nr>rrrrrAr?rAc@r<)DocstringYieldz/This class represents a documented yield value.Nr>rrrrrBr?rBc@r<)DocstringReceivez1This class represents a documented receive value.Nr>rrrrrCr?rCc@s.eZdZdZed ddZejd d dZd S) DocstringParameterz5This class represent a documented function parameter.rr"cCr))z$The default value of this parameter.r r*rrrdefaultr,zDocstringParameter.defaultr r rcCr.r/rEr0rrrrFr1N)rr"r6)rrrrr7rFr8rrrrrDr;rDc@r<)DocstringAttributez:This class represents a documented module/class attribute.Nr>rrrrrGr?rGc@eZdZdZedddZdS)DocstringFunctionz,This class represents a documented function.rr cCr))zThe function signature.r r*rrr signaturer,zDocstringFunction.signatureNr4rrrrr7rJrrrrrIrIc@rH)DocstringClassz)This class represents a documented class.rr cCr))zThe class signature.r r*rrrrJr,zDocstringClass.signatureNr4rKrrrrrMrLrMc@r<)DocstringModulez*This class represents a documented module.Nr>rrrrrNr?rNc@s<eZdZUdZded< ddd d Zdd d ZdddZdS)DocstringSectionz*This class represents a docstring section.rr+Ntitler"rrcCs||_ d|_dS)z[Initialize the section. Parameters: title: An optional title. N)rPr )rrPrrrrszDocstringSection.__init__boolcCs t|jS)z*Whether this section has a true-ish value.)rQr r*rrr__bool__r1zDocstringSection.__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 rPNr)hasattrr rr+rP)rrserialized_valuer&rrrrs  zDocstringSection.as_dictr/)rPr"rr)rrQr)rrrr__annotations__rrRrrrrrrOs   rOc4eZdZUdZejZded<d dfd d ZZ S)DocstringSectionTextz%This class represents a text section.rr+Nr r rPr"rrct|||_dS)zInitialize the section. Parameters: value: The section text. title: An optional title. Nr#rr rr rPr$rrr  zDocstringSectionText.__init__r/)r r rPr"rr) rrrrrtextr+rUrr'rrr$rrW rWcrV)DocstringSectionParametersz+This class represents a parameters section.rr+Nr list[DocstringParameter]rPr"rrcrX)zInitialize the section. Parameters: value: The section parameters. title: An optional title. NrYrZr$rrrr[z#DocstringSectionParameters.__init__r/)r r_rPr"rr) rrrrr parametersr+rUrr'rrr$rr^r]r^c@s eZdZUdZejZded<dS)DocstringSectionOtherParametersz2This class represents an other parameters section.rr+N)rrrrrother_parametersr+rUrrrrras racrV)DocstringSectionRaisesz'This class represents a raises section.rr+Nr list[DocstringRaise]rPr"rrcrX)zInitialize the section. Parameters: value: The section exceptions. title: An optional title. NrYrZr$rrrr[zDocstringSectionRaises.__init__r/)r rdrPr"rr) rrrrrraisesr+rUrr'rrr$rrcr]rccrV)DocstringSectionWarnsz&This class represents a warns section.rr+Nr list[DocstringWarn]rPr"rrcrX)zInitialize the section. Parameters: value: The section warnings. title: An optional title. NrYrZr$rrrr[zDocstringSectionWarns.__init__r/)r rgrPr"rr) rrrrrwarnsr+rUrr'rrr$rrfr]rfcrV)DocstringSectionReturnsz(This class represents a returns section.rr+Nr list[DocstringReturn]rPr"rrcrX)zInitialize the section. Parameters: value: The section returned items. title: An optional title. NrYrZr$rrr(r[z DocstringSectionReturns.__init__r/)r rjrPr"rr) rrrrrreturnsr+rUrr'rrr$rri#r]ricrV)DocstringSectionYieldsz'This class represents a yields section.rr+Nr list[DocstringYield]rPr"rrcrX)zInitialize the section. Parameters: value: The section yielded items. title: An optional title. NrYrZr$rrr8r[zDocstringSectionYields.__init__r/)r rmrPr"rr) rrrrryieldsr+rUrr'rrr$rrl3r]rlcrV)DocstringSectionReceivesz)This class represents a receives section.rr+Nr list[DocstringReceive]rPr"rrcrX)zInitialize the section. Parameters: value: The section received items. title: An optional title. NrYrZr$rrrHr[z!DocstringSectionReceives.__init__r/)r rprPr"rr) rrrrrreceivesr+rUrr'rrr$rroCr]rocs6eZdZUdZejZded< d dfd d ZZ S)DocstringSectionExamplesz*This class represents an examples section.rr+Nr Slist[tuple[Literal[DocstringSectionKind.text, DocstringSectionKind.examples], str]]rPr"rrcrX)zInitialize the section. Parameters: value: The section examples. title: An optional title. NrYrZr$rrrXs z!DocstringSectionExamples.__init__r/)r rsrPr"rr) rrrrrexamplesr+rUrr'rrr$rrrSs rrcrV)DocstringSectionAttributesz,This class represents an attributes section.rr+Nr list[DocstringAttribute]rPr"rrcrX)zInitialize the section. Parameters: value: The section attributes. title: An optional title. NrYrZr$rrrlr[z#DocstringSectionAttributes.__init__r/)r rvrPr"rr) rrrrr attributesr+rUrr'rrr$rrugr]rucrV)DocstringSectionFunctionsz2This class represents a functions/methods section.rr+Nr list[DocstringFunction]rPr"rrcrX)zInitialize the section. Parameters: value: The section functions. title: An optional title. NrYrZr$rrr|r[z"DocstringSectionFunctions.__init__r/)r ryrPr"rr) rrrrr functionsr+rUrr'rrr$rrxwr]rxcrV)DocstringSectionClassesz(This class represents a classes section.rr+Nr list[DocstringClass]rPr"rrcrX)zInitialize the section. Parameters: value: The section classes. title: An optional title. NrYrZr$rrrr[z DocstringSectionClasses.__init__r/)r r|rPr"rr) rrrrrclassesr+rUrr'rrr$rr{r]r{crV)DocstringSectionModulesz(This class represents a modules section.rr+Nr list[DocstringModule]rPr"rrcrX)zInitialize the section. Parameters: value: The section modules. title: An optional title. NrYrZr$rrrr[z DocstringSectionModules.__init__r/)r rrPr"rr) rrrrrmodulesr+rUrr'rrr$rr~r]r~cs4eZdZUdZejZded<ddfd d ZZ S)DocstringSectionDeprecatedz+This class represents a deprecated section.rr+Nr:r r\rPr"rrct|t||d|_dS)zInitialize the section. Parameters: version: The deprecation version. text: The deprecation text. title: An optional title. rN)r#rr9r )rr:r\rPr$rrr z#DocstringSectionDeprecated.__init__r/)r:r r\r rPr"rr) rrrrr deprecatedr+rUrr'rrr$rrr]rcrV)DocstringSectionAdmonitionz,This class represents an admonition section.rr+Nr r\rPr"rrcr)zInitialize the section. Parameters: kind: The admonition kind. text: The admonition text. title: An optional title. rN)r#rr(r )rr+r\rPr$rrrrz#DocstringSectionAdmonition.__init__r/)r+r r\r rPr"rr) rrrrr admonitionr+rUrr'rrr$rrr]rN)( __future__rtypingr_griffe.enumerationsrrr_griffe.expressionsrrrr(r9r=r@rArBrCrDrGrIrMrNrOrWr^rarcrfrirlrorrrurxr{r~rrrrrrsH    (    (