o ٷi6@sdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z ee Z iZddZd d Zgd Ze d d dddZdddddZd ddZddZddZdS)!zNContains methods that generate documentation for Gradio functions and classes.) annotationsN) defaultdict)Callable) lru_cachecCsdS)zRA no-op for backwards compatibility of custom components published prior to 4.16.0N)mrrO/home/ubuntu/.local/lib/python3.10/site-packages/gradio_client/documentation.pyset_documentation_groupsr c Cst|j}dd|dD}d}t|D]\}}|d|ds,|d|dr.nq|dur>td|d|j|d |}|d |d }t |d |D]}||drrt d |d|jd ||d ||qSd ||d |} | S)NcSsg|]}|qSr)strip).0linerrr sz-extract_instance_attr_doc.. zself.:z =zCould not find z in z"""z-Found another attribute before docstring for : z start: ) inspect getsource__init__split enumerate startswith NameError__name__indexrange ValueErrorjoin) clsattrcodelinesir start_lineend_linej doc_stringrrrextract_instance_attr_docs6   r())zgradio._simple_templates component)z gradio.blockblock)z gradio.chat chatinterface)zgradio.componentr))z gradio.eventshelpers)zgradio.data_classesr,)zgradio.exceptionsr,)zgradio.externalr,)z gradio.flagflagging)zgradio.helpersr,)zgradio.interface interface)z gradio.layoutlayout)z gradio.routeroutes)z gradio.themethemes)gradio_client.z py-client)z gradio.utilsr,)zgradio.renderable renderable )maxsizereturnstrcCs.tD] \}}||r|Sqtd|)Nz(No known documentation group for module )_module_prefixesrr)modnameprefixgrouprrr_get_module_documentation_groupCs  r<F)inheritdocumentation_groupcs|fdd}|S)a Defines the @document decorator which adds classes or functions to the Gradio documentation at www.gradio.app/docs. Usage examples: - Put @document() above a class to document the class and its constructor. - Put @document("fn1", "fn2") above a class to also document methods fn1 and fn2. - Put @document("*fn3") with an asterisk above a class to document the instance attribute methods f3. c st}t|dr||j7}rdt|<}durPzt|j}|ds+|dr0t|}n Wnt yO}zt d|d|WYd}~nd}~wwt | ||f|S)NEVENTSzgradio.r2z&Could not get documentation group for r)listhasattrr?classes_inherit_documentationr getmodulerrr< Exceptionwarningswarnclasses_to_documentappend)r functionsr>r9exc_documentation_groupfnsr=rr inner_docWs*    "zdocument..inner_docr)r=r>rMrNrrKrdocumentKs rOfnr(tuple[str, list[dict], dict, str | None]c Cs>t|pd}|d}t|}giggf\}}}}d} |D]} | } | dkr,d} q| drOd} d| vrNd | vrN| dd d d } | |jkrNd } q| d krVd} q| dkrf|| rb| ndq| dsu| dksut | | ds| dkst d|jd| | dd} | dkr| d} | dkrt d|jd| | d| } | | dd}||| <q| dkr|| q| dkr|| qd |}g}|j D]v\}}|drq|dkrq|dvr||vrq||j||d}||vr||=|jtjjkr0|j}t|trd|d}|jjdkr+|jjd}||d <n|d!durMd"|d!vrBd#|d"<d$|d!vrMd#|d$<||q|rotd|jd%d& |d'd& |j t|d kryi}nt|d kr|j|d d(}ni}t|d krd |nd}||||fS))a Generates documentation for any function. Parameters: fn: Function to document Returns: description: General description of fn parameters: A list of dicts for each parameter, storing data for the parameter name, annotation and doc return: A dict storing data for the returned annotation and doc example: Code for an example use of the fn r descriptionz Parameters: parameterzExample:example()rrignorezReturns:r6
 Documentation format for  has format error in line: Nrr_self)kwargsargs)name annotationdoc"builtinsz()defaultrfrbTrcz# documents nonexistent parameters: z, z. Valid parameters: )rerf)rgetdocr signaturerstriprrrHr print SyntaxErrorrr parametersitemsregetri Parameterempty isinstancer7 __class__ __module__rkeyslenreturn_annotation)rPrdoc_str doc_linesrkrSroreturnsexamplesmoder c colon_indexrT parameter_docdescription_docparameter_docs param_nameparamri return_docs examples_docrrr document_fnqs                    rc Cst|}|durdidfSi}g}d}|dD]u}|}|dr5d|vr5|dd}g||<q|dddr_|ds_|d|d}||dd d}|||<q|dkro|| rk|nd q|ds| rt d |j d ||||d dqd|vrd |d}|d=nd}| D]\} } t| trd | || <qd |dd } | ||fS)NrRrSrrrr^rrZr_rYr[r\r]rU)rrjrrlendswithlowerrrrHr rnrrrprtr@replace) rrztagsdescription_linesr~r tagvaluerUkeyvalrSrrr document_clss@      rcCsi}tD]\}}g||<|D]\}}t|st|r!|n|j}t||\}}}}t|dr`t |j r`t|dr`t |j r`t|j |} t|j |} | d| dd| d| dd} } t |\} } } ||j | | ||| gd}t|drt |j rt|drt |j r| |d<| |d<|D]d}|d}|r|dd}t||j}nt||}t |st|}i}i}d}d |j d |}nt||\}}}}|t|d gvr|dd}d}|rt||}|d |||i||||d q||||tvr|d t|<qqtD]W\}}t|D]M\}\}}tD]A\}}t|r`t||r`||kr`|D](}t|}z t||d|d<Wn tyRYnw|||d |q7q qq|S)N preprocess postprocessrr_)r return_doc)classrdrSrror|rUrM*rRzgr..r?rM)rPrdrSrror|rUoverride_signaturerdrS)rGrpr isfunction dataclasses is_dataclassrrrAcallablerrrrrgetattr__call__r7r(rHrBrisclass issubclassdictr) documentationr~ class_listrrMfn_to_documentr`rrpreprocess_docpostprocess_doccls_descriptioncls_tags cls_examplecls_documentationfn_nameinstance_attribute_fnrPrrrrrr# super_class inherited_fnrrrgenerate_documentations            V  r)r6r7)rPrr6rQ)__doc__ __future__rrrrE collectionsrcollections.abcr functoolsrr@rGrBr r(r8r<rOrrrrrrrs&      &b $