U ARd_,@sxdZddlZddlZddlZddlmZmZmZddlm Z ddl m Z ddl m Z GdddZeejd d d ZdS) z6Class to store a key-value pair for the config system.N)AnyCallableOptional)util) to_snake_case)DeprecationErrorc @seZdZdZdZdZddddddddedf eeeeeee e eeeeeee e d dd Z ed d d Z e gefdd ddZeed ddZdeeeddddZe d ddZeddZdS) ConfigOptiona:Stores a Streamlit configuration option. A configuration option, like 'browser.serverPort', which indicates which port to use when connecting to the proxy. There are two ways to create a ConfigOption: Simple ConfigOptions are created as follows: ConfigOption('browser.serverPort', description = 'Connect to the proxy at this port.', default_val = 8501) More complex config options resolve their values at runtime as follows: @ConfigOption('browser.serverPort') def _proxy_port(): """Connect to the proxy at this port. Defaults to 8501. """ return 8501 NOTE: For complex config options, the function is called each time the option.value is evaluated! Attributes ---------- key : str The fully qualified section.name value : any The value for this option. If this is a complex config option then the callback is called EACH TIME value is evaluated. section : str The section of this option. Example: 'global'. name : str See __init__. description : str See __init__. where_defined : str Indicates which file set this config option. ConfigOption.DEFAULT_DEFINITION means this file. is_default: bool True if the config value is equal to its default value. visibility : {"visible", "hidden"} See __init__. scriptable : bool See __init__. deprecated: bool See __init__. deprecation_text : str or None See __init__. expiration_date : str or None See __init__. replaced_by : str or None See __init__. sensitive : bool See __init__. env_var: str The name of the environment variable that can be used to set the option. z z NZvisibleF) key description default_val visibility scriptable deprecateddeprecation_textexpiration_date replaced_bytype_ sensitivec Cs||_d} t| |j} | s.td|jd| d| d|_|_||_||_||_ ||_ ||_ | |_ d|_ d|_tj|_| |_| |_|j rd|_ |dkrd|j }|j r|std |std ||_t||_||dS) a.Create a ConfigOption with the given name. Parameters ---------- key : str Should be of the form "section.optionName" Examples: server.name, deprecation.v1_0_featureName description : str Like a comment for the config option. default_val : any The value for this config option. visibility : {"visible", "hidden"} Whether this option should be shown to users. scriptable : bool Whether this config option can be set within a user script. deprecated: bool Whether this config option is deprecated. deprecation_text : str or None Required if deprecated == True. Set this to a string explaining what to use instead. expiration_date : str or None Required if deprecated == True. set this to the date at which it will no longer be accepted. Format: 'YYYY-MM-DD'. replaced_by : str or None If this is option has been deprecated in favor or another option, set this to the path to the new option. Example: 'server.runOnSave'. If this is set, the 'deprecated' option will automatically be set to True, and deprecation_text will have a meaningful default (unless you override it). type_ : one of str, int, float or bool Useful to cast the config params sent by cmd option parameter. sensitive: bool Sensitive configuration options cannot be set by CLI parameter. z?(?P
\_?[a-z][a-zA-Z0-9]*)\.(?P[a-z][a-zA-Z0-9]*)$zKey "z" has invalid format.sectionnameTNzReplaced by %s.z0expiration_date is required for deprecated itemsz1deprecation_text is required for deprecated items)r rematchAssertionErrorgrouprrr r r r rr is_default _get_val_funcrDEFAULT_DEFINITION where_definedtyperrtextwrapdedentr set_value)selfr r r r r rrrrrrZ key_formatrr#;/tmp/pip-unpacked-wheel-b9et7o5g/streamlit/config_option.py__init__as61    zConfigOption.__init__)returncCs t|SN)rrepr_r"r#r#r$__repr__szConfigOption.__repr__) get_val_funcr&cCs |jstd|j|_||_|S)aAssign a function to compute the value for this option. This method is called when ConfigOption is used as a decorator. Parameters ---------- get_val_func : function A function which will be called to get the value of this parameter. We will use its docString as the description. Returns ------- ConfigOption Returns self, which makes testing easier. See config_test.py. zAComplex config options require doc strings for their description.)__doc__rr r)r"r+r#r#r$__call__szConfigOption.__call__cCs|jdkrdS|S)z$Get the value of this config option.N)rr)r#r#r$values zConfigOption.value)r.rr&csfdd|_|dkr tj|_n||_|jk|_|jr|jtjkr|j|j|j|j d}| rvt t d|n(ddlm}|t}|t d|dS) zSet the value of this option. Parameters ---------- value The new value for this parameter. where_defined : str New value to remember where this parameter was set. csSr'r#r#r.r#r$z(ConfigOption.set_value..N)r fileZ explanationdateu ════════════════════════════════════════════════ %(key)s IS NO LONGER SUPPORTED. %(explanation)s Please update %(file)s. ════════════════════════════════════════════════ r) get_loggeru" ════════════════════════════════════════════════ %(key)s IS DEPRECATED. %(explanation)s This option will be removed on or after %(date)s. Please update %(file)s. ════════════════════════════════════════════════ )rrrrr rrr rr is_expiredrrr Zstreamlit.loggerr4__name__warning)r"r.rdetailsr4ZLOGGERr#r/r$r!s8      zConfigOption.set_valuecCs&|js dSt|j}tj}||kS)z/Returns true if expiration_date is in the past.F)r_parse_yyyymmdd_strrdatetimenow)r"rr;r#r#r$r5&s   zConfigOption.is_expiredcCs |jdd}dt|S)z^ Get the name of the environment variable that can be used to set the option. ._Z STREAMLIT_)r replacerupper)r"rr#r#r$env_var/szConfigOption.env_var)N)r6 __module__ __qualname__r,rZSTREAMLIT_DEFINITIONstrrrboolrr%r*rr-propertyr.r!r5r@r#r#r#r$rsD? bA r)date_strr&cCs*dd|ddD\}}}t|||S)NcSsg|] }t|qSr#)int).0tokenr#r#r$ 9sz'_parse_yyyymmdd_str..-)splitr:)rFyearmonthdayr#r#r$r98sr9)r,r:rrtypingrrrZ streamlitrZstreamlit.case_convertersrZstreamlit.errorsrrrCr9r#r#r#r$s