hHSrSSKrSSKr1Skr1SkrSS1rSS1rS S 1rS S 1r "S S\ 5r "SS\R5r "SS\R5r"SS5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\5r"SS 5rg)!zCommon methods for parsing.N>argkeyparamkeywordargument attribute parameter>raiseexceptraises exception deprecation deprecatedreturnreturnsyieldyieldsexampleexamplesc\rSrSrSrSrg) ParseErrorz*Base class for all parsing related errors.N)__name__ __module__ __qualname____firstlineno____doc____static_attributes__rQ/home/james-whalen/.local/lib/python3.13/site-packages/docstring_parser/common.pyrrs4r rc,\rSrSrSrSrSrSrSrSr Sr g ) DocstringStylezDocstring style.rN) rrrrrRESTGOOGLENUMPYDOCEPYDOCAUTOrrr r!r#r#s D FH F Dr r#c$\rSrSrSrSrSrSrSrg)RenderingStyle$z1Rendering style when unparsing parsed docstrings.r%r&r'rN) rrrrrCOMPACTCLEANEXPANDEDrrr r!r0r0$s;G EHr r0cb\rSrSrSrS\R \S\R\SS4Sjr Sr g) DocstringMeta,zDocstring meta information. Symbolizes lines in form of :param arg: description :raises ValueError: if something happens args descriptionrNcXlX lg)aInitialize 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. Nr8r9)selfr8r9s r!__init__DocstringMeta.__init__5s &r r;) rrrrrTListstrOptionalr=rrr r!r6r6,s4 'FF3K './jjo '  'r r6c^\rSrSrSrS\R \S\R\S\S\R\S\R\ S\R\S S 4U4S jjr S r U=r $) DocstringParamCz*DocstringMeta symbolizing :param metadata.r8r9arg_name type_name is_optionaldefaultrNcT>[TU]X5 X0lX@lXPlX`lgInitialize self.N)superr=rFrGrHrI)r<r8r9rFrGrHrI __class__s r!r=DocstringParam.__init__Fs' + "& r )rFrIrHrG rrrrrr?r@rArBboolr=r __classcell__rNs@r!rDrDCs}4ffSkZZ_  ::c?  ZZ% C r rDc ^\rSrSrSrS S\R \S\R\S\R\S\ S\R\S S4 U4S jjjr S r U=r $) DocstringReturnsWz7DocstringMeta symbolizing :returns or :yields metadata.Nr8r9rG is_generator return_namercH>[TU]X5 X0lX@lXPlgrK)rMr=rGrWrX)r<r8r9rGrWrXrNs r!r=DocstringReturns.__init__Zs# +"(&r )rWrXrGNrPrSs@r!rUrUWsoA(, 'ffSk 'ZZ_ '::c? '  ' ZZ_ '  ' 'r rUc^\rSrSrSrS\R \S\R\S\R\SS4U4Sjjr S r U=r $) DocstringRaisesiz+DocstringMeta symbolizing :raises metadata.r8r9rGrNc<>[TU]X5 X0lX lgrK)rMr=rGr9)r<r8r9rGrNs r!r=DocstringRaises.__init__ls +"&r )r9rG rrrrrr?r@rArBr=rrRrSs@r!r]r]isN5 'ffSk 'ZZ_ '::c? '  ' 'r r]c^\rSrSrSrS\R \S\R\S\R\SS4U4Sjjr S r U=r $) DocstringDeprecatedxz/DocstringMeta symbolizing deprecation metadata.r8r9versionrNc<>[TU]X5 X0lX lgrK)rMr=rer9)r<r8r9rerNs r!r=DocstringDeprecated.__init__{ + &r )r9rerarSs@r!rcrcxsN9 'ffSk 'ZZ_ 'C '  ' 'r rcc^\rSrSrSrS\R \S\R\S\R\SS4U4Sjjr S r U=r $) DocstringExamplez+DocstringMeta symbolizing example metadata.r8snippetr9rNc<>[TU]X5 X lX0lgrK)rMr=rlr9)r<r8rlr9rNs r!r=DocstringExample.__init__rhr )r9rlrarSs@r!rjrjsN5 'ffSk 'C 'ZZ_ '  ' 'r rjc\rSrSrSrSSSjjr\S\R\ 4Sj5r \S\R\ 4Sj5r \S\R\4Sj5r\S\R\4S j5r\S\R\4S j5r\S\R\4S j5r\S\R\4S j5rS rg) Docstringz Docstring object representation.NrcVSUlSUlSUlSUl/UlXlg)rLNF)short_descriptionlong_descriptionblank_after_short_descriptionblank_after_long_descriptionmetastyle)r<rxs r!r=Docstring.__init__s0 "& $-2*,1)  r c,/nUR(a=URUR5 UR(aURS5 UR(aURUR5 U(dgSR U5$)zkReturn the full description of the function Returns None if the docstring did not include any description N )rsappendrurtjoin)r<rets r!r9Docstring.descriptionsg   ! ! JJt-- .11 2  JJt,, -yy~r ctURVs/sHn[U[5(dMUPM sn$s snf)z0Return a list of information on function params.)rw isinstancerDr<items r!paramsDocstring.paramss)"&Oj~.NOOO55ctURVs/sHn[U[5(dMUPM sn$s snf)zLReturn a list of information on the exceptions that the function may raise. )rwrr]rs r!r Docstring.raisess2 "YY &T*T?*KDY   rc\URHn[U[5(dMUs $ g)zUReturn a single information on function return. Takes the first return information. NrwrrUrs r!rDocstring.returnss* IID$ 011 r ctURVs/sHn[U[5(dMUPM sn$s snf)z0Return a list of information on function return.rrs r! many_returnsDocstring.many_returns3"YY &T*T;K*LDY   rc\URHn[U[5(dMUs $ g)z:Return a single information on function deprecation notes.N)rwrrcrs r!rDocstring.deprecations*IID$ 344 r ctURVs/sHn[U[5(dMUPM sn$s snf)z2Return a list of information on function examples.)rwrrjrs r!rDocstring.examplesrr)rvrurtrwrsrxr[)rN)rrrrrr=propertyr?rBrAr9r@rDrr]r rUrrrcrrjrrrr r!rprps*   QZZ_$P~.PP /  $45 aff%56  QZZ(;< !&&!12  r rp)renumtypingr?PARAM_KEYWORDSRAISES_KEYWORDSDEPRECATION_KEYWORDSRETURNS_KEYWORDSYIELDS_KEYWORDSEXAMPLES_KEYWORDS RuntimeErrorrEnumr#r0r6rDrUr]rcrjrprr r!rs! =%|4i(H% +55TYYTYY''.]('}'$ 'm ' '- ' '} 'O O r