U Sh,K@sdZddlZddlmZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZmZddlmZddlmZmZmZmZmZmZmZmZdejedd d d ZGd d d eddZdejedd ddZ dejeddddZ!dejeddddZ"dejedd ddZ#e$e$dddZ%dejedd ddZ&e'GdddZ(e(ee$efeee$gdfe(dd d!Z)Gd"d#d#e*Z+ee$e e$fe ee$efdd$d%Z,dS)&z&The configuration for the myst parser.N) import_module) AnyCallableDictIterableIteratorListOptionalSequenceSetTuple TypedDictUnion) MystWarnings)any_ deep_iterable deep_mappingin_ instance_ofoptionalvalidate_fieldvalidate_fieldsMdParserConfig)instfieldvaluereturncCs~t|ts td|jd|t|ddddddd d d d d dddddg}|rhtd|jd|t||jt|dS)z5Check that the extensions are a list of known strings'z' not iterable: ZamsmathZ attrs_imageZ attrs_inlineZ attrs_blockZ colon_fenceZdeflist dollarmathZ fieldlistZhtml_admonitionZ html_imagelinkifyZ replacementsZ smartquotesZ strikethroughZ substitutiontasklistz' items not recognised: N) isinstancer TypeErrornameset difference ValueErrorsetattr)rrrdiffr*J/root/rtd-docs/venv/lib/python3.8/site-packages/myst_parser/config/main.pycheck_extensions"s0 r,c@s.eZdZUdZeed<eed<eeed<dS) UrlSchemeTypez(Type of the external schemes dictionary.urltitleclassesN)__name__ __module__ __qualname____doc__str__annotations__rr*r*r*r+r-?s r-F)totalc Cst|ttfrDtdd|Ds6td|jd|dd|D}t|tsdtd|jd|i}|D]z\}}t|tstd|jd||d kr|||<qpt|trd |i||<qpt|trtd d|Dstd|jd |d |d |kr:t|d ts:td|jd |d|d d|krtt|dtsttd|jd |d|dd|krt|dtstdd|dDstd|jd |d|d|||<qptd|jd |d|qpt ||j|d S)z8Check that the external schemes are of the right format.css|]}t|tVqdSNr"r5.0vr*r*r+ Jsz$check_url_schemes..rz' is not a list of strings: cSsi|] }|dqSr8r*r:r*r*r+ Lsz%check_url_schemes..' is not a dictionary: ' key is not a string: Nr.css|]}t|tVqdSr8r9r;kr*r*r+r=Zs[z]' keys are not strings: z][url]' is not a string: r/z][title]' is not a string: r0css|]}t|tVqdSr8r9)r;cr*r*r+r=gsz"][classes]' is not a list of str: z"]' value is not a string or dict: ) r"listtupleallr#r$dictitemsr5r()rrrZnew_dictkeyvalr*r*r+check_url_schemesGsN       rL)_rrrcCsjt|ttfrt|dkr0td|jd||D]0}t|trNt|dkr4td|jd|q4dS)zLCheck that the sub_delimiters are a tuple of length 2 of strings of length 1rz' is not a tuple of length 2: rz(' does not contain strings of length 1: N)r"rFrElenr#r$r5)rMrrdelimr*r*r+check_sub_delimitersusrQc Cst|ts td|jd||D]\}}t|tsPtd|jd|t|ttfrjt|dkrtd|jd|d|t|dtstd|jd|d|d|d d ks(t|d ts(td|jd|d |d q(d S) zDCheck that the inventories are a dict of {str: (str, Optional[str])}rr?r@rNrCz]' value is not a 2-item list: rz][0]' is not a string: rNz][1]' is not a null/string: ) r"rHr#r$rIr5rFrErO)rMrrrJrKr*r*r+check_inventoriess   rRc Cs|dkr dSt|trz&|dd\}}t|}t||}Wn:tk rv}ztd|jd||W5d}~XYnXt||j|t |std|jd|dS)z/Check that the heading_slug_func is a callable.N.rrz#' could not be loaded from string: z' is not callable: ) r"r5rsplitrgetattr ImportErrorr#r$r(callable)rrr module_pathZ function_namemodexcr*r*r+check_heading_slug_funcs  r[)textrcCs|dddS)z5Dummy slug function, this is imported during testing.Nr*)r\r*r*r+_test_slug_funcsr^cCs6tttttttf|||t||jt|dS)z9Check that the extensions are a sequence of known stringsN)rrr5rErFr%r(r$)rrrr*r*r+check_fence_as_directives r_c @s6eZdZUdZedddZejdee dddZ e e d <ejdee d ddZ e e d <eje ed dd Zeee d<ejeeeeeeefddd Zeee d<ejdee dddZe e d<ejdee dddZe e d<ejddedddddd Zeeeefe d<ejdeeeeeeefddgddZeeee d <eje ed!dd Z eee d"<ejeeeeeeefd#dd Z!e"ee d$<ejdee d%ddZ#e e d&<ejd'ee$d'd(d)d*d+d,d-d.gd/ddZ%e&e d0<ejde'd1d2d3d4dZ(ee)egefe d5<eje*e+eeeeee*d2d6d7dd8d Z,eeefe d9<ejd2ee d:ddZ-e e d;<ejd<eje*e+eee/ee*d2d?d@dAddBd Z0eee1fe d@<ejdCde2dDd@dgdEdFZ3e4eefe dG<ejd2ee dHdIdJdZ5e e dK<ejd2ee dLdMdJdZ6e e dN<ejd2ee dOdMdJdZ7e e dP<ejd2ee dQdMdJdZ8e e dR<ejdee dSdMdJdZ9e e dT<ejd2ee dUdMd2dgdVdZ:e e dW<ejdXeedYdMd2dgdVdZ;ee dZ<ejdee d[d\dJdZe e dc<eje*de?ddd_gd2d`deZ@eee4eeeffe df<dgdhZAe1ddidjdkZBeCe4ejDdlfddmdnZEe*fe*ddodpZFee4ee1ejDfddqdrZGdS)srzConfiguration options for the Markdown Parser. Note in the sphinx configuration these option names are prepended with ``myst_`` )rcCs`g}|D]8\}}}|jsq |jdt|}||d|q |jjdd|dS)z-Return a string representation of the config. repr_func=(, )) as_triplereprmetadatagetappend __class__r1join)self attributesr$rKfZval_strr*r*r+__repr__szMdParserConfig.__repr__FzUse strict CommonMark parser) validatorhelp)defaultrgcommonmark_onlyz+Use strict Github Flavoured Markdown parsergfm_onlyzEnable syntax extensions)default_factoryrgenable_extensionsz"Disable Commonmark syntax elementsdisable_syntaxz$Parse all links as simple hyperlinksall_links_externalz$Open all external links in a new tablinks_external_new_tabcCsdddddS)N)httphttpsmailtoftpr*r*r*r*r+s zMdParserConfig.z0URI schemes that are converted to external linkscCs tt|Sr8)rfrFr<r*r*r+r~z(list[str] | dict[str, None | str | dict])rprqr`doc_type url_schemesNz4Sphinx domain names to search in for link referencesZdocutils)rprqomit ref_domainszInterpret a code fence as a directive, for certain language names. This can be useful for fences like dot and mermaid, and interoperability with other Markdown renderers.fence_as_directivez4Add line numbers to code blocks with these languagesnumber_code_blocksz:Convert a `title` field in the front-matter to a H1 headertitle_to_headerrrrNz*Heading level depth to assign HTML anchorsheading_anchorszfFunction for creating heading anchors, or a python import path e.g. `my_package.my_module.my_function`Tz!None | Callable[[str], str] | str)rprq global_onlyrheading_slug_funczHTML meta tagscCsdddd|DdS)N{rccss|]}|dVqdSz: ...Nr*rAr*r*r+r=Gs*MdParserConfig...}rkrr*r*r+r~Gr)rpmerge_topmatterrqr` html_metaz'Place a transition before any footnotesfootnote_transitionzFor reading speed calculationswords_per_minutezSubstitutions mapping substitutionscCsdddd|DdS)Nrrccss|]}|dVqdSrr*rAr*r*r+r=dsrrrrr*r*r+r~dr)rprrq extensionr`)rrzSubstitution delimiters)rprqrr)rrrfrgsub_delimitersz&Recognise URLs without schema prefixesr )rprqrlinkify_fuzzy_linkszParse `$$...$$ (label)`rdmath_allow_labelsz'Allow initial/final spaces in `$ ... $`dmath_allow_spacez%Allow initial/final digits `1$ ...$2`dmath_allow_digitszParse inline `$$ ... $$`dmath_double_inlinez@Update sphinx.ext.mathjax configuration to ignore `$` delimiters)rprqrrrupdate_mathjaxz0tex2jax_process|mathjax_process|math|output_areaz#MathJax classes to add to math HTMLmathjax_classeszEnable checkboxesr!enable_checkboxesz4A list of warning types to suppress warning messagesZsphinx)rprqrrsuppress_warningsz*Syntax highlight code blocks with pygmentshighlight_code_blocksz@Mapping of key to (url, inv file), for intra-project referencing)rurfrg inventoriescCs t|dSr8)r)rlr*r*r+ __post_init__szMdParserConfig.__post_init__)kwargsrcKstj|f|S)zReturn a new object replacing specified fields with new values. Note: initiating the copy will also validate the new fields. )dcreplace)rlrr*r*r+copyszMdParserConfig.copy.cCs t|S)z*Return all attribute fields in this class.)rfields)clsr*r*r+ get_fieldsszMdParserConfig.get_fieldscCstj||dS)z+Return a dictionary of field name -> value.) dict_factory)rasdict)rlrr*r*r+as_dictszMdParserConfig.as_dictccsBddt|jD}t|D]\}}||||fVq$dS)z&Yield triples of (name, value, field).cSsi|] }|j|qSr*)r$)r;rnr*r*r+r>sz,MdParserConfig.as_triple..N)rrrjrrI)rlrr$rr*r*r+reszMdParserConfig.as_triple)Hr1r2r3r4r5rorrrboolrsr6rtr%r,rvr rErrFrwrrxryrLrrr r-rrr_rrr rrrintr[rrrHrrrrrrrrQrr rrrrrrrrrrrRrrr classmethodFieldrrrer*r*r*r+rs               " )config topmatterwarningrc Cs>i}|di}t|ts2|tjdt|n|}d|krV|tjd|d|d<d|krv|tjd|d|d<|}dd|D}|D]\}}||kr|tjd |q||\} } zt || |Wn<t k r} z|tjt | WYqW5d } ~ XYnX| j d r,| |}t |||q|S) zMerge the file-level topmatter with the global config. :param config: Global config. :param topmatter: Topmatter from the file. :param warning: Function to call with a warning (type, message). :returns: A new config object mystz'myst' key not a dict: rzGtop-level 'html_meta' key is deprecated, place under 'myst' key insteadrzKtop-level 'substitutions' key is deprecated, place under 'myst' key insteadcSsi|]\}}}|||fqSr*r*)r;r$rrr*r*r+r>sz$merge_file_level..zUnknown field: Nr)rhr"rHrZ MD_TOPMATTERtyperrerIr Exceptionr5rgr() rrrZupdatesrnewrr$r old_valuerrZr*r*r+merge_file_levelsB      rc@seZdZdZdS)TopmatterReadErrorzTopmatter parsing error.N)r1r2r3r4r*r*r*r+r3src Csddl}t|tr2|ds dSdd|D}zt|dsHWdSWntk r`YdSXg}|D]$}|dr|q||dqjz| d |}Wn8|j j |j jfk r}ztd |W5d}~XYnXt|tstd t||S) aRead the (optional) YAML topmatter from a source string. This is identified by the first line starting with `---`, then read up to a terminating line of `---`, or `...`. :param source: The source string to read from :return: The topmatter rN---css|] }|VqdSr8r*)r;liner*r*r+r=Esz!read_topmatter..)rz... zMalformed YAMLzYAML is not a dict: )yamlr"r5 startswith splitlinesnext StopIterationrirstripZ safe_loadrkparserZ ParserErrorscannerZ ScannerErrorrrHr)r\rZ top_matterrrgerrr*r*r+read_topmatter7s,      r)-r4 dataclassesr importlibrtypingrrrrrrr r r r r rZmyst_parser.warnings_rZ dc_validatorsrrrrrrrrrr,r-rLrQrRr[r5r^r_ dataclassrrrrrr*r*r*r+s@ 8 ( .   D  =