o 沪g|,@sldZddlmZddlZddlZddlZddlmZmZddl m Z ddl m Z GdddZ dd dZdS)z6Class to store a key-value pair for the config system.) annotationsN)AnyCallable) to_snake_caserepr_c @s|eZdZdZdZdZddddddddedf d,ddZd-ddZd.ddZ e d/d!d"Z d0d1d&d'Z d2d(d)Z e d*d+ZdS)3 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 NvisibleFkeystr description str | None default_val Any | None visibility scriptablebool deprecateddeprecation_textexpiration_date replaced_bytype_type sensitivec Cs||_d} t| |j} | sJd|jd| d| d|_|_||_||_||_||_ ||_ | |_ d|_ d|_ tj|_| |_| |_t|ttf|_|j r]d|_ |dur]d|j }|j ru|sfJd |slJd ||_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 rematchgrouprrr rrrrr is_default _get_val_funcrDEFAULT_DEFINITION where_definedrr isinstancelisttuplemultiplertextwrapdedentr set_value)selfr r rrrrrrrrr key_formatrr,S/var/www/html/chatdoc2/venv/lib/python3.10/site-packages/streamlit/config_option.py__init__bs81    zConfigOption.__init__returncCst|SNrr*r,r,r-__repr__szConfigOption.__repr__ get_val_funcCallable[[], Any]cCs |jsJd|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__r r )r*r3r,r,r-__call__s zConfigOption.__call__rcCs|jdurdS|S)z$Get the value of this config option.N)r r1r,r,r-values zConfigOption.valuer7r"Nonec sfdd|_|durtj|_n||_|jk|_|jrl|jtjkrn|rGddlm }|t }| t d|jd|jd|jd dSddlm }|t }|t d |jd |jd |jd |jd dSdSdS)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. csSr0r,r,r7r,r-sz(ConfigOption.set_value..Nr) get_loggeru ════════════════════════════════════════════════ z. IS NO LONGER SUPPORTED. z$ Please update u. ════════════════════════════════════════════════ us ════════════════════════════════════════════════ z$ IS DEPRECATED. z> This option will be removed on or after z%. Please update )r rr!r"rrr is_expiredstreamlit.loggerr;__name__errorr'r(r rwarningr)r*r7r"r;LOGGERr,r9r-r)sH     zConfigOption.set_valuecCs&|jsdSt|j}tj}||kS)z/Returns true if expiration_date is in the past.F)r_parse_yyyymmdd_strrdatetimenow)r*rrDr,r,r-r<#s   zConfigOption.is_expiredcCs |jdd}dt|S)z^ Get the name of the environment variable that can be used to set the option. ._ STREAMLIT_)r replacerupper)r*rr,r,r-env_var,szConfigOption.env_var)r r r r rrrr rrrrrr rr rr rrrr)r/r )r3r4r/r)r/rr0)r7rr"r r/r8)r/r)r> __module__ __qualname__r5r!STREAMLIT_DEFINITIONr r.r2r6propertyr7r)r<rJr,r,r,r-rs.? d    ; rdate_strr r/datetime.datetimecCs*dd|ddD\}}}t|||S)Ncss|]}t|VqdSr0)int).0tokenr,r,r- 6sz&_parse_yyyymmdd_str..-)splitrC)rOyearmonthdayr,r,r-rB5srB)rOr r/rP)r5 __future__rrCrr'typingrrstreamlit.string_utilrstreamlit.utilrrrBr,r,r,r-s