B \< @sxdZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl mZddlZddlmZddlmZddlmZmZdd lmZdd lmZdd lmZdd lmZdd lmZddlm Z!Gddde"Z#ddZ$ddZ%ddZ&d*ddZ'dde&e%dddddf ddZ(ddZ)d+d d!Z*d,d"d#Z+d$d%Z,e j-d&dfd'd(Z.e/d)krte.dS)-a" sphinx.ext.autosummary.generate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. Each generated RST file contains a single auto*:: directive which extracts the docstring of the referred item. Example Makefile rule:: generate: sphinx-autogen -o source/generated source/*.rst :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. )print_functionN)FileSystemLoaderTemplateNotFound)SandboxedEnvironment)__display_version__) package_dir)import_by_nameget_documenter)BuiltinTemplateLoader)__)SphinxComponentRegistry) safe_getattr) ensuredir)escapec@seZdZdZddZdS)DummyApplicationz3Dummy Application class for sphinx-autogen command.cCs t|_dS)N)r registry)selfr>lib/python3.7/site-packages/sphinx/ext/autosummary/generate.py__init__9szDummyApplication.__init__N)__name__ __module__ __qualname____doc__rrrrrr6src Cs^ddlm}m}m}m}m}m}m}m}||||||||g} x| D]} |j | j | qBWdS)Nr)ModuleDocumenterClassDocumenterExceptionDocumenterDataDocumenterFunctionDocumenterMethodDocumenterAttributeDocumenterInstanceAttributeDocumenter) Zsphinx.ext.autodocrrrrrrr r!rZadd_documenterobjtype) apprrrrrrr r!Z documenters documenterrrrsetup_documenters>s ( r%cCs t|dS)N)print)msgrrr _simple_infoNsr(cCstd|tjddS)Nz WARNING: )file)r&sysstderr)r'rrr _simple_warnSsr,=cCs$d|krtd|d|t|S)N zCan only underline single lines) ValueErrorlen)titlelinerrr _underlineXsr3z.rstFc ! stt|} t| dkr6| dddg| dd} |tdd| |r`|td|dk rzfdd |D}d} tjtd d d g} d} |dk rt} | j || d n|r| d|t | } t | d} t | jd<t| jd<t| jd<t|}g}xtt|tdD]\}}}|dkr.q|p>tj|}t|yt|\}}}}Wn8tk r}z|d||fwWdd}~XYnXtj|||}tj|rq||t|d}t||}|dk r| |}n6y| d|j}Wn tk r(| d}YnXgdffdd }i}|jdkrt||d<||d|d\|d<|d <||d!|d\|d"<|d#<||d$|d\|d%<|d&<nf|jd!krt||d<tt|t|j |d'<||d(d)g\|d*<|d+<||d,\|d-<|d.<|!d/}|jd0krZd/|dd1}|d1}d/|d1d}||d!<nd/|dd2|d2}}||d3<||d<||d4<|d2|d5<|j|d6<t|d7|d<|j"f|} |#| WdQRXqW|rt$|||||||d8 dS)9N z...iz,[autosummary] generating autosummary for: %sz, zutosummary] writing to %scsg|]}tj|qSr)ospathjoin).0filename) base_pathrr qsz-generate_autosummary_docs..ZextZ autosummary templates)dirsr)loaderZ underlinere)keyz%[autosummary] failed to import %r: %swzautosummary/%s.rstzautosummary/base.rstTc sg}xlt|D]`}yt||}Wntk r6wYnXt||}|j|kr|sdt|dd|jkr||qWfdd|D}||fS)Nrcs"g|]}|ks|ds|qS)_) startswith)r9x)include_publicrrr<szBgenerate_autosummary_docs..get_members..)dirr AttributeErrorr r"getattrrappend) objtyprFimporteditemsnamevaluer$Zpublic)r#)rFr get_memberss  z.generate_autosummary_docs..get_membersmodulemembersZfunction)rMZ functionsZ all_functionsclassclassesZ all_classesZ exception exceptionsZall_exceptionsZinherited_membersmethodrmethodsZ all_methods attributeZ attributesZall_attributes.)rWrYfullnameZobjnamerOr"r-) output_dirsuffixwarninfor;builder template_dirr#)%listsortedr0r r8r6r7rr Zinitinsertrrr3filters rst_escapefind_autosummary_in_filessetstrabspathrr ImportErrorisfilerJopenr Z get_templater"rrG__dict__keyssplitZrenderwritegenerate_autosummary_docs)!Zsourcesr^r_r`rar;rbrcimported_membersr#Zshowed_sourcesZ template_dirsZtemplate_loaderZ template_envrNZ new_filesrOr7Z template_namerKparentmod_namer@fnfdoctemplaterQnspartsZcls_nameZobj_nameZrenderedr)r#r;rrtas                         rtc CsRg}xH|D]@}tj|dddd$}|}|t||dWdQRXq W|S)z^Find out what items are documented in source/*.rst. See `find_autosummary_in_lines`. rzutf-8ignore)encodingerrors)r:N)codecsroread splitlinesextendfind_autosummary_in_lines) filenames documentedr:rylinesrrrris     ric Csy,t|\}}}}t|}t|||dStk r@YnPtk rp}ztd||fWdd}~XYn tk rtd|YnXgS)znFind out what items are documented in the given object's docstring. See `find_autosummary_in_lines`. )rRr:zFailed to import '%s': %sNz_Failed to import '%s'; the module executes module level statement and it might call sys.exit().) rpydocZgetdocrrrHrmr& SystemExit) rOrRr:Z real_namerKrvmodnamerr@rrrfind_autosummary_in_docstrings rcCstd}td}td}td}td}td}g} d} d} |} d} d }xp|D]f}| rP||}|r|d } |r\tjtj|| } q\||}|r|d } q\| d rq\||}|r2|d }| d r|d d}| r | | d s d| |f}| || | fq\|r\| |drLq\d} ||}|rxd} |d }d} d} q\| |}|r|d } | t | |dq\||}|r\|d} q\q\W| S)aFind out what items appear in autosummary:: directives in the given lines. Returns a list of (name, toctree, template) where *name* is a name of an object and *toctree* the :toctree: path of the corresponding autosummary directive (relative to the root of the file name), and *template* the value of the :template: option. *toctree* and *template* ``None`` if the directive does not have the corresponding options set. z^(\s*)\.\.\s+autosummary::\s*z.^\s*\.\.\s+automodule::\s*([A-Za-z0-9_.]+)\s*$z4^\s*\.\.\s+(current)?module::\s*([a-zA-Z0-9_.]+)\s*$z%^\s+(~?[_a-zA-Z][a-zA-Z0-9_.]*)\s*.*?z^\s+:toctree:\s*(.*?)\s*$z^\s+:template:\s*(.*?)\s*$NF:~rZz%s.%s T)r:)recompilematchgroupr6r7r8dirnamestriprDrJsearchrr)rrRr:Zautosummary_reZ automodule_reZ module_reZautosummary_item_reZtoctree_arg_reZtemplate_arg_rerZtoctreer{Zcurrent_moduleZin_autosummaryZ base_indentr2mrOrrrrsx                 rcCstjdtdtdd}|jddddtd |jd d td d |jddddtdd|jdddddtdd|jdddddtdd|jddd d!d"td#d|S)$Nz#%(prog)s [OPTIONS] ...z5For more information, visit .a Generate ReStructuredText using autosummary directives. sphinx-autogen is a frontend to sphinx.ext.autosummary.generate. It generates the reStructuredText files from the autosummary directives contained in the given input files. The format of the autosummary directive is documented in the ``sphinx.ext.autosummary`` Python module and can be read using:: pydoc sphinx.ext.autosummary )ZusageZepilogZ descriptionz --versionversionZ show_versionz %%(prog)s %s)actiondestr source_file+z&source files to generate rST files for)nargshelpz-oz --output-dirZstorer^z directory to place all output in)rrrz-sz--suffixr_Zrstz/default suffix for files (default: %(default)s))rrdefaultrz-tz --templatesr=z0custom template directory (default: %(default)s)z-iz--imported-members store_trueruFz0document imported members (default: %(default)s))argparseArgumentParserr add_argumentr)parserrrr get_parserns,            rrcCshtjtjdtjtjtddt }t |t |}t |j|jd|j|j|j|ddS)NrlocalesphinxrZ)rcrur#)rr setlocaleLC_ALLZ init_consoler6r7r8rrr%r parse_argsrtrr^r_r=ru)argvr#argsrrrmains  r__main__)r-)NN)NN)0rZ __future__rrrrr6rrr*Zjinja2rrZjinja2.sandboxrZ sphinx.localerrrZsphinx.ext.autosummaryrr Zsphinx.jinja2gluer r Zsphinx.registryr Zsphinx.util.inspectr Zsphinx.util.osutilrZsphinx.util.rstrrhobjectrr%r(r,r3rtrirrrrrrrrrrsJ             W+