o i@sdZddlZddlZhdZhdZddhZddhZd d hZd d hZ Gd dde Z Gdddej Z Gdddej ZGdddZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d ZdS)!zCommon methods for parsing.N>argkeyparamkeywordargument attribute parameter>raiseexceptraises exception deprecation deprecatedreturnreturnsyieldyieldsexampleexamplesc@seZdZdZdS) ParseErrorz*Base class for all parsing related errors.N)__name__ __module__ __qualname____doc__rr]/var/www/html/karishye-ai-python/venv/lib/python3.10/site-packages/docstring_parser/common.pyrsrc@s$eZdZdZdZdZdZdZdZdS)DocstringStylezDocstring style.N) rrrrRESTGOOGLENUMPYDOCEPYDOCAUTOrrrrrsrc@seZdZdZdZdZdZdS)RenderingStylez1Rendering style when unparsing parsed docstrings.rrrN)rrrrCOMPACTCLEANEXPANDEDrrrrr'$s r'c@s2eZdZdZdejedejeddfddZdS) DocstringMetazDocstring meta information. Symbolizes lines in form of :param arg: description :raises ValueError: if something happens args descriptionrNcCs||_||_dS)a,Initialize self. :param args: list of arguments. The exact content of this variable is dependent on the kind of docstring; it's used to distinguish between custom docstring meta information items. :param description: associated docstring description. N)r,r-)selfr,r-rrr__init__5s zDocstringMeta.__init__) rrrrTListstrOptionalr/rrrrr+,sr+cs\eZdZdZdejedejededejedejedejedd ffd d Z Z S) DocstringParamz*DocstringMeta symbolizing :param metadata.r,r-arg_name type_name is_optionaldefaultrNcs*t||||_||_||_||_dSInitialize self.N)superr/r5r6r7r8)r.r,r-r5r6r7r8 __class__rrr/Fs   zDocstringParam.__init__ rrrrr0r1r2r3boolr/ __classcell__rrr<rr4Cs"r4c sVeZdZdZ d dejedejedejededejeddf fd d Z Z S) DocstringReturnsz7DocstringMeta symbolizing :returns or :yields metadata.Nr,r-r6 is_generator return_namercs$t||||_||_||_dSr9)r;r/r6rBrC)r.r,r-r6rBrCr<rrr/Zs  zDocstringReturns.__init__Nr>rrr<rrAWs rAcDeZdZdZdejedejedejeddffdd ZZ S) DocstringRaisesz+DocstringMeta symbolizing :raises metadata.r,r-r6rNct||||_||_dSr9)r;r/r6r-)r.r,r-r6r<rrr/l zDocstringRaises.__init__ rrrrr0r1r2r3r/r@rrr<rrFirFcrE) DocstringDeprecatedz/DocstringMeta symbolizing deprecation metadata.r,r-versionrNcrGr9)r;r/rLr-)r.r,r-rLr<rrr/{rHzDocstringDeprecated.__init__rIrrr<rrKxrJrKcrE) DocstringExamplez+DocstringMeta symbolizing example metadata.r,snippetr-rNcst||||_||_dSr9)r;r/rNr-)r.r,rNr-r<rrr/rHzDocstringExample.__init__rIrrr<rrMrJrMc@seZdZdZ d dddZedejefddZ edej e fdd Z edej e fd d Zedejefd d Zedej efddZedejefddZedej efddZdS) Docstringz Docstring object representation.NrcCs(d|_d|_d|_d|_g|_||_dS)r:NF)short_descriptionlong_descriptionblank_after_short_descriptionblank_after_long_descriptionmetastyle)r.rUrrrr/s  zDocstring.__init__cCsJg}|jr||j|jr|d|jr||j|s dSd|S)z{Return the full description of the function Returns None if the docstring did not include any description N )rPappendrRrQjoin)r.retrrrr-s    zDocstring.descriptioncCdd|jDS)z0Return a list of information on function params.cSg|] }t|tr|qSr) isinstancer4.0itemrrr sz$Docstring.params..rTr.rrrparamsszDocstring.paramscCr[)z\Return a list of information on the exceptions that the function may raise. cSr\r)r]rFr^rrrra  z$Docstring.raises..rbrcrrrr szDocstring.raisescC"|jD] }t|tr|SqdS)zeReturn a single information on function return. Takes the first return information. N)rTr]rAr.r`rrrrs  zDocstring.returnscCr[)z0Return a list of information on function return.cSr\r)r]rAr^rrrrarez*Docstring.many_returns..rbrcrrr many_returnszDocstring.many_returnscCrf)z:Return a single information on function deprecation notes.N)rTr]rKrgrrrr s  zDocstring.deprecationcCr[)z2Return a list of information on function examples.cSr\r)r]rMr^rrrrarez&Docstring.examples..rbrcrrrrrizDocstring.examplesrD)rN)rrrrr/propertyr0r3r2r-r1r4rdrFr rArrhrKr rMrrrrrrOs(   rO)renumtypingr0PARAM_KEYWORDSRAISES_KEYWORDSDEPRECATION_KEYWORDSRETURNS_KEYWORDSYIELDS_KEYWORDSEXAMPLES_KEYWORDS RuntimeErrorrEnumrr'r+r4rArFrKrMrOrrrrs&