g ddlmZddlZddlmZddlmZddlmZddl m Z ddl m Z m Z mZmZmZddlmZdd lmZmZdd lmZmZmZdd lmZmZmZmZdd lm Z m!Z!dd l"m#Z#ddl$m%Z%e rddl&m'Z'ddl(m)Z)m*Z*ddl+m,Z,ddlm-Z-ddl.m/Z/GddZ0GddZ1GddZ2GddZ3Gdde%Z4Gdde%Z5Gd d!e4Z6Gd"d#e4Z7Gd$d%e4Z8Gd&d'e4Z9y)() annotationsN) defaultdict)suppress)Path)dedent) TYPE_CHECKINGAnyCallableUnioncast)c3linear_merge)DocstringStyleparse)Kind ParameterKindParser)AliasResolutionErrorBuiltinModuleErrorCyclicAliasErrorNameResolutionError)ExprCallExprName)logger)ObjectAliasMixin)Sequence)LinesCollectionModulesCollection)DocstringSection)Expr)cached_propertyc2eZdZdZddZeddZddZy) Decoratorz!This class represents decorators.c2||_ ||_ ||_y)zInitialize the decorator. Parameters: value: The decorator code. lineno: The starting line number. endlineno: The ending line number. Nvaluelineno endlineno)selfr%r&r's C/var/www/openai/venv/lib/python3.12/site-packages/_griffe/models.py__init__zDecorator.__init__"s""' E"( 8%.6ct|jtr|jjn |j}t|tr|S|j S)z+The path of the callable used as decorator.) isinstancer%rfunctionstrcanonical_pathr(r%s r) callable_pathzDecorator.callable_path1s@(2$**h'G ##TZZ"5#.uHE4H4HHr+c J|j|j|jdS)zReturn this decorator's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. r$r$)r(kwargss r)as_dictzDecorator.as_dict7s#ZZkk  r+N)r%z str | Exprr& int | Noner'r6returnNoner7r/r4r r7dict[str, Any])__name__ __module__ __qualname____doc__r*propertyr2r5r+r)r"r"s%+ 7II  r+r"ceZdZdZdddddd d dZed dZeddZeddZ d ddZ d d  dd Z y) Docstringz!This class represents docstrings.N)r&r'parentparserparser_optionsctj|j|_ ||_ ||_ ||_ ||_ |xsi|_y)aInitialize the docstring. Parameters: value: The docstring value. lineno: The starting line number. endlineno: The ending line number. parent: The parent object on which this docstring is attached. parser: The docstring parser to use. By default, no parsing is done. parser_options: Additional docstring parsing options. N) inspectcleandocrstripr%r&r'rDrErF)r(r%r&r'rDrErFs r)r*zDocstring.__init__Jsj("**5<<>:  #)  @&/ :&, 76<  /=.B r+c8|jjdS)z\The lines of the docstring. See also: [`source`][griffe.Docstring.source].  )r%splitr(s r)lineszDocstring.liness zz%%r+c|j tdt|jjtr td|j |j tddj|jj|jj|j dz |j S)zThe original, uncleaned value of the docstring as written in the source. See also: [`value`][griffe.Docstring.value]. z3Cannot get original docstring without parent objectz3Cannot get original docstring for namespace packagez2Cannot get original docstring without line numbersrL) rD ValueErrorr-filepathlistr&r'joinlines_collectionrNs r)sourcezDocstring.sources ;; RS S dkk**D 1RS S ;; $.."8QR Ryy55dkk6J6JKDKKZ[O^b^l^lmnnr+c"|jS)z4The docstring sections, parsed into structured data.)rrNs r)parsedzDocstring.parsedszz|r+c Tt||xs |jfi|xs |jS)aParse the docstring into structured data. See also: [`parser`][griffe.Docstring.parser], [`parser_options`][griffe.Docstring.parser_options]. Parameters: parser: The docstring parser to use. In order: use the given parser, or the self parser, or no parser (return a single text section). **options: Additional docstring parsing options. Returns: The parsed docstring as a list of sections. )rrErF)r(rEoptionss r)rzDocstring.parses*$T60T[[UW5S@S@SUUr+Ffullc p|j|j|jd}|r|j|d<|S)zReturn this docstring's data as a dictionary. Parameters: full: Whether to return full info, or just base info. **kwargs: Additional serialization options. Returns: A dictionary. r$rY)r%r&r'rYr(r]r4bases r)r5zDocstring.as_dicts7 ZZkk  ![[DN r+)r%r/r&r6r'r6rDz Object | NonerEDocstringStyle | Parser | NonerFzdict[str, Any] | Noner7r8r7z list[str]r9)r7list[DocstringSection]N)rErar[r r7rcr]boolr4r r7r;) r<r=r>r?r*r@rOrWr rYrr5rAr+r)rCrCGs+ " $ $15043 3  3  3  3 /3 .3  3 j&& o o 26V.VV V.   r+rCcreZdZdZddddd d dZd dZd dZddZeddZ d d dd Z y) ParameterzaThis class represent a function parameter. See also: [`Parameters`][griffe.Parameters]. N) annotationkinddefault docstringcb||_ ||_ ||_ ||_ ||_ d|_y)aFInitialize the parameter. Parameters: name: The parameter name, without leading stars (`*` or `**`). annotation: The parameter annotation, if any. kind: The parameter kind. default: The parameter default, if any. docstring: The parameter docstring. N)namerirjrkrlr.)r(rnrirjrkrls r)r*zParameter.__init__sB$ !-7,*. !*1 *+4&*. 3r+c|jd|jd|j}|jrd|jjd|S|S)Nz: z = [z] )rnrirkrjr%)r(params r)__str__zParameter.__str__sM99+R0DLL>B 99tyy'r%1 1 r+c pd|jd|jd|jd|jd S)NzParameter(name=z , annotation=z, kind=z , default=)rnrirjrkrNs r)__repr__zParameter.__repr__s>  ]4??:MWUYU^U^Taaklplxlxk{{|}}r+ct|tstS|j|jk(xrO|j|jk(xr4|j |j k(xr|j |j k(S)zYParameters are equal if all their attributes except `docstring` and `function` are equal.)r-rhNotImplementedrnrirjrkr1s r)__eq__zParameter.__eq__sj%+! ! II # .5#3#33 . UZZ' .  -  r+c|jduS)z#Whether this parameter is required.N)rkrNs r)requiredzParameter.requireds||t##r+Fr\c |j|j|j|jd}|jr|jj ||d<|S)zReturn this parameter's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. rur\rl)rnrirjrkrlr5r_s r)r5zParameter.as_dictsQII//II||   >> $ 6 6D 6 AD  r+) rnr/ristr | Expr | NonerjzParameterKind | Nonerkr}rlDocstring | Noner7r8r9)r%objectr7rfr7rfre) r<r=r>r?r*rrrvryr@r{r5rAr+r)rhrhs)-%)%)&*44& 4 # 4 # 4$4 4B ~  $$',r+rhcTeZdZdZd dZd dZddZddZddZdZ dZ dd Z dd Z y ) Parametersa+This class is a container for parameters. It allows to get parameters using their position (index) or their name: ```pycon >>> parameters = Parameters(Parameter("hello")) >>> parameters[0] is parameters["hello"] True ``` See also: [`Parameter`][griffe.Parameter]. c$t||_y)zInitialize the parameters container. Parameters: *parameters: The initial parameters to add to the container. N)rT_params)r( parameterss r)r*zParameters.__init__)s )-Z(8 r+cNddjd|jDdS)Nz Parameters(, c32K|]}t|ywrd)repr).0rqs r) z&Parameters.__repr__..2s&M utE{ rt)rUrrNs r)rvzParameters.__repr__1s%TYY&M &MMNaPPr+ct|tr|j|S|jd t fd|jDS#t $r}t d|d|d}~wwxYw)z!Get a parameter by index or name.*c3BK|]}|jk(s|ywrdrn)rrqrns r)rz)Parameters.__getitem__..:sN<%5::;M.E$a3JZS%ejj\`N`S3J""N)r-rrrr enumeraterappend)r(r parameterindexrns @r) __setitem__zParameters.__setitem__>s| mS )*3DLL ' '',D 0a9T\\3Jaa'0 U#! / ##I. /s'A++$BBct|tr|j|=y|jd t fdt |jD}|j|=y#t $r}td|d|d}~wwxYw)z$Delete a parameter by index or name.rc3HK|]\}}|jk(s|ywrdrrs r)rz)Parameters.__delitem__..RrrrrN)r-rrrrrrr)r(rrrrns @r) __delitem__zParameters.__delitem__Ks mS ) ]+ '',D Ra9T\\3Jaa U#! RM?*EFEQ Rs'A'' B0BBc,t|jS)zThe number of parameters.)lenrrNs r)__len__zParameters.__len__Ws4<<  r+c,t|jS)z&Iterate over the parameters, in order.)iterrrNs r)__iter__zParameters.__iter__[sDLL!!r+cb tfd|jDy#t$rYywxYw)z3Whether a parameter with the given name is present.c3`K|]%}|jjdk(s"|'yw)rN)rnr)rrq param_names r)rz*Parameters.__contains__..bs)YL5EJJ*BSBSTWBX4XLs#..FT)rrr)r(rs `r) __contains__zParameters.__contains___s3  YDLLY Y  s " ..c|j|vrtd|jd|jj|y)zAdd a parameter to the container. Parameters: parameter: The function parameter to add. Raises: ValueError: When a parameter with the same name is already present. rz already presentN)rnrRrr)r(rs r)addzParameters.addgs< >>T !z)..)99IJK K I&r+N)rrhr7r8r9)r int | strr7rh)rrrrhr7r8)rrr7r8)rr/)rrhr7r8) r<r=r>r?r*rvrrrrrrrrAr+r)rrs6 9QN 0 $!" 'r+rcneZdZUdZded< dZded< dZded< dZded< d d d d d d d d  d-d Zd.d Z d/dZ d0dZ e d/dZ e d/dZd1dZe d2dZe d/dZe d/dZe d/dZe d/dZe d/dZe d/dZe d/dZe d/dZe d/dZd3dZd4dZe d5dZe d5d Ze d6d!Ze d7d"Ze d7d#Z e d.d$Z!e d.d%Z"e d8d&Z#e d9d'Z$e d:d(Z%e d.d)Z&d;d*Z'dd+d||_ ||_ ||_ ||_ ||_ i|_ t |_ i|_ d|_ i|_ ||_ tt|_ d|_ d|_ ||_||_|r||_yy)a*Initialize the object. Parameters: name: The object name, as declared in the code. lineno: The object starting line, or None for modules. Lines start at 1. endlineno: The object ending line (inclusive), or None for modules. runtime: Whether this object is present at runtime or not. docstring: The object docstring. parent: The object parent. lines_collection: A collection of source code lines. modules_collection: A collection of modules. N)rnr&r'rlrDmemberssetlabelsimportsexportsaliasesrrdictextrapublic deprecated_lines_collection_modules_collection) r(rnr&r'rrlrDrVrs r)r*zObject.__init__s0 "(  &/ ,5 .4 <24  !$  ?(*  @D  *, 2$  1.s&WAVvs6{AVr)rrsumvaluesrNs r)rzObject.__len__s.4<< 3&WATATAV&W#WWWr+c,t|jS)zWhether this object has a docstring (empty or not). See also: [`docstring`][griffe.Object.docstring], [`has_docstrings`][griffe.Object.has_docstrings]. )rfrlrNs r) has_docstringzObject.has_docstringsDNN##r+c|jry|jjD])} |jr |jr|j ry+y#t $rY8wxYw)a>Whether this object or any of its members has a docstring (empty or not). Inherited members are not considered. Imported members are not considered, unless they are also public. See also: [`docstring`][griffe.Object.docstring], [`has_docstring`][griffe.Object.has_docstring]. TF)rrr is_imported is_publichas_docstringsr)r(rs r)rzObject.has_docstringssb   ll))+F **f.>.>FDYDY, (  s$A A! A!ct|tr"|s td|jd|DvSt|tr t |}|j|uS)aTell if this object is of the given kind. See also: [`is_module`][griffe.Object.is_module], [`is_class`][griffe.Object.is_class], [`is_function`][griffe.Object.is_function], [`is_attribute`][griffe.Object.is_attribute], [`is_alias`][griffe.Object.is_alias]. Parameters: kind: An instance or set of kinds (strings or enumerations). Raises: ValueError: When an empty set is given as argument. Returns: True or False. zkind must not be an empty setc3VK|]!}t|tr|n t|#ywrd)r-r)rknds r)rz!Object.is_kind..;s& ]X\QT 3(=49!LX\s'))r-rrRrjr/rr(rjs r)is_kindzObject.is_kind&sU$ dC  !@AA99 ]X\ ]] ] dC :DyyD  r+cPt|tsiS |j}i}t |D]E}|jjD]&\}}||jvst|||d||<(G|S#t$r!}t j |icYd}~Sd}~wwxYw)zMembers that are inherited from base classes. This method is part of the consumer API: do not use when producing Griffe trees! See also: [`members`][griffe.Object.members]. NT)rDr) r-ClassmrorRrdebugreversedritemsAlias)r(rrinherited_membersr`rnrs r)rzObject.inherited_members@s$&I ((*CSMD $ 2 2 4 ft||+.3D&Y].^%d+!5"!   LL I sA;; B%B B% B%c:|jtjuS)aaWhether this object is a module. See also: [`is_init_module`][griffe.Object.is_init_module]. [`is_class`][griffe.Object.is_class], [`is_function`][griffe.Object.is_function], [`is_attribute`][griffe.Object.is_attribute], [`is_alias`][griffe.Object.is_alias], [`is_kind`][griffe.Object.is_kind]. )rjrMODULErNs r) is_modulezObject.is_moduleWsyyDKK''r+c:|jtjuS)a(Whether this object is a class. See also: [`is_module`][griffe.Object.is_module]. [`is_function`][griffe.Object.is_function], [`is_attribute`][griffe.Object.is_attribute], [`is_alias`][griffe.Object.is_alias], [`is_kind`][griffe.Object.is_kind]. )rjrCLASSrNs r)is_classzObject.is_classdsyyDJJ&&r+c:|jtjuS)a%Whether this object is a function. See also: [`is_module`][griffe.Object.is_module]. [`is_class`][griffe.Object.is_class], [`is_attribute`][griffe.Object.is_attribute], [`is_alias`][griffe.Object.is_alias], [`is_kind`][griffe.Object.is_kind]. )rjrFUNCTIONrNs r) is_functionzObject.is_functionpsyyDMM))r+c:|jtjuS)a%Whether this object is an attribute. See also: [`is_module`][griffe.Object.is_module]. [`is_class`][griffe.Object.is_class], [`is_function`][griffe.Object.is_function], [`is_alias`][griffe.Object.is_alias], [`is_kind`][griffe.Object.is_kind]. )rjr ATTRIBUTErNs r) is_attributezObject.is_attribute|syyDNN**r+cy)ztWhether this object is an `__init__.py` module. See also: [`is_module`][griffe.Object.is_module]. FrArNs r)is_init_modulezObject.is_init_module r+cy)z{Whether this object is a package (top module). See also: [`is_subpackage`][griffe.Object.is_subpackage]. FrArNs r) is_packagezObject.is_packagerr+cy)zkWhether this object is a subpackage. See also: [`is_package`][griffe.Object.is_package]. FrArNs r) is_subpackagezObject.is_subpackagerr+cy)zWhether this object is a namespace package (top folder, no `__init__.py`). See also: [`is_namespace_subpackage`][griffe.Object.is_namespace_subpackage]. FrArNs r)is_namespace_packagezObject.is_namespace_packagerr+cy)zWhether this object is a namespace subpackage. See also: [`is_namespace_package`][griffe.Object.is_namespace_package]. FrArNs r)is_namespace_subpackagezObject.is_namespace_subpackagerr+cJt|j|jS)zTell if this object has all the given labels. See also: [`labels`][griffe.Object.labels]. Parameters: *labels: Labels that must be present. Returns: True or False. )rissubsetrr(rs r) has_labelszObject.has_labelss6{##DKK00r+c|s |jS|jjDcic]\}tfd|Ds|}}}|Scc}}w)a0Filter and return members based on predicates. See also: [`members`][griffe.Object.members]. Parameters: *predicates: A list of predicates, i.e. callables accepting a member as argument and returning a boolean. Returns: A dictionary of members. c3.K|] }|ywrdrA)r predicaters r)rz(Object.filter_members..sHwlv_hSYIZlvs)rrall)r( predicatesrnrrs ` r)filter_memberszObject.filter_memberss^<< -1\\-?-?-A. -A\T6SHwlvHwEwD&L-A . . s A Act|tr|S|j|jjSt d|j d)aThe parent module of this object. See also: [`package`][griffe.Object.package]. Examples: >>> import griffe >>> markdown = griffe.load("markdown") >>> markdown["core.Markdown.references"].module Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py')) >>> # The `module` of a module is itself. >>> markdown["core"].module Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py')) Raises: ValueError: When the object is not a module and does not have a parent. zObject z does not have a parent module)r-ModulerDmodulerRrnrNs r)r z Object.modulesF$ dF #K ;; ";;%% %7499+-KLMMr+ch|j}|jr|j}|jr|S)awThe absolute top module (the package) of this object. See also: [`module`][griffe.Object.module]. Examples: >>> import griffe >>> markdown = griffe.load("markdown") >>> markdown["core.Markdown.references"].package Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py')) )r rD)r(r s r)packagezObject.packages+mm]]Fmm r+c.|jjS)aThe file path (or directory list for namespace packages) where this object was defined. See also: [`relative_filepath`][griffe.Object.relative_filepath], [`relative_package_filepath`][griffe.Object.relative_package_filepath]. Examples: >>> import griffe >>> markdown = griffe.load("markdown") >>> markdown.filepath PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py') )r rSrNs r)rSzObject.filepaths{{###r+c8|jj}t|jtrt|trU|D]J}|jD]9}t t 5|j |jcdddccSLt |jD]A}t t 5|j |jjcdddcSt t|trL|D]A}t t 5|jj |jcdddcSt |jj |jjS#1swY/xYw#1swYxYw#1swYxYw)a&The file path where this object was defined, relative to the top module path. See also: [`filepath`][griffe.Object.filepath], [`relative_filepath`][griffe.Object.relative_filepath]. Raises: ValueError: When the relative path could not be computed. N)r rSr-rTrrR relative_torD)r( package_pathpkg_path self_paths r)relative_package_filepathz Object.relative_package_filepaths3||,,  dmmT *,- ,H%)]] %j1#,#8#8#I21&3!- "&I!*-(44\5H5H5O5OP.-"/  lD )(j)==44X__E*))  }}(()<)<)C)CDD121.-*)s$$E74%F%F7F F F ctj}t|jtrW|jD]-}t t 5|j|cdddcSt d|jd| |jj|S#1swYpxYw#t $r|jcYSwxYw)aThe file path where this object was defined, relative to the current working directory. If this object's file path is not relative to the current working directory, return its absolute path. See also: [`filepath`][griffe.Object.filepath], [`relative_package_filepath`][griffe.Object.relative_package_filepath]. Raises: ValueError: When the relative path could not be computed. NzNo directory in z. is relative to the current working directory )rcwdr-rSrTrrRr)r(rrs r)relative_filepathzObject.relative_filepath3shhj dmmT *!]] j)$005*)+/ /@@nornstu u !==,,S1 1 *)  !==  !s B"B."B+ .CCc|jS)aThe dotted path of this object. On regular objects (not aliases), the path is the canonical path. See also: [`canonical_path`][griffe.Object.canonical_path]. Examples: >>> import griffe >>> markdown = griffe.load("markdown") >>> markdown["core.Markdown.references"].path 'markdown.core.Markdown.references' )r0rNs r)pathz Object.pathJs"""r+c||j |jS|jjd|jS)zThe full dotted path of this object. The canonical path is the path where the object was defined (not imported). See also: [`path`][griffe.Object.path]. .)rDrnrrNs r)r0zObject.canonical_pathZs8 ;; 99 ++""#1TYYK00r+c|j |jS|j td|jjS)zThe modules collection attached to this object or its parents. Raises: ValueError: When no modules collection can be found in the object or its parents. z3no modules collection in this object or its parents)rrDrRrrNs r)rzObject.modules_collectionfsB  # # /++ + ;; RS S{{---r+c|j |jS|j td|jjS)aThe lines collection attached to this object or its parents. See also: [`lines`][griffe.Object.lines], [`source`][griffe.Object.source]. Raises: ValueError: When no modules collection can be found in the object or its parents. z1no lines collection in this object or its parents)rrDrRrVrNs r)rVzObject.lines_collectionssB  ! ! -)) ) ;; PQ Q{{+++r+c, |j}t|trgS |j|}|j r|S|j |jgS||jdz |jS#t$rgcYSwxYw#t $rgcYSwxYw)zThe lines containing the source of this object. See also: [`lines_collection`][griffe.Object.lines_collection], [`source`][griffe.Object.source]. rQ) rSrr-rTrVrrr&r')r(rSrOs r)rOz Object.liness }}H h %I ))(3E >>L ;; $.."8IT[[1_t~~66" I   I s" A4B4 BB BBcJtdj|jS)zThe source code of this object. See also: [`lines`][griffe.Object.lines], [`lines_collection`][griffe.Object.lines_collection]. rL)rrUrOrNs r)rWz Object.sourcesdii +,,r+c||jvrK|j|jr|j|jS|j|jS|jt |d|j||jj k(r,|jjs|jjS|jj|S)Resolve a name within this object's and parents' scope. Parameters: name: The name to resolve. Raises: NameResolutionError: When the name could not be resolved. Returns: The resolved name. z' could not be resolved in the scope of ) rr target_pathrrDrrnrresolver(rns r)r#zObject.resolves 4<< ||D!**||D)555<<%** * ;; %.UVZV_V_U`&ab b 4;;## #DKK,A,A;;## #{{""4((r+r\c  |j|jd}|r>|j|j|j|j |j d|j|j|d<|j|j|d<|jr|j|d<|j|d<|jjDcic]\}}||jd d|i|c}}|d<|Scc}}w) a%Return this object's data as a dictionary. See also: [`as_json`][griffe.Object.as_json]. Parameters: full: Whether to return full info, or just base info. **kwargs: Additional serialization options. Returns: A dictionary. )rjrn)rrSrrr&r'rlrr]rrA)rjrnupdaterrSrrr&r'rlrrrr5)r(r]r4r`rnrs r)r5zObject.as_dictsIIII   KK II $ )-)?)?151O1O   ;; "![[DN >> % $D  >> $D XY]YeYeYkYkYmnYmv4!DT!DV!DDYmnY osC?)rnr/r&r6r'r6rrfrlr~rDzModule | Class | NonerVzLinesCollection | NonerzModulesCollection | Noner7r8r9rr7rrjzstr | Kind | set[str | Kind]r7rfr7zdict[str, Alias]rr/r7rfrz Callable[[Object | Alias], bool]r7dict[str, Object | Alias]r7r r7zPath | list[Path]r7rr7rr7rrbrnr/r7r/re))r<r=r>r?__annotations__rrrr*rvrrr@rrrrrrrrrrrrrrrr r rSrrrr0rrVrOrWr#r5rAr+r)rrus9 JHd#M4#It" $&*(,377;o$o$ o$  o$  o$$o$&o$1o$5o$ o$b`X$$ &!4!!, ( ( ' ' * * + + 1$NN.  $ $)E)EV!!, # # 1 1 . . , ,77,--)B',%r+rcNeZdZUdZdZded< dZded< dddddd dPd ZdQd ZdRd Z dSd Z e dTd Z e dRdZ e dRdZe dUdZej dVdZe dQdZe dWdZe dXdZe dYdZdddZfdZe d[dZe d\dZe d\dZe d]dZej d^dZe d_dZe d`dZe dadZe dYd Zdbd!Ze dRd"Ze dRd#Z e dRd$Z!e dRd%Z"dcd&Z#ddd'Z$e ded(Z%e ded)Z&e dfd*Z'e dgd+Z(e dgd,Z)e dQd-Z*e dhd.Z+e did/Z,e dQd0Z-djd1Z.e dkd2Z/e dld3Z0e dmd4Z1e dRd5Z2e dRd6Z3e dRd7Z4e dRd8Z5e dRd9Z6e dRd:Z7e dnd;Z8e8j dod<Z8e dpd=Z9e dqd>Z:e:j drd?Z:e dsd@Ze dsdAZ;e dqdBZdvdFZ?e dwdGZ@e@j dxdHZ@e dydIZAdzdJZBdzdKZCdzdLZDe dRdMZEe d{dNZFddd|dOZGxZHS)}raYThis class represents an alias, or indirection, to an object declared in another module. Aliases represent objects that are in the scope of a module or class, but were imported from another module. They behave almost exactly like regular objects, to a few exceptions: - line numbers are those of the alias, not the target - the path is the alias path, not the canonical one - the name can be different from the target's - if the target can be resolved, the kind is the target's kind - if the target cannot be resolved, the kind becomes [Kind.ALIAS][griffe.Kind] TrfrFrN)r&r'rrDrc$||_ ||_ ||_ ||_ ||_ d|_ d|_ ||_d|_| t|trd|_ ||_ y||_ |j|_ |jy)a4Initialize the alias. Parameters: name: The alias name. target: If it's a string, the target resolution is delayed until accessing the target property. If it's an object, or even another alias, the target is immediately set. lineno: The alias starting line number. endlineno: The alias ending line number. runtime: Whether this alias is present at runtime or not. parent: The alias parent. inherited: Whether this alias wraps an inherited member. NF)rn alias_linenoalias_endlinenorrrr_parent_passed_throughr-r/_targetr"r_update_target_aliases)r(rntargetr&r'rrDrs r)r*zAlias.__init__s. (.4+42$ 9(@#' +-1P6< %* - fc "26DL%D !DL%{{D   ' ' )r+c<d|jd|jdS)NzAlias(rrt)rnr"rNs r)rvzAlias.__repr__=s" }Bt'7'7&:!< > D D F F f %VDDI I F   rNr\c  |jjdd|i|S#ttf$rt |dd|i|cYSwxYw)a8Return this target's data as a JSON string. See also: [`as_dict`][griffe.Alias.as_dict]. Parameters: full: Whether to return full info, or just base info. **kwargs: Additional serialization options passed to encoder. Returns: A JSON string. r]rA)rAas_jsonrrsuper)r(r]r4rs r)rQz Alias.as_jsonsU 8,4$$,,A$A&A A$&67 87?777 7 8s! AAc.|jjS)zSNamespaced dictionaries storing extra metadata for this object, used by extensions.)rArrNs r)rz Alias.extras  &&&r+c.|jjS)zqThe starting line number of the target object. See also: [`endlineno`][griffe.Alias.endlineno]. )rAr&rNs r)r&z Alias.lineno   '''r+c.|jjS)ziThe ending line number of the target object. See also: [`lineno`][griffe.Alias.lineno]. )rAr'rNs r)r'zAlias.endlinenos   ***r+c.|jjS)zThe target docstring. See also: [`has_docstring`][griffe.Alias.has_docstring], [`has_docstrings`][griffe.Alias.has_docstrings]. rArlrNs r)rlzAlias.docstrings  ***r+c&||j_yrdrX)r(rls r)rlzAlias.docstrings&/#r+c.|jjS)zwThe target labels (`property`, `dataclass`, etc.). See also: [`has_labels`][griffe.Alias.has_labels]. )rArrNs r)rz Alias.labelsrUr+c.|jjS)a-The other objects imported by this alias' target. Keys are the names within the object (`from ... import ... as AS_NAME`), while the values are the actual names of the objects (`from ... import REAL_NAME as ...`). See also: [`is_imported`][griffe.Alias.is_imported]. )rArrNs r)rz Alias.importss  (((r+c.|jjS)a The names of the objects exported by this (module) object through the `__all__` variable. Exports can contain string (object names) or resolvable names, like other lists of exports coming from submodules: ```python from .submodule import __all__ as submodule_all __all__ = ["hello", *submodule_all] ``` Exports get expanded by the loader before it expands wildcards and resolves aliases. See also: [`GriffeLoader.expand_exports`][griffe.GriffeLoader.expand_exports]. )rArrNs r)rz Alias.exportss"  (((r+c.|jjS)z$The aliases pointing to this object.)rArrNs r)rz Alias.aliasess  (((r+c8|jj|S)a Tell if this object is of the given kind. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class], [`is_function`][griffe.Alias.is_function], [`is_attribute`][griffe.Alias.is_attribute], [`is_alias`][griffe.Alias.is_alias]. Parameters: kind: An instance or set of kinds (strings or enumerations). Raises: ValueError: When an empty set is given as argument. Returns: True or False. )rArrs r)rz Alias.is_kinds$  ((..r+c.|jjS)a[Whether this object is a module. See also: [`is_init_module`][griffe.Alias.is_init_module]. [`is_class`][griffe.Alias.is_class], [`is_function`][griffe.Alias.is_function], [`is_attribute`][griffe.Alias.is_attribute], [`is_alias`][griffe.Alias.is_alias], [`is_kind`][griffe.Alias.is_kind]. )rArrNs r)rzAlias.is_module+s  ***r+c.|jjS)a"Whether this object is a class. See also: [`is_module`][griffe.Alias.is_module], [`is_function`][griffe.Alias.is_function], [`is_attribute`][griffe.Alias.is_attribute], [`is_alias`][griffe.Alias.is_alias], [`is_kind`][griffe.Alias.is_kind]. )rArrNs r)rzAlias.is_class8s  )))r+c.|jjS)aWhether this object is a function. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class], [`is_attribute`][griffe.Alias.is_attribute], [`is_alias`][griffe.Alias.is_alias], [`is_kind`][griffe.Alias.is_kind]. )rArrNs r)rzAlias.is_functionDs  ,,,r+c.|jjS)aWhether this object is an attribute. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class], [`is_function`][griffe.Alias.is_function], [`is_alias`][griffe.Alias.is_alias], [`is_kind`][griffe.Alias.is_kind]. )rArrNs r)rzAlias.is_attributePs  ---r+c4|jj|S)zTell if this object has all the given labels. See also: [`labels`][griffe.Alias.labels]. Parameters: *labels: Labels that must be present. Returns: True or False. )rArrs r)rzAlias.has_labels\s,t  ++V44r+c4|jj|S)aFilter and return members based on predicates. See also: [`members`][griffe.Alias.members], [`get_member`][griffe.Alias.get_member], [`set_member`][griffe.Alias.set_member]. Parameters: *predicates: A list of predicates, i.e. callables accepting a member as argument and returning a boolean. Returns: A dictionary of members. )rAr)r(rs r)rzAlias.filter_membersis0t  //<->?Ir+cdttttf|jj S)zThe parameters of the current function or `__init__` method for classes. This property can fetch inherited members, and therefore is part of the consumer API: do not use when producing Griffe trees! )r r rrtrArrNs r)rzAlias.parameters6s&E%/*D,=,=>IIIr+cJtt|jjS)z$The function return type annotation.r rtrAreturnsrNs r)rz Alias.returns@sHd//0888r+cB|tt|j_yrdr)r(rs r)rz Alias.returnsEs4;Xt(()1r+cJtt|jjS)z.The setter linked to this function (property).)r AttributerAsetterrNs r)rz Alias.setterIsIt001888r+cJtt|jjS)z/The deleter linked to this function (property).)r rrAdeleterrNs r)rz Alias.deleterNsIt001999r+cJtt|jjS)zThe attribute value.)r rrAr%rNs r)r%z Alias.valueSsIt001777r+cJtt|jjS)zThe attribute type annotation.r rrArirNs r)rizAlias.annotationXsIt001<<r?rr3rr*rvrrr@rjrrrDrrrrrrQrr&r'rlrrrrrrrrrrrr r rSrrr0rVrOrWr#rprrrurxrrrrrrrrrr%rirrr<rArrr;rrr5 __classcell__rs@r)rrsj Hd"M4" $048*8*%8*  8*  8*8*.8*8* 8*t=       ]]&&11..   &  ,',8,''((++++00(())))$))/( + + * * - - . . 5 =(())** 3 3 ; ;00 2 2''(( /&9944DDJJ>>::==DDGGQQVVJJ99 ^^<<99::88==CC==4   ]]332)B3 3((',r+rceZdZdZej ZdddfdZddZe ddZ e ddZ e ddZ e dd Z e dd Ze dd Ze dd Zdfd ZxZS)r z'The class representing a Python module.N)rScZt||i|||_tt|_y)zInitialize the module. Parameters: *args: See [`griffe.Object`][]. filepath: The module file path (directory for namespace [sub]packages, none for builtin modules). **kwargs: See [`griffe.Object`][]. N)rRr*rprrTr)r(rSargsr4rs r)r*zModule.__init__ s- $)&)3;4?4E@r+cb d|jdS#t$rd|jdcYSwxYw)NzModule(rt)rSrrnrNs r)rvzModule.__repr__s= ,T]]-Q/ /! ,TYYM+ + ,s ..c\|jt|j|jS)z{The file path of this module. Raises: BuiltinModuleError: When the instance filepath is None. )rprrnrNs r)rSzModule.filepaths' >> !$TYY/ /~~r+cd|jvxr7|jdjxr|jdjdk(S)rwrz__future__.annotations)rrr"rNs r)rxz!Module.imports_future_annotations(sK T\\ ) T ]+44 T ]+77;SS r+ct|jtry |jjj ddddk(S#t $rYywxYw)zsWhether this module is an `__init__.py` module. See also: [`is_module`][griffe.Module.is_module]. FrrQrr*)r-rSrTrnrMrrNs r)rzModule.is_init_module1sS dmmT * ==%%++C3A6*D D!  s+A AAcJt|j xr |jS)zzWhether this module is a package (top module). See also: [`is_subpackage`][griffe.Module.is_subpackage]. rfrDrrNs r)rzModule.is_package>s!  $$<)<)<>2D   $D  FsB)rr rSrr4r r7r8r9r.rr:)r<r=r>r?rrrjr*rvr@rSrxrrrrrr5rrs@r)r r s1 ;;DHL A,     ==99 r+r ceZdZdZej Zddd d fdZed dZ ed dZ d ddZ ddZ dfd Z xZS)rz&The class representing a Python class.N)rrruct||i||r t|ng|_ |xsg|_ t t|_y)zInitialize the class. Parameters: *args: See [`griffe.Object`][]. bases: The list of base classes, if any. decorators: The class decorators, if any. **kwargs: See [`griffe.Object`][]. N)rRr*rTrrrurr)r(rrrurr4rs r)r*zClass.__init__sK $)&)6;tE{  ,6+;#4?4E?r+ch |jdjS#t$r tcYSwxYw)zThe parameters of this class' `__init__` method, if any. This property fetches inherited members, and therefore is part of the consumer API: do not use when producing Griffe trees! r*) all_membersrrrrNs r)rzClass.parameterss5 ##J/:: : <  s 11c:g}|jD]Y}t|tr|n |j} |j|}|j r |j }|j|[|S#tttf$rtjd|YwxYw)zResolved class bases. This method is part of the consumer API: do not use when producing Griffe trees! See also: [`bases`][griffe.Class.bases], [`mro`][griffe.Class.mro]. zABase class %s is not loaded, or not static, it cannot be resolved) rrr-r/r0rrrArrrrrr)r(rr` base_path resolved_bases r)rzClass.resolved_basessJJD *4 54;N;NI 5 $ 7 7 B  ))$1$>$>M%%m4 )*:HE m `bkl ms'A--*BBc pg||j}|jDcgc]}|js|}}|s|gS|D]?}|j|vsdj|d|jz}t d||gt g|Dcgc]}|j |c}|Scc}wcc}w)Nz -> z=Cannot compute C3 linearization, inheritance cycle detected: )rrrrUrRr _mro)r(seenr`rrcycles r)rz Class._mros!!tyy!/3/B/BT/Btdmmd/BT6MDyyD  D)d499+,>> #`af`g!hiiS~RE'JED $E'JRERSSU(KsB.B. B3 c(|jddS)zReturn a list of classes in order corresponding to Python's MRO. See also: [`bases`][griffe.Class.bases], [`resolved_bases`][griffe.Class.resolved_bases]. rQN)rrNs r)rz Class.mros yy{12r+c t|di|}|j|d<|jDcgc]}|jdi|c}|d<|Scc}w)zReturn this class' data as a dictionary. See also: [`as_json`][griffe.Class.as_json]. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. rrrurA)rRr5rrru)r(r4r`decrs r)r5z Class.as_dictsYw(( W ?COkckk3F3O\ PsA) rr rrzSequence[Expr | str] | Nonerulist[Decorator] | Noner4r r7r8rr)rA)rztuple[str, ...]r7rrr:)r<r=r>r?rrrjr*r@rrrrr5rrs@r)rrs0 ::D .2-1 @@+@+ @  @  @<    , Tr+rczeZdZdZej Zdddd dfdZeddZ d fd Z xZ S) rtz)The class representing a Python function.N)rrruct||i||xs t|_ ||_ |xsg|_ d|_ |jD] }||_ y)a0Initialize the function. Parameters: *args: See [`griffe.Object`][]. parameters: The function parameters. returns: The function return annotation. decorators: The function decorators, if any. **kwargs: See [`griffe.Object`][]. N)rRr*rrrrurr.)r(rrrurr4rrs r)r*zFunction.__init__sa" $)&)&0&@JL&*1 2+5+;&049I!%I )r+c|jS)z*The type annotation of the returned value.)rrNs r)rizFunction.annotation rGr+c  t|di|}|jDcgc]}|jdi|c}|d<|jDcgc]}|jdi|c}|d<|j|d<|Scc}wcc}w)zReturn this function's data as a dictionary. See also: [`as_json`][griffe.Function.as_json]. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. rurrrA)rRr5rurr)r(r4r`rrqrs r)r5zFunction.as_dictsw((?COkckk3F3O\CG??S?%memm5f5?S\,,Y PSs A< B) rr rzParameters | Nonerr}rurr4r r7r8rr:) r<r=r>r?rrrjr*r@rir5rrs@r)rtrtsw3 ==D )-%)-1 &&&&# & + &  & &<r+rtcbeZdZdZej Zddd dfdZdfd ZxZ S)rz@The class representing a Python module/class/instance attribute.N)r%ricbt||i|||_ ||_ d|_ d|_y)zInitialize the function. Parameters: *args: See [`griffe.Object`][]. value: The attribute value, if any. annotation: The attribute annotation, if any. **kwargs: See [`griffe.Object`][]. N)rRr*r%rirr)r(r%rirr4rs r)r*zAttribute.__init__)s? $)&)(- "-7,'+ 1(, 2r+c t|di|}|j|j|d<|j|j|d<|S)zReturn this function's data as a dictionary. See also: [`as_json`][griffe.Attribute.as_json]. Parameters: **kwargs: Additional serialization options. Returns: A dictionary. r%rirA)rRr5r%ri)r(r4r`rs r)r5zAttribute.as_dictBsJw(( :: ! JJDM ?? &!%D  r+) rr r%r}rir}r4r r7r8r:) r<r=r>r?rrrjr*r5rrs@r)rr$sVJ >>D $((, 33!3& 3  3  32r+r): __future__rrH collectionsr contextlibrpathlibrtextwraprtypingrr r r r _griffe.c3linearr _griffe.docstrings.parsersrr_griffe.enumerationsrrr_griffe.exceptionsrrrr_griffe.expressionsrr_griffe.loggerr_griffe.mixinsrcollections.abcr_griffe.collectionsrr_griffe.docstrings.modelsrr functoolsr r"rCrhrrrr rrtrrAr+r)rs##<<+<<<nn2!+(F:(%% % P}}@QQhW'W'tt  t nV  V rwVwthFhV7v7t..r+