>XjHdZddlZddlZhdZhdZddhZddhZd d hZd d hZ Gd de Z GddejZ GddejZGddZGddeZGddeZGddeZGddeZGddeZGdd Zy)!zCommon methods for parsing.N>argkeyparamkeywordargument attribute parameter>raiseexceptraises exception deprecation deprecatedreturnreturnsyieldyieldsexampleexamplesceZdZdZy) ParseErrorz*Base class for all parsing related errors.N)__name__ __module__ __qualname____doc__]/var/www/html/content_generation/venv/lib/python3.12/site-packages/docstring_parser/common.pyrrs4rrc$eZdZdZdZdZdZdZdZy)DocstringStylezDocstring style.N) rrrrRESTGOOGLENUMPYDOCEPYDOCAUTOrrrr r s D FH F Drr ceZdZdZdZdZdZy)RenderingStylez1Rendering style when unparsing parsed docstrings.r!r"r#N)rrrrCOMPACTCLEANEXPANDEDrrrr,r,$s;G EHrr,cXeZdZdZdej edejeddfdZy) DocstringMetazDocstring meta information. Symbolizes lines in form of :param arg: description :raises ValueError: if something happens args descriptionrNc ||_||_y)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)r2r3)selfr2r3s r__init__zDocstringMeta.__init__5s &r) rrrrTListstrOptionalr6rrrr1r1,s4 'FF3K './jjo '  'rr1ceZdZdZdej edejededejedejedejedd ffd Z xZ S) DocstringParamz*DocstringMeta symbolizing :param metadata.r2r3arg_name type_name is_optionaldefaultrNc^t|||||_||_||_||_yInitialize self.N)superr6r=r>r?r@)r5r2r3r=r>r?r@ __class__s rr6zDocstringParam.__init__Fs1 {+  "& r rrrrr7r8r9r:boolr6 __classcell__rEs@rr<r<Cs}4ffSkZZ_  ::c?  ZZ% C rr<c eZdZdZ d dej edejedejededejeddf fd Z xZ S) DocstringReturnsz7DocstringMeta symbolizing :returns or :yields metadata.Nr2r3r> is_generator return_namercPt|||||_||_||_yrB)rDr6r>rLrM)r5r2r3r>rLrMrEs rr6zDocstringReturns.__init__Zs+ {+"(&rNrFrIs@rrKrKWsoA(, 'ffSk 'ZZ_ '::c? '  ' ZZ_ '  ' 'rrKceZdZdZdej edejedejeddffd ZxZ S)DocstringRaisesz+DocstringMeta symbolizing :raises metadata.r2r3r>rNcBt|||||_||_yrB)rDr6r>r3)r5r2r3r>rEs rr6zDocstringRaises.__init__ls# {+"&r rrrrr7r8r9r:r6rHrIs@rrQrQisN5 'ffSk 'ZZ_ '::c? '  ' 'rrQceZdZdZdej edejedejeddffd ZxZ S)DocstringDeprecatedz/DocstringMeta symbolizing deprecation metadata.r2r3versionrNcBt|||||_||_yrB)rDr6rVr3)r5r2r3rVrEs rr6zDocstringDeprecated.__init__{# {+ &rrSrIs@rrUrUxsN9 'ffSk 'ZZ_ 'C '  ' 'rrUceZdZdZdej edejedejeddffd ZxZ S)DocstringExamplez+DocstringMeta symbolizing example metadata.r2snippetr3rNcBt|||||_||_yrB)rDr6r[r3)r5r2r[r3rEs rr6zDocstringExample.__init__rXrrSrIs@rrZrZsN5 'ffSk 'C 'ZZ_ '  ' 'rrZcneZdZdZ d d dZedejefdZ edeje fdZ edeje fdZedejefdZedejefd Zedejefd Zedejefd Zy) Docstringz Docstring object representation.NrcXd|_d|_d|_d|_g|_||_y)rCNF)short_descriptionlong_descriptionblank_after_short_descriptionblank_after_long_descriptionmetastyle)r5res rr6zDocstring.__init__s2 "& $-2*,1)  rcg}|jr8|j|j|jr|jd|jr|j|j|sydj |S)z{Return the full description of the function Returns None if the docstring did not include any description N )r`appendrbrajoin)r5rets rr3zDocstring.descriptionsg   ! ! JJt-- .11 2  JJt,, -yy~rcb|jDcgc]}t|ts|c}Scc}w)z0Return a list of information on function params.)rd isinstancer<r5items rparamszDocstring.paramss)"&Oj~.NOOO,,cb|jDcgc]}t|ts|c}Scc}w)z\Return a list of information on the exceptions that the function may raise. )rdrmrQrns rr zDocstring.raisess2 "YY &T*T?*KDY   rqcN|jD]}t|ts|cSy)zeReturn a single information on function return. Takes the first return information. NrdrmrKrns rrzDocstring.returnss' IID$ 01 rcb|jDcgc]}t|ts|c}Scc}w)z0Return a list of information on function return.rtrns r many_returnszDocstring.many_returns3"YY &T*T;K*LDY   rqcN|jD]}t|ts|cSy)z:Return a single information on function deprecation notes.N)rdrmrUrns rrzDocstring.deprecations'IID$ 34 rcb|jDcgc]}t|ts|c}Scc}w)z2Return a list of information on function examples.)rdrmrZrns rrzDocstring.examplesrwrqrO)rN)rrrrr6propertyr7r:r9r3r8r<rprQr rKrrvrUrrZrrrrr^r^s*   QZZ_$P~.PP /  $45 aff%56  QZZ(;< !&&!12  rr^)renumtypingr7PARAM_KEYWORDSRAISES_KEYWORDSDEPRECATION_KEYWORDSRETURNS_KEYWORDSYIELDS_KEYWORDSEXAMPLES_KEYWORDS RuntimeErrorrEnumr r,r1r<rKrQrUrZr^rrrrs! =%|4i(H% +55TYYTYY''.]('}'$ 'm ' '- ' '} 'O O r