U \Shv@sUdZddlmZddlZddlZddlZddlmZddlmZddl m Z m Z ddlm Z ddl m Z mZmZmZmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZm Z m!Z!m"Z"ddl#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,m-Z-m.Z.ddl/m0Z0ddl1m2Z2m3Z3ddl4m5Z5ddl6m7Z7m8Z8e rtddl9m:Z:ddl;mZ?ddddddd dd!dddd"dgd#Z@d$eAd%<d&ZBd'ZCd(ZDd)ZEd*ZFeDe&d+eEe&d,eFe&d-iZGde5d.ZHd/eAd0<e rdd1l mIZImJZJdd2lKmLZLdd3lMmNZNdd4lOmPZPdd5lQmRZRdd6lSmTZTdd7lUmVZVdd8lWmXZXdd9lYmZZZdd:l[m\Z\dd;l]m^Z^ddlcmdZdGd?d@d@eJeeefZfnegZfGdAdBdBZhdCdDdEdFdGZidS)HzGlobal creation environment.) annotationsN) defaultdict)copy)datetimetimezone)path) TYPE_CHECKINGAnyCallable GeneratorIterator)nodes)Node)addnodes)Config)Domain)TocTree)BuildEnvironmentError DocumentErrorExtensionError SphinxError) EventManager)__)Project)SphinxTransformer) DownloadFilesFilenameUniqDictlogging)LoggingReporter)CatalogRepositorydocname_to_domain)is_translatable) canon_pathos_path)Sphinx)BuilderidlinkFTzhttps://peps.python.org/z&https://datatracker.ietf.org/doc/html/z utf-8-sig)Zauto_id_prefixZ image_loadingZembed_stylesheetZcloak_email_addressesZ pep_base_urlZpep_referencesZ rfc_base_urlZrfc_referencesinput_encodingZdoctitle_xformZsectsubtitle_xformZsection_self_linkZ halt_levelZfile_insertion_enabledZsmartquotes_localeszdict[str, Any]default_settings:z new configzconfig changedzextensions changed)nonetextzdict[str, bool | Callable]versioning_conditions)LiteralMutableMapping)overload)CDomain)ChangeSetDomain)CitationDomain) CPPDomain) IndexDomain)JavaScriptDomain) MathDomain) PythonDomain) ReSTDomain)StandardDomain)DurationDomain) TodoDomainc@s8eZdZedddddZedddddZed d dd dZed d dddZedddddZedddddZedddddZedddddZedddddZedddd dZed!d"dd#dZed$d%dd&dZed'd(dd)dZd*dZd+d,Zd-d.Zd/d0Zd1d2Zd3S)4 _DomainsTypez Literal['c']r6)keyreturncCsdSNselfrCrFrFN/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/environment/__init__.py __getitem__asz_DomainsType.__getitem__zLiteral['cpp']r9cCsdSrErFrGrFrFrIrJcszLiteral['changeset']r7cCsdSrErFrGrFrFrIrJeszLiteral['citation']r8cCsdSrErFrGrFrFrIrJgszLiteral['index']r:cCsdSrErFrGrFrFrIrJisz Literal['js']r;cCsdSrErFrGrFrFrIrJkszLiteral['math']r<cCsdSrErFrGrFrFrIrJmsz Literal['py']r=cCsdSrErFrGrFrFrIrJoszLiteral['rst']r>cCsdSrErFrGrFrFrIrJqszLiteral['std']r?cCsdSrErFrGrFrFrIrJsszLiteral['duration']r@cCsdSrErFrGrFrFrIrJuszLiteral['todo']rAcCsdSrErFrGrFrFrIrJwsstrrcCsdSrErFrGrFrFrIrJyscCstdSrENotImplementedErrorrGrFrFrIrJ{cCstdSrErL)rHrCvaluerFrFrI __setitem__|rNz_DomainsType.__setitem__cCstdSrErLrGrFrFrI __delitem__}rNz_DomainsType.__delitem__cCstdSrErLrHrFrFrI__iter__~rNz_DomainsType.__iter__cCstdSrErLrRrFrFrI__len__rNz_DomainsType.__len__N) __name__ __module__ __qualname__r5rJrPrQrSrTrFrFrFrIrB`s>rBc @s<eZdZUdZded<ddddZdd d d Zdd d ddZdd dddZdd dddZ dd dddZ ddd dddZ dd dd d!Z d"ddd d#d$d%Z dd&d'd(d)Zdpdddd+d,d-Zdqdd&d/d0d1d2Zed3d d4d5Zdd6d d7d8d9Zdd:d;dd?d@dAZdd ddBdCZedd dDdEZdrddGdHdIdJZdd d'dKdLZdd d'dMdNZd d dOdPZddQdRdSdTZddUddVdWZejdUd dXdYZ dsdd6d[dddUd\d]d^Z!dtdd6d`ddGddddadb dcddZ"dUdd6d dedfdgZ#dUdd dhdidjZ$dkd dldmZ%d d dndoZ&d.S)uBuildEnvironmentz The environment in which the ReST files are translated. Stores an inventory of cross-file targets and provides doctree transformations to resolve links to them. rBdomainsr$)appcCs<d|_d|_d|_d|_d|_d|_d|_d|_d|_d|_ d|_ t |_ t |_||jd<i|_tt|_tt|_t|_i|_i|_tt|_i|_i|_i|_i|_i|_i|_i|_ i|_!t|_"t|_#i|_$t%|_&t'|_(i|_)i|_*i|_+i|_,i|_-i|_.i|_/i|_0i|_1i|_2i|_3|4|dS)Nenv)5rZ doctreedirsrcdirconfig config_statusconfig_status_extraeventsprojectversionversioning_conditionversioning_comparerBrYr*rsettingsall_docsrset dependenciesincluded reread_always_pickled_doctree_cache_write_doc_doctree_cachedictmetadatatitlesZ longtitlesZtocsZtoc_num_entriesZtoc_secnumbersZtoc_fignumberstoctree_includesfiles_to_rebuildZ glob_toctreesZnumbered_toctrees domaindatarZimagesrZdlfilesZoriginal_image_uri temp_dataZ ref_contextZ_search_index_titlesZ_search_index_filenamesZ_search_index_mappingZ_search_index_title_mappingZ_search_index_all_titlesZ_search_index_index_entriesZ_search_index_objtypesZ_search_index_objnamessetup)rHrZrFrFrI__init__s\     zBuildEnvironment.__init__rn)rDcCs|j}|jdidd|S)z'Obtains serializable data for pickling.N)rZrYra)__dict__rupdate)rHrwrFrFrI __getstate__s zBuildEnvironment.__getstate__None)staterDcCs|j|dSrE)rwrx)rHr{rFrFrI __setstate__ szBuildEnvironment.__setstate__)rZrDcCs|jr$|j|j|kr$ttd|jrB|j|jkrBttd|jrV|j|j||_|j |_ |j |_ |j|_|j|_|j||_t |_ |j |D]}||j |j<q|j D] }|q||j||jdS)zSet up BuildEnvironment object.z%build environment version not currentzsource directory has changedN)rcregistryZget_envversionrrr]rbZrestorerZr\rarBrYZcreate_domainsnamevaluesru_update_configr^_update_settings)rHrZdomainrFrFrIru s&    zBuildEnvironment.setupr)r^rDcCst|_d|_|jdkrt|_n|jj|jkrt|_tt|jjt|jA}t |dkrb|d}ndt |f}d|d|_n<| dD]0}|j|j |j krt |_d|j d|_qq||_dS) z!Update configurations by new one.Nr,rz%dz ()r[) CONFIG_OKr_r`r^ CONFIG_NEW extensionsCONFIG_EXTENSIONS_CHANGEDsortedrhlenfilterr~rOCONFIG_CHANGED)rHr^r extensionitemrFrFrIr,s&   zBuildEnvironment._update_configcCs6|j|jd<|j|jd<|j|jd<|jdddS)zUpdate settings by new config.r)trim_footnote_reference_spaceZ language_codeZ smart_quotesTN)source_encodingrfrlanguage setdefault)rHr^rFrFrIrFs   z!BuildEnvironment._update_settingszstr | Callablebool)methodcomparerDcCsTt|r|}n|tkr"td|t|}|jd|fkrDttd||_||_dS)aXThis sets the doctree versioning method for this environment. Versioning methods are a builder property; only builders with the same versioning method can share the same doctree directory. Therefore, we raise an exception if the user tries to use an environment with an incompatible versioning method. zinvalid versioning method: %rNzdThis environment is incompatible with the selected builder, please choose another doctree directory.)callabler2 ValueErrorrdrrre)rHrr conditionrFrFrIset_versioning_methodOs   z&BuildEnvironment.set_versioning_methodrK)docnamerDcCsP||jkr2|j|d|j|d|j||jD]}||qsz/BuildEnvironment.find_files..z"Failed to scan documents in %s: %rN)r^Zexclude_patternsZtemplates_pathZget_asset_pathsrbdiscoverZinclude_patternsZuse_message_catalogrr]Z locale_dirsrrZcatalogsrr Zgettext_compactrirOSErrorrr) rHr^rZ exclude_pathsrepoZmo_pathsrrexcrFrFrI find_filess.  zBuildEnvironment.find_filesz#tuple[set[str], set[str], set[str]])config_changedrDc Cst|j|j}t}t}|r*|j}nv|jD]l}||jkrXtd|||q0t|j|d}t |std|||q0||j krtd|||q0|j|}t | |}||krt j|dtjd} t j|dtjd} td|| | ||q0|j|D]~} zPt|j| } t | sN||Wq0t | } | |krp||Wq0Wn&tk r||Yq0YnXqq0|||fS)z&Return (added, changed, removed) sets.z[build target] added %r.doctreez[build target] changed %ri@B)tzz$[build target] outdated %r: %s -> %s)rhrgrloggerdebugrrrr\isfilerk_last_modified_timerr fromtimestamprutcrir]r)rHrZremovedaddedchangedrrmtimeZnewmtimeZmtime_dtZ newmtime_dtdepZdeppathZdepmtimerFrFrIget_outdated_filessZ                    z#BuildEnvironment.get_outdated_fileszGenerator[str, None, None])rZalreadyrDccsBg}|jd|D]}||qt|D]}||kr*|Vq*dS)Nzenv-get-updated)rarextendrh)rHrZrZ to_rewriterrrFrFrIcheck_dependentss   z!BuildEnvironment.check_dependentscCs2||jd<|jj|jd<|j|jj|jd<dS)z*Prepare to set up environment for reading.r default_roleZdefault_domainN)rtr^rrYgetZprimary_domain)rHrrFrFrIprepare_settings s z!BuildEnvironment.prepare_settingscCs |jdS)z;Returns the docname of the document currently being parsed.r)rtrRrFrFrIrszBuildEnvironment.docnamerint)categoryrDcCs(|d}|j|d}|d|j|<|S)zReturn a serial number, e.g. for index entry targets. The number is guaranteed to be unique in the current document. Zserialnorr,)rtr)rHrrCcurrFrFrI new_serialnoszBuildEnvironment.new_serialnocCs|j|j|dS)zAdd *filename* as a dependency of the current document. This means that the document will be rebuilt if this file changes. *filename* should be absolute or relative to the source directory. N)rirrrrFrFrInote_dependency$sz BuildEnvironment.note_dependencycCs$||}|r |j|j|dS)zAdd *filename* as a included from other document. This means the document is not orphaned. *filename* should be absolute or relative to the source directory. N)rrjrr)rHrdocrFrFrI note_included-s zBuildEnvironment.note_includedcCs|j|jdS)zxAdd the current document to the list of documents that will automatically be re-read at the next build. N)rkrrrRrFrFrI note_reread8szBuildEnvironment.note_rereadr)rrDc CsFz |j|WStk r@}zttd||W5d}~XYnXdS)zReturn the domain instance with the specified name. Raises an ExtensionError if the domain is not registered. zDomain %r is not registeredN)rYKeyErrorrr)rHrrrFrFrI get_domain>s zBuildEnvironment.get_domainznodes.documentc Csz|j|}WnNtk r\t|j|d}t|d}|}|j|<W5QRXYnXt|}||j _ t | ||_ |S)z:Read the doctree for a file from the pickle and return it.rrb)rlrrrr\openreadpickleloadsrfr[rrreporter)rHrZ serialisedrfdoctreerFrFrI get_doctreeJs " zBuildEnvironment.get_doctreecCs||jjSrE)rr^root_docrRrFrFrImaster_doctreeXszBuildEnvironment.master_doctreeFznodes.document | None)rrrprune_toctrees includehiddenrDcCs|dkrPz(|j|}||j_t|||_Wntk rN||}YnX| ||| t j D]>}t |j|||||d}|dkr|j|gqh||qh|S)zgRead the doctree from the pickle, resolve cross-references and toctrees and return it. N)pruner)rmrrfr[rrrrrapply_post_transformsfindallrtoctreerresolveparentreplaceZ replace_self)rHrrrrrZ toctreenoderesultrFrFrIget_and_resolve_doctree\s"    z(BuildEnvironment.get_and_resolve_doctreerzaddnodes.toctreez Node | None) rrrrmaxdepth titles_onlycollapserrDc Cst|||||||||S)aResolve a *toctree* node into individual bullet lists with titles as items, returning None (if no containing titles are found) or a new node. If *prune* is True, the tree is pruned to *maxdepth*, or if that is 0, to the value of the *maxdepth* option on the *toctree* node. If *titles_only* is True, only toplevel document titles will be in the resulting tree. If *collapse* is True, all branches not containing docname will be collapsed. )rr) rHrrrrrrrrrFrFrIresolve_toctree~s z BuildEnvironment.resolve_toctree)r fromdocnamerrDcCs|||dSrE)r)rHrrrrFrFrIresolve_referencessz#BuildEnvironment.resolve_references)rrrDcCsbzDt|j}||jd<t|}||||jj|W5||_X|j d||dS)zApply all post-transforms.rzdoctree-resolvedN) rtrrZset_environmentZadd_transformsrZr}Zget_post_transformsZapply_transformsrar)rHrrbackupZ transformerrFrFrIrs    z&BuildEnvironment.apply_post_transformszdict[str, list[str | None]]cs|tddddfdd i}djj}d}t|\}}|D]"\}}|||g||<|}|}|}qF||dg||<|S)NrrKz Iterator[tuple[str | None, str]])rrrDc3s||kr"tjtd|ddddS||fV|j|pDgD]4}||D]$\}}|krT||fV|qTqFdS)Nz'self referenced toctree found. Ignored.ZtocZcircular)locationtypesubtype)rwarningrrrqr)rrchildZ subparentZ subdocnamerHtraverse_toctreeZ traversedrFrIrs    z.traverse_toctree)rhr^rnext)rHZ relationsrZprevdocrrZ nextparentZnextdocrFrrIcollect_relationss  z"BuildEnvironment.collect_relationscCstj|j}t|jD]H}||jkr||jjkr8q||krBqd|j |krRqt j t d|dq|j D] }|qp|jd|dS)zDo consistency checks.Zorphanz&document isn't included in any toctree)rzenv-check-consistencyN)rhunionrjrrrgrrr^rrorrrrYcheck_consistencyrar)rHrjrrrFrFrIrs    z"BuildEnvironment.check_consistency)T)N)r)NTF)TrFFF)'rUrVrW__doc____annotations__rvryr|rurrrrrrrrpropertyrrrrrrrrrrrr functoolscached_propertyrrrrrrrrFrFrFrIrXsX s   ;      # $rXzstr | os.PathLike[str]rrcCst|jd S)a5Return the last modified time of ``filename``. The time is returned as integer microseconds. The lowest common denominator of modern file-systems seems to be microsecond-level precision. We prefer to err on the side of re-rendering a file, so we round up to the nearest microsecond. i)rstat st_mtime_ns)rrFrFrIrs r)jr __future__rrrr collectionsrrrrrtypingrr r r r Zdocutilsr Zdocutils.nodesrZsphinxrZ sphinx.configrZsphinx.domainsrZ#sphinx.environment.adapters.toctreerZ sphinx.errorsrrrrZ sphinx.eventsrZ sphinx.localerZsphinx.projectrZsphinx.transformsrZ sphinx.utilrrrZsphinx.util.docutilsrZsphinx.util.i18nrr Zsphinx.util.nodesr!Zsphinx.util.osutilr"r#Zsphinx.applicationr$Zsphinx.buildersr% getLoggerrUrr*rZ ENV_VERSIONrrrrZCONFIG_CHANGED_REASONr2r3r4typing_extensionsr5Zsphinx.domains.cr6Zsphinx.domains.changesetr7Zsphinx.domains.citationr8Zsphinx.domains.cppr9Zsphinx.domains.indexr:Zsphinx.domains.javascriptr;Zsphinx.domains.mathr<Zsphinx.domains.pythonr=Zsphinx.domains.rstr>Zsphinx.domains.stdr?Zsphinx.ext.durationr@Zsphinx.ext.todorArKrBrnrXrrFrFrFrIs                                "^