a mߛ`ґ@sdZdZddlZddlZddlZddlZddlZddlZddlmZej dkrhddl m Z ddlm Z nddl m Z ddlmZ ddlZddlZddlZdd lmZmZmZmZej dkreZd d Zd d Zd8ddZd9ddZd:ddZd;ddZdddZ!d?ddZ"d@ddZ#dAd d!Z$dBd"d#Z%dCd$d%Z&dDd&d'Z'dEd(d)Z(d*d+Z)d,d-Z*Gd.d/d/ej+Z+Gd0d1d1ej,Z,Gd2d3d3ej-ej.Z-Gd4d5d5e Z Gd6d7d7e/Z0dS)Fau Command-line and common processing for Docutils front-end tools. Exports the following classes: * `OptionParser`: Standard Docutils command-line processing. * `Option`: Customized version of `optparse.Option`; validation support. * `Values`: Runtime settings; objects are simple structs (``object.attribute``). Supports cumulative list settings (attributes). * `ConfigParser`: Standard Docutils config file processing. Also exports the following functions: * Option callbacks: `store_multiple`, `read_config_file`. * Setting validators: `validate_encoding`, `validate_encoding_error_handler`, `validate_encoding_and_error_handler`, `validate_boolean`, `validate_ternary`, `validate_threshold`, `validate_colon_separated_list`, `validate_comma_separated_list`, `validate_dependency_file`. * `make_paths_absolute`. * SettingSpec manipulation: `filter_settings_spec`. ZreStructuredTextN) SUPPRESS_HELPr)RawConfigParser)getcwd)getcwdu)locale_encoding SafeString ErrorOutput ErrorStringcOs<|D]}t|j|dq|D]\}}t|j||q dS)z Store multiple values in `parser.values`. (Option callback.) Store `None` for each attribute named in `args`, and store the value for each key (attribute name) in `kwargs`. N)setattrvaluesitems)optionoptvalueparserargskwargsZ attributekeyr0lib/python3.9/site-packages/docutils/frontend.pystore_multiple8src CsPz||}Wn.ty<}z||WYd}~n d}~00|j||dS)zQ Read a configuration file during option processing. (Option callback.) N)get_config_file_settings ValueErrorerrorr update)rrrrZ new_settingsrrrrread_config_fileDs  rcCs6zt|Wn"ty0td||fYn0|S)Nz$setting "%s": unknown encoding: "%s")codecslookup LookupErrorsettingr option_parser config_parserconfig_sectionrrrvalidate_encodingNs  r&cCs2zt|Wnty,td|Yn0|S)Nzunknown encoding error handler: "%s" (choices: "strict", "ignore", "replace", "backslashreplace", "xmlcharrefreplace", and possibly others; see documentation for the Python ``codecs`` module))r lookup_errorr r!rrrvalidate_encoding_error_handlerWs  r(cCsnd|vrV|d\}}t|d|||||rB|||d|qZt|j|d|n|}t||||||S)z Side-effect: if an error handler is included in the value, it is inserted into the appropriate place as if it was a separate setting/option. :Z_error_handler)splitr(setr r r&)r"rr#r$r%encodingZhandlerrrr#validate_encoding_and_error_handlercs   r-cCsFt|tr|Sz|j|WSty@td|Yn0dS)z|Check/normalize boolean settings: True: '1', 'on', 'yes', 'true' False: '0', 'off', 'no','false', '' zunknown boolean value: "%s"N) isinstanceboolbooleansstriplowerKeyErrorr r!rrrvalidate_booleanys   r4cCsFt|ts|dur|Sz|j|WSty@|YS0dS)zCheck/normalize three-value settings: True: '1', 'on', 'yes', 'true' False: '0', 'off', 'no','false', '' any other value: returned as-is. N)r.r/r0r1r2r3r!rrrvalidate_ternarys  r5cCst|}|dkrtd|S)Nrz(negative value; must be positive or zero)intrr!rrrvalidate_nonnegative_intsr7c CsZz t|WStyTz|j|WYSttfyNtd|Yn0Yn0dS)Nzunknown threshold: %r.)r6r thresholdsr2r3AttributeErrorr r!rrrvalidate_thresholds  r:cCs2t|ts|d}n|}||d|S)Nr))r.listr*popextend)r"rr#r$r%lastrrr$validate_colon_separated_string_lists   r?cCs:t|ts|g}|}dd|dD}|||S)zHCheck/normalize list arguments (split at "," and strip whitespace). cSs g|]}|dr|dqS)z r1).0irrr z1validate_comma_separated_list..,)r.r;r<r*r=)r"rr#r$r%r>rrrrvalidate_comma_separated_lists   rFcCs"|sdS|dr|S|dSdS)Nz.//)endswithr!rrrvalidate_url_trailing_slashs  rIcCs2ztj|WSty,tjdYS0dSN)docutilsutilsDependencyListIOErrorr!rrrvalidate_dependency_files rOcCsBt|||||}|D](}tj|}||krtd||fq|S)Nz$Invalid class value %r (perhaps %r?))rFrKZnodesZmake_idr)r"rr#r$r%clsZ normalizedrrrvalidate_strip_classs rQc Cst|||||}g}|D]}z|dd\}}WnDtyP||YqYn&tyttd|ddYn0|}|d} t| dkr| }n t|dkrtd|dd|||fq|S)z~Check/normalize a comma separated list of smart quote definitions. Return a list of (language-tag, quotes) string tuples.r)z4Invalid value "%s". Format is ":".asciibackslashreplacez[Invalid value "%s". Please specify 4 quotes (primary open/close; secondary open/close).)rFr*r9appendrencoder1len) r"rr#r$r%Z lc_quotesitemZlangZquotesZmultichar_quotesrrrvalidate_smartquotes_localess0        rZcs`durt|D]H}||vr||}t|trDfdd|D}n|rRt|}|||<qdS)z Interpret filesystem path settings relative to the `base_path` given. Paths are values in `pathdict` whose keys are in `keys`. Get `keys` from `OptionParser.relative_path_settings`. Ncsg|]}t|qSr)make_one_path_absolute)rApath base_pathrrrC sz'make_paths_absolute..)rr.r;r[)Zpathdictkeysr^rrrr]rmake_paths_absolutes   r`cCstjtj||SrJ)osr\abspathjoin)r^r\rrrr[sr[cOst|}tdt|dD]h}g}||D]J}dd|dDd}||vrLq(||vrh|||q(||q(t|||<qt|S)aReturn a copy of `settings_spec` excluding/replacing some settings. `settings_spec` is a tuple of configuration settings with a structure described for docutils.SettingsSpec.settings_spec. Optional positional arguments are names of to-be-excluded settings. Keyword arguments are option specification replacements. (See the html4strict writer for an example.) rcSs*g|]"}|dr|ddddqS)z--rdN-_) startswithreplace)rAZ opt_stringrrrrC$s z(filter_settings_spec..rRr)r;rangerXr_rVtuple) settings_specZexcluderhsettingsrBZnewoptsZopt_specZopt_namerrrfilter_settings_specs    rmc@s0eZdZdZddZddZddZdd Zd S) Valuesz Updates list attributes by extension rather than by replacement. Works in conjunction with the `OptionParser.lists` instance attribute. cOs>tjj|g|Ri|t|dr.|jdur:tj|_dS)Nrecord_dependencies)optparsern__init__hasattrrorKrLrMselfrrrrrrq9s  zValues.__init__cCsht|tr|j}|}|jD]6}t||r"||vr"t||}|r"|||7}||=q"||dSrJ) r.rn__dict__copylistsr_rrgetattrZ _update_loose)rtZ other_dictr#r"rrrrr@s   z Values.updatecCs|j|jdS)z Return a shallow copy of `self`.)defaults) __class__ru)rtrrrrvLsz Values.copycCs&t||ddurt|||t||S)zUV.setdefault(n[,d]) -> getattr(V,n,d), also set D.n=d if n not in D or None. N)rxr )rtnamedefaultrrr setdefaultPs zValues.setdefaultN)__name__ __module__ __qualname____doc__rqrrvr}rrrrrn2s  rnc@s$eZdZejjddgZddZdS)Option validator overridesc Cstj|||||}|j}|r|jrt||}z||||}Wn:tyz}z"td|t|fWYd}~n d}~00t ||||j rt ||j d|S)z Call the validator function on applicable settings and evaluate the 'overrides' option. Extends `optparse.Option.process`. zError in option "%s": %sN) rprprocessdestrrx ExceptionZOptionValueErrorr r r) rtrrr rresultr" new_valuerrrrr\s"   zOption.processN)r~rrrprZATTRSrrrrrrXsrc8@sveZdZdZgdZdZdddddd Zd d d d d d d d d d Ze e j d dpXe pXdZ dZddddgifdddgdedfddgdddfddd gd!d"d#d$fd%d&d'gd!d(d#d$fd)d*gd!dd#d$fd+d,d-gdedfd.d/gd0d1ifd2d3gd4ed5d6fd7d8gd9d!d:d:d;fdd?fd@dAgd9ddBfdCdDgddedEfdFdGgdHddBfdIdJgddKdedLfdMdNgddKdfdOdPgdedfdQdRgddSdfdTdUgdVdWdXedYfdZd[gdVd\dXedYfd]d^d_gedd`daedbfdcdddegd!dd`d$fdfdgdhgd!dd`d$fdidjgedkddaedlfdmdngd!ddkd$fdodpgedqddaedlfdrdsgdedfdtdugddvdfdwdxgdydzd{fd|d}gddedEfd~dgdddBfdddgdedfddgdedfdddgddedfddgdedfde efddgde edfdedgeedfdddgddddfddgdzeddfddgdzdd4edfdddgddifdddgddifedgddifedgddifedgddifedgddifedgddifedgddifedgdVdedfedgddiff2fZdddddZdZdZdejejrdejp de j de j!fZ"ddd„Z#ddĄZ$ddƄZ%ddȄZ&ddʄZ'dd̄Z(dd΄Z)ddЄZ*dd҄Z+ddԄZ,dS) OptionParsera Parser for command-line and library use. The `settings_spec` specification here and in other Docutils components are merged to build the set of command-line options and runtime settings for this process. Common settings (defined below) and component-specific settings must not conflict. Short options are reserved for common settings, and components are restrict to using long options. )z/etc/docutils.confz./docutils.confz ~/.docutilsz(info 1 warning 2 error 3 severe 4 none 5rRrdrrU)infoZwarningrZsevereZnoneTF) 1ZonZyestrue0ZoffZnoZfalser,NrSrTzGeneral Docutils Optionsz'Specify the document title as metadata.z--titlez2Include a "Generated by Docutils" credit and link.z --generatorz-g store_true)actionrz"Do not include a generator credit.z--no-generatorZ store_false generator)rrz2Include the date at the end of the document (UTC).z--datez-dZ store_constz%Y-%m-%dZ datestamp)rconstrzInclude the time & date (UTC).z--timez-tz%Y-%m-%d %H:%M UTCz'Do not include a datestamp of any kind.z--no-datestampz&Include a "View document source" link.z --source-linkz-sz3Use for a source link; implies --source-link.z --source-urlmetavarzz-Do not include a "View document source" link.z--no-source-linkcallback)Z source_linkZ source_url)rrZ callback_argsz4Link from section headers to TOC entries. (default)z--toc-entry-backlinksZ toc_backlinksentry)rrrr|z0Link from section headers to the top of the TOC.z--toc-top-backlinkstop)rrrz+Disable backlinks to the table of contents.z--no-toc-backlinks)rrz6Link from footnotes/citations to references. (default)z--footnote-backlinks)rr|rz/Disable backlinks from footnotes and citations.z--no-footnote-backlinksZfootnote_backlinksz0Enable section numbering by Docutils. (default)z--section-numberingZ sectnum_xform)rrr|rz&Disable section numbering by Docutils.z--no-section-numberingz/Remove comment elements from the document tree.z--strip-commentsz6Leave comment elements in the document tree. (default)z--leave-commentsZstrip_commentszRemove all elements with classes="" from the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)z--strip-elements-with-classrVZstrip_elements_with_classesz)rrrrzRemove all classes="" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)z --strip-classZ strip_classeszReport system messages at or higher than : "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5"z--reportz-rZ report_levelz)choicesr|rrrz4Report all system messages. (Same as "--report=1".)z --verbosez-vz3Report no system messages. (Same as "--report=5".)z--quietz-qzdHalt execution at system messages at or above . Levels as in --report. Default: 4 (severe).z--haltZ halt_level)rrr|rrz6Halt at the slightest problem. Same as "--halt=info".z--strictzjEnable a non-zero exit status for non-halting system messages at or above . Default: 5 (disabled).z --exit-statusZexit_status_levelz3Enable debug-level system messages and diagnostics.z--debugz Disable debug output. (default)z --no-debugdebugz-Send the output of system messages to .z --warningswarning_streamz)rrz1Enable Python tracebacks when Docutils is halted.z --tracebackz%Disable Python tracebacks. (default)z--no-traceback tracebackziSpecify the encoding and optionally the error handler of input text. Default: :strict.z--input-encodingz-iz)rrzlSpecify the error handler for undecodable characters. Choices: "strict" (default), "ignore", and "replace".z--input-encoding-error-handlerstrict)r|rz^Specify the text encoding and optionally the error handler for output. Default: UTF-8:strict.z--output-encodingz-outf-8)rr|rzSpecify error handler for unencodable output characters; "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace".z--output-encoding-error-handlerzJSpecify text encoding and error handler for error output. Default: %s:%s.z--error-encodingz-ezSSpecify the error handler for unencodable characters in error output. Default: %s.z--error-encoding-error-handlerz)rr|rz)Write output file dependencies to .z--record-dependencies)rrr|z6Read configuration settings from , if it exists.z--configstring)rtyperrz,Show this program's version number and exit.z --versionz-Vrversionz Show this help message and exit.z--helpz-hhelpz --id-prefixr|rz--auto-id-prefixidz--dump-settingsz--dump-internalsz--dump-transformsz--dump-pseudo-xmlz--expose-internal-attributeZexpose_internals)rrrz--strict-visitor)_disable_config_source _destination _config_files)rgeneralz(%%prog (Docutils %s%s, Python %s, on %s)z [%s]rrc Osi|_g|_tjj|g|Rtdtjddd||jsD|j|_t |j |_ |ft ||_ | |j ||pvi|r|jdsz |}Wn2ty}z|t|WYd}~n d}~00||jdS)z `components` is a list of Docutils components each containing a ``.settings_spec`` attribute. `defaults` is a mapping of setting default overrides. NN)width)Z option_classZadd_help_optionZ formatterr)rw config_filesrprrqrZTitledHelpFormatterrversion_templater;relative_path_settingsrj componentspopulate_from_componentsset_defaults_from_dictryget_standard_config_settingsrrr ru)rtrryZread_config_filesrrZconfig_settingsrrrrrqOs0    $zOptionParser.__init__c Cs|D]}|durq|j}|j|jtdt|dD]}|||d\}}}|rnt|||}||n|}|D]8\} } } |j| d| i| } | ddkrvd|j | j <qv|j r6|j |j q6q|D]}|r|jr|j |jqdS)aE For each component, first populate from the `SettingsSpec.settings_spec` structure, then from the `SettingsSpec.settings_defaults` dictionary. After all components have been processed, check for and populate from each component's `SettingsSpec.settings_default_overrides` dictionary. NrrrrrVT)rkrr=rirXrpZ OptionGroupZadd_option_groupZ add_optiongetrwrsettings_defaultsryrZsettings_default_overrides) rtr componentrkrBtitleZ descriptionZ option_specgroupZ help_textZoption_stringsrrrrrros0   z%OptionParser.populate_from_componentscs|ztjdtj}Wnty.|j}Yn0tjjdtjvrjz ddl}Wnt yhddYn0fdd|DS) z:Return list of config files, from environment or standard.ZDOCUTILSCONFIGHOMErNcSs|SrJr)xrrrrDz8OptionParser.get_standard_config_files..csg|]}|r|qSrr@)rAfexpandrrrCrDz:OptionParser.get_standard_config_files..) raenvironr*pathsepr3standard_config_filesr\ expanduserpwd ImportError)rtrrrrrget_standard_config_filess     z&OptionParser.get_standard_config_filescCs*t}|D]}||||q|SrJ)rnrrr)rtrlfilenamerrrrs z)OptionParser.get_standard_config_settingscCst}||||j|jtj|}i}t}|j D]J}|sFq, section "Old-Format Configuration Files". zhUnable to read configuration file "%s": content not encoded as UTF-8. Skipping "%s" configuration file. cOs*tj|g|Ri|g|_t|_dSrJ)rrqrr _stderrrsrrrrqszConfigParser.__init__c Cst|ttfvr|g}|D]}zt|dd}WntyFYqYn0z,tjdkrdt |||nt |||Wn4t y|j |j||f|YqYn0||j||dr|||||qdS)Nrrroptions)rstrunicoderopenrNr version_inforZreadfpZ read_fileUnicodeDecodeErrorrwritenot_utf8_errorcloserrV has_sectionhandle_old_configvalidate_settings)rt filenamesr#rfprrrr s(        zConfigParser.readcCst|jt|d|d}|ds0|d|D]X\}}||jvrn|j|\}}||sv||nd}|}| ||s8| |||q8| ddS)Nrrr) warnings warn_explicit old_warningConfigDeprecationWarningrrZ add_sectionr old_settingsZ has_optionr+Zremove_section)rtrrrrrr"rrrr%s         zConfigParser.handle_old_configc Cs|D]}||D]}z||}Wnty>YqYn0|jr|||}z|j|||||d}Wn>ty}z&td||t|||fWYd}~n d}~00| ||||j r| ||j dqqdS)zi Call the validator function and implement overrides on all applicable settings. )r$r%zAError in config file "%s", section "[%s]": %s %s = %sN) Zsectionsrrr3rrrrr r+r) rtrr#rr"rrrrrrrr7s0      zConfigParser.validate_settingscCs|ddS)zW Transform '-' to '_' so the cmdline form of option names can be used. rerf)r2rh)rtZ optionstrrrr optionxformSszConfigParser.optionxformcCs2i}||r.||D]}|||||<q|S)zf Return a given section as a dictionary (empty if the section doesn't exist). )rrr)rtrZ section_dictrrrrrYs  zConfigParser.get_sectionN) r~rrrrrrqrrrrrrrrrrs rc@seZdZdZdS)rz3Warning for deprecated configuration file features.N)r~rrrrrrrresr)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)NN)N)1rZ __docformat__raos.pathrrrrprrZ configparserrrrrrKZdocutils.utilsZdocutils.nodesZdocutils.utils.error_reportingrr r r rrrrr&r(r-r4r5r7r:r?rFrIrOrQrZr`r[rmrnrrZ SettingsSpecDeprecationWarningrrrrrsr               # &~v