U /e#@sdZddlmZddlZeeZddlZddlZddl Z ddl m Z ddl m Z ddlmZddlmZdd lmZdd lmZmZdd lmZd ZGd ddeZddZdS)a Thoroughly document Bokeh model classes. The ``bokeh-model`` directive will automatically document all the attributes (including Bokeh properties) of a Bokeh Model subclass. A JSON prototype showing all the possible JSON fields will also be generated. This directive takes the name of a Bokeh model class as an argument and its module as an option: .. code-block:: rest .. bokeh-model:: Foo :module: bokeh.sphinxext.sample Examples -------- For the following definition of ``bokeh.sphinxext.sample.Foo``: .. code-block:: python class Foo(Model): ''' This is a Foo model. ''' index = Either(Auto, Enum('abc', 'def', 'xzy'), help="doc for index") value = Tuple(Float, Float, help="doc for value") usage yields the output: .. bokeh-model:: Foo :module: bokeh.sphinxext.sample The ``bokeh-model`` direction may be used explicitly, but it can also be used in conjunction with the :ref:`bokeh.sphinxext.bokeh_autodoc` extension. ) annotationsN) unchanged) SphinxError)Model)BokehDeprecationWarning) PARALLEL_SAFE)BokehDirective py_sig_re) MODEL_DETAIL)BokehModelDirectivesetupc@s*eZdZdZdZdZeedZddZdS)r Tr)module canonicalc Cs.d|j}t|}|dkr,td||\}}}}|jd}zt|}Wn(t k r|td|d|YnXt ||d} | dkrtd|d|t | t std|d t t jd td | } W5QRXtj| jd d d ddd} tj||drdn|| d} || dS)N z+Unable to parse signature for bokeh-model: rz,Unable to generate model reference docs for z, couldn't import module z6Unable to generate model reference docs: no model for z in module z)Unable to generate model reference docs: z, is not a subclass of Modelignore)categoryT)Zinclude_defaults),z: ) sort_keysindent separatorsz bokeh.models)name module_name model_jsonz )join argumentsr matchrgroupsoptions importlib import_module ImportErrorgetattr issubclassrwarningscatch_warningsfilterwarningsrjsondumpsZto_jsonr render startswithparse) selfsigmZ name_prefixZ model_nameZarglistZretannrrmodelZ model_objrZrst_textr1?/tmp/pip-unpacked-wheel-f5fndrjf/bokeh/sphinxext/bokeh_model.pyrunfs2      zBokehModelDirective.runN) __name__ __module__ __qualname__Z has_contentZrequired_argumentsZoptional_argumentsrZ option_specr3r1r1r1r2r \sr cCs|ddttS)z+ Required Sphinx extension setup function. pyz bokeh-model)Zadd_directive_to_domainr r)Zappr1r1r2r sr )__doc__ __future__rlogging getLoggerr4logr r(r%Zdocutils.parsers.rst.directivesrZ sphinx.errorsrZ bokeh.modelrZbokeh.util.warningsrrZbokeh_directiver r Z templatesr __all__r r r1r1r1r2s '        2