㎒jrdZddlZddlZhdZhdZddhZddhZd d hZd d hZ Gd de Z Gddej Z Gddej ZGddZGddeZGddeZGddeZGddeZGddeZGdd ZdS)!zCommon methods for parsing.N>argkeyparamkeywordargument attribute parameter>raiseexceptraises exception deprecation deprecatedreturnreturnsyieldyieldsexampleexamplesceZdZdZdS) ParseErrorz*Base class for all parsing related errors.N)__name__ __module__ __qualname____doc__EC:\Projects\DSCons\.venv\Lib\site-packages\docstring_parser\common.pyrrs4444rrc&eZdZdZdZdZdZdZdZdS)DocstringStylezDocstring style.N) rrrrRESTGOOGLENUMPYDOCEPYDOCAUTOrrrr r s- D FH F DDDrr ceZdZdZdZdZdZdS)RenderingStylez1Rendering style when unparsing parsed docstrings.r!r"r#N)rrrrCOMPACTCLEANEXPANDEDrrrr,r,$s#;;G EHHHrr,cReZdZdZdejedejeddfdZdS) DocstringMetazDocstring meta information. Symbolizes lines in form of :param arg: description :raises ValueError: if something happens args descriptionrNc"||_||_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)r2r3)selfr2r3s r__init__zDocstringMeta.__init__5s &r) rrrrTListstrOptionalr6rrrr1r1,sV 'F3K './jo '  ' ' ' ' ' 'rr1ceZdZdZdejedejededejedejedejedd ffd Z xZ S) DocstringParamz*DocstringMeta symbolizing :param metadata.r2r3arg_name type_name is_optionaldefaultrNct||||_||_||_||_dSInitialize self.N)superr6r=r>r?r@)r5r2r3r=r>r?r@ __class__s rr6zDocstringParam.__init__Fs@ {+++  "& r rrrrr7r8r9r:boolr6 __classcell__rEs@rr<r<Cs44fSkZ_  :c?  Z% C rr<c eZdZdZ d dejedejedejededejeddf fd Z xZ S) DocstringReturnsz7DocstringMeta symbolizing :returns or :yields metadata.Nr2r3r> is_generator return_namercvt||||_||_||_dSrB)rDr6r>rLrM)r5r2r3r>rLrMrEs rr6zDocstringReturns.__init__Zs< {+++"(&rNrFrIs@rrKrKWsAA(, ' 'fSk 'Z_ ':c? '  ' Z_ '  ' ' ' ' ' ' ' ' ' 'rrKcveZdZdZdejedejedejeddffd ZxZ S)DocstringRaisesz+DocstringMeta symbolizing :raises metadata.r2r3r>rNcht||||_||_dSrB)rDr6r>r3)r5r2r3r>rEs rr6zDocstringRaises.__init__ls4 {+++"&r rrrrr7r8r9r:r6rHrIs@rrQrQis{55 'fSk 'Z_ ':c? '  ' ' ' ' ' ' ' ' ' 'rrQcveZdZdZdejedejedejeddffd ZxZ S)DocstringDeprecatedz/DocstringMeta symbolizing deprecation metadata.r2r3versionrNcht||||_||_dSrB)rDr6rVr3)r5r2r3rVrEs rr6zDocstringDeprecated.__init__{4 {+++ &rrSrIs@rrUrUxs{99 'fSk 'Z_ 'C '  ' ' ' ' ' ' ' ' ' 'rrUcveZdZdZdejedejedejeddffd ZxZ S)DocstringExamplez+DocstringMeta symbolizing example metadata.r2snippetr3rNcht||||_||_dSrB)rDr6r[r3)r5r2r[r3rEs rr6zDocstringExample.__init__rXrrSrIs@rrZrZs{55 'fSk 'C 'Z_ '  ' ' ' ' ' ' ' ' ' 'rrZc~eZdZdZ d d dZedejefdZ edej e fdZ edej e fdZedejefdZedej efd Zedejefd Zedej efd ZdS) Docstringz Docstring object representation.NrcZd|_d|_d|_d|_g|_||_dS)rCNF)short_descriptionlong_descriptionblank_after_short_descriptionblank_after_long_descriptionmetastyle)r5res rr6zDocstring.__init__s6 "& $-2*,1)  rcg}|jr6||j|jr|d|jr||j|sdSd|S)z{Return the full description of the function Returns None if the docstring did not include any description N )r`appendrbrajoin)r5rets rr3zDocstring.descriptions   !  JJt- . . .1  2   . JJt, - - - 4yy~~rc$d|jDS)z0Return a list of information on function params.c<g|]}t|t|Sr) isinstancer<.0items r z$Docstring.params..s'OOOj~.N.NOOOOrrdr5s rparamszDocstring.paramssPOOOOOrc$d|jDS)z\Return a list of information on the exceptions that the function may raise. c<g|]}t|t|Sr)rnrQros rrrz$Docstring.raises..s7   *T?*K*K    rrsrts rr zDocstring.raisess%   !Y    rcL|jD]}t|tr|cSdS)zeReturn a single information on function return. Takes the first return information. N)rdrnrKr5rqs rrzDocstring.returnss; I  D$ 011   trc$d|jDS)z0Return a list of information on function return.c<g|]}t|t|Sr)rnrKros rrrz*Docstring.many_returns..8   *T;K*L*L    rrsrts r many_returnszDocstring.many_returns%  !Y    rcL|jD]}t|tr|cSdS)z:Return a single information on function deprecation notes.N)rdrnrUrys rrzDocstring.deprecations;I  D$ 344   trc$d|jDS)z2Return a list of information on function examples.c<g|]}t|t|Sr)rnrZros rrrz&Docstring.examples..r|rrsrts rrzDocstring.examplesr~rrO)rN)rrrrr6propertyr7r:r9r3r8r<rurQr rKrr}rUrrZrrrrr^r^s**      QZ_X$P~.PPPXP /   X $45X af%56   X QZ(;<X !&!12   X   rr^)renumtypingr7PARAM_KEYWORDSRAISES_KEYWORDSDEPRECATION_KEYWORDSRETURNS_KEYWORDSYIELDS_KEYWORDSEXAMPLES_KEYWORDS RuntimeErrorrEnumr r,r1r<rKrQrUrZr^rrrrs!!! =<<%|4i(H% +55555555TYTY''''''''.]('''''}'''$ ' ' ' ' 'm ' ' ' ' ' ' ' '- ' ' ' ' ' ' ' '} ' ' 'O O O O O O O O O O r