o iaR@sddlZddlmZddlmZddlmZddlZddlZddl m Z m Z m Z ddl mZmZGdddZGd d d eeZGd d d eZGd ddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdddeZGdd d eZGd!d"d"eZGd#d$d$eZGd%d&d&eZGd'd(d(eZ Gd)d*d*eZ!Gd+d,d,eZ"dS)-N) namedtuple)Sequence)urlparse)utilsthemeplugins)ConfigValidationErrorc@sDeZdZddZddZddZddZd d Zd d Zd dZ dS)BaseConfigOptioncCsg|_d|_dSN)warningsdefaultselfr>/usr/lib/python3/dist-packages/mkdocs/config/config_options.py__init__s zBaseConfigOption.__init__cCdSNFrrrrr is_requiredszBaseConfigOption.is_requiredcCs ||Sr )run_validationrvaluerrrvalidate zBaseConfigOption.validatecCs g|_dSr )r rrrrreset_warningsrzBaseConfigOption.reset_warningscCr)z Before all options are validated, perform a pre-validation process. The pre-validation process method should be implemented by subclasses. Nrrconfigkey_namerrrpre_validationzBaseConfigOption.pre_validationcCs|S)zy Perform validation for a value. The run_validation method should be implemented by subclasses. rrrrrr"szBaseConfigOption.run_validationcCr)z After all options have passed validation, perform a post-validation process to do any additional changes dependant on other config values. The post-validation process method should be implemented by subclasses. Nrrrrrpost_validation*r z BaseConfigOption.post_validationN) __name__ __module__ __qualname__rrrrrrr!rrrrr s r c@s$eZdZddZddZddZdS) SubConfigcGs t|t||i|_dSr )r rrr )rconfig_optionsrrrr4s   zSubConfig.__init__cCs||||Sr ) load_dictrrrrrr9  zSubConfig.validatecCst||Sr )rrrrrrr=s zSubConfig.run_validationN)r"r#r$rrrrrrrr%3s r%c@s(eZdZdZddZddZddZdS) ConfigItemszp Config Items Option Validates a list of mappings that all must match the same set of options. cOs&t|t||_|dd|_dS)NrequiredF)r rr% item_configgetr*)rr&kwargsrrrrIs  zConfigItems.__init__cCsd|jj|jS)Nz{}: {})format __class__r"r+rrrr__repr__NzConfigItems.__repr__cCsX|dur |jr tddSt|tstdt|g}|D] }||j|q|S)N$Required configuration not provided.rz4Expected a sequence of mappings, but a %s was given.)r*r isinstancertypeappendr+r)rrresultitemrrrrQs zConfigItems.run_validationN)r"r#r$__doc__rr0rrrrrr)Bs  r)c2eZdZdZd fdd ZddZdd ZZS) OptionallyRequiredz A subclass of BaseConfigOption that adds support for default values and required values. It is a base class for config options. NFcst||_||_dSr )superrr r*rr r*r/rrrg  zOptionallyRequired.__init__cCs|jSr )r*rrrrrlszOptionallyRequired.is_requiredcCsT|dur%|jdurt|jdr|j}n|j}n |jsdS|jr%td||S)z Perform some initial validation. If the option is empty (None) and isn't required, leave it as such. If it is empty but has a default, use that. Finally, call the run_validation method on the subclass unless. Ncopyr2)r hasattrr?r*r rrrrrros    zOptionallyRequired.validater)r"r#r$r8rrr __classcell__rrr=rr:as r:cs*eZdZdZdfdd ZddZZS)Typezc Type Config Option Validate the type of a config option against a given Python type. Nc s"tjdi|||_||_dSNr)r;r_typelength)rtype_rEr-r=rrrs z Type.__init__cCsbt||jsd|jt|}t||jdur/t||jkr/d|j||jt|}t||S)Nz"Expected type: {} but received: {}zDExpected type: {0} with length {2} but received: {1} with length {3})r3rDr.r4rElenr rrmsgrrrrs   zType.run_validationr r"r#r$r8rrrArrr=rrBsrBcs(eZdZdZfddZddZZS)Choicez^ Choice Config Option Validate the config option against a strict set of values. c sXtjdi|zt|}Wn tyd}Ynw|r"t|tr'td|||_dS)Nrz$Expected iterable of choices, got {}r)r;rrG TypeErrorr3str ValueErrorchoices)rrOr-rEr=rrrs    zChoice.__init__cCs$||jvrd|j|}t||S)Nz$Expected one of: {} but received: {})rOr.r rHrrrrs  zChoice.run_validationrJrrr=rrKs  rKcs&eZdZdfdd ZddZZS) DeprecatedNcstd|_||_dSr )r;rr moved_to)rrQr=rrrr>zDeprecated.__init__cCs||dus |jdurdSd|}|j|d|jvr$|}|j}n!|jdd\}}|}|dD]}||i}t|t sDdSq4| |||<dS)NzbThe configuration option {} has been deprecated and will be removed in a future release of MkDocs..) r,rQr.r r5rsplitsplit setdefaultr3dictpop)rrrwarningtarget target_keymove_tokeyrrrrs"    zDeprecated.pre_validationr )r"r#r$rrrArrr=rrPsrPc@s eZdZdZddZddZdS) IpAddressz^ IpAddress Config Option Validate that an IP address is in an apprioriate format c Csz |dd\}}Wn tytdw|dkr4z tt|}Wnty3}zt|d}~wwzt|}WntyHtd|wGdddt dd}|||S) N:rSz$Must be a string of format 'IP:PORT' localhostz'{}' is not a valid portc@seZdZddZdS)z)IpAddress.run_validation..AddresscSsd|j|jS)Nz{}:{})r.hostportrrrr__str__z1IpAddress.run_validation..Address.__str__N)r"r#r$rcrrrrAddresss rez host port) rT Exceptionr rM ipaddress ip_addressrNintr.r)rrrarbererrrrs&    zIpAddress.run_validationcCs8||j}|dkr|dvr|jd|dSdSdS)Ndev_addr)z0.0.0.0z::zThe use of the IP address '{}' suggests a production environment or the use of a proxy to connect to the MkDocs server. However, the MkDocs' server is intended for local development purposes only. Please use a third party production-ready server instead.)rar r5r.)rrrrarrrr!s zIpAddress.post_validationN)r"r#r$r8rr!rrrrr^s r^cs*eZdZdZdfdd ZddZZS) URLzQ URL Config Option Validate a URL by requiring a scheme is present. Fcst||dSr )r;rr<r=rrrr1z URL.__init__c CsF|dkr|Szt|}Wn ttfytdw|jr|Std)NrmzUnable to parse the URL.z;The URL isn't valid, it should include the http:// (scheme))rAttributeErrorrLr scheme)rr parsed_urlrrrrs zURL.run_validation)rmFrJrrr=rrl srlc@eZdZdZddZdS)RepoURLz Repo URL Config Option A small extension to the URL config that sets the repo_name and edit_uri, based on the url if they haven't already been provided. cCst|dj}|d}|ddurA|ddurA|dkr$d|d<n|dkr-d|d<n|dkr6d |d<n |d d |d<|ddur_|dur_|dksS|dkrVd }n |dkr]d }nd}|r~|dsu|ddsu|dd7<|ds~|d7}||d<dS)Nrepo_urledit_uri repo_namez github.comGitHubz bitbucket.org Bitbucketz gitlab.comGitLabrRrzedit/master/docs/zsrc/default/docs/rm)?#/)rnetloclowerr,rUtitle startswithendswith)rrr repo_hostrtrrrr!-s0        zRepoURL.post_validationN)r"r#r$r8r!rrrrrr%s rrcs6eZdZdZd fdd ZddZfddZZS) FilesystemObjectzB Base class for options that point to filesystem objects. Fc s&tjddti|||_d|_dS)NrFr)r;rrMexists config_dir)rrr-r=rrrTs zFilesystemObject.__init__cCs$|jr tj|j|_dSd|_dSr )config_file_pathospathdirnamerrrrrrYs$zFilesystemObject.pre_validationcspt|}|jrtj|stj|j|}|jr)||s)t dj ||j dtj |}t |ts6J|S)Nz)The path {path} isn't an existing {name}.rname)r;rrrrisabsjoinrexistence_testr r.rabspathr3rMrr=rrr\s  zFilesystemObject.run_validation)F)r"r#r$r8rrrrArrr=rrPs rc@s(eZdZdZeejjZdZ ddZ dS)Dirze Dir Config Option Validate a path to a directory, optionally verifying that it exists. directorycCs6|jdurdStj|j||krtd|dS)NzThe '{0}' should not be the parent directory of the config file. Use a child directory instead so that the '{0}' is a sibling of the config file.)rrrrr r.rrrrr!qs zDir.post_validationN) r"r#r$r8 staticmethodrrisdirrrr!rrrrrhs   rc@s eZdZdZeejjZdZ dS)Fileza File Config Option Validate a path to a file, optionally verifying that it exists. fileN) r"r#r$r8rrrisfilerrrrrrr}s rcs eZdZdZfddZZS)SiteDirzo SiteDir Config Option Validates the site_dir and docs_dir directories do not contain each other. cst|||dtj|dtjtjr&td|d|d|dtj|dtjtjrEtd|d|ddS)Ndocs_dirsite_dirzThe 'docs_dir' should not be within the 'site_dir' as this can mean the source files are overwritten by the output or it will be deleted if --clean is passed to mkdocs build.(site_dir: '{}', docs_dir: '{}')zThe 'site_dir' should not be within the 'docs_dir' as this leads to the build directory being copied into itself and duplicate nested files in the 'site_dir'.(site_dir: '{}', docs_dir: '{}'))r;r!rseprrstripr r.rr=rrr!s&&zSiteDir.post_validation)r"r#r$r8r!rArrr=rrsrcs2eZdZdZd fdd ZddZddZZS) Themez[ Theme Config Option Validate that the theme exists and build Theme instance. Ncst||_dSr )r;rr )rr r=rrrr(zTheme.__init__cCs|dur|jdurd|ji}t|trd|i}t}t|trCd|vr?|ddus0|d|vr2|Std|dd|tdtdt |)NrzEUnrecognised theme name: '{}'. The available installed themes are: {}z, zNo theme name set.z8Invalid type "{}". Expected a string or key/value pairs.) r r3rMrget_theme_namesrWr r.rr4)rrthemesrrrrs   zTheme.validatecCs||}|dsd|vrtdd|vr.tj|ds.tj|j}tj||d|d<d|vrEtj|dsEtdj|d|dt j di|||<dS)Nr custom_dirzCAt least one of 'theme.name' or 'theme.custom_dir' must be defined.zsz%Nav.run_validation..zInvalid pages config. {} {}) r3listr r.r4rGissubsetrMrW)rr config_typesrrrrs   zNav.run_validationcCsH|dkr |ddur"|ddur|d|d<d}|j|dSdSdS)NpagesnavzzThe 'pages' configuration option has been deprecated and will be removed in a future release of MkDocs. Use 'nav' instead.)r r5)rrrrYrrrr!s   zNav.post_validationr"r#r$r8rrr!rArrr=rrs  rc@rq)Privatezo Private Config Option A config option only for internal use. Raises an error if set by the user. cCstd)NzFor internal use only.)r rrrrrszPrivate.run_validationN)r"r#r$r8rrrrrrs rcr9) MarkdownExtensionsak Markdown Extensions Config Option A list of extensions. If a list item contains extension configs, those are set on the private setting passed to `configkey`. The `builtins` keyword accepts a list of extensions which cannot be overriden by the user. However, builtins can be duplicated to define config options for them if desired. N mdx_configsc s,tjdi||p g|_||_i|_dSrC)r;rbuiltins configkey configdata)rrrr-r=rrrs  zMarkdownExtensions.__init__c Cst|ttfs tdg}|D]A}t|trBt|dkr td|\}}|||dur0qt|tsts  z&Plugins.load_plugin..)rr r.load issubclassr BasePluginr#r" load_configrr extendr)rrrPluginpluginerrorsr errors_messagerrrrfs"    zPlugins.load_plugin) r"r#r$r8rrrrrArrr=rr>s  r)#r collectionsrcollections.abcr urllib.parserrgrmkdocsrrrmkdocs.config.baserr r r%r)r:rBrKrPr^rlrrrrrrrrrrrrrrrs6   '&"*+ 4' 3