%ed,dZddlZddlZddlZddlmZmZmZddlm Z ddl m Z ddl m Z GddZd ed ejfd ZdS) z6Class to store a key-value pair for the config system.N)AnyCallableOptional)util) to_snake_case)DeprecationErrorc,eZdZdZdZdZddddddddedf dedeed eed ed e d e d eedeedeede de fdZ defdZ de gefddfdZedefdZddedeeddfdZde fdZedZdS) 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 NvisibleFkey description default_val visibility scriptable deprecateddeprecation_textexpiration_date replaced_bytype_ sensitivec j||_d} tj| |j} | sJd|jd| d| dc|_|_||_||_||_||_ ||_ | |_ d|_ d|_ tj|_| |_| |_|j rd|_ | d|j z}|j r8|s Jd |s Jd ||_t)j||_||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_funcr DEFAULT_DEFINITION where_definedtyperrtextwrapdedentr set_value)selfr r rrrrrrrrr key_formatrs 7lib/python3.11/site-packages/streamlit/config_option.py__init__zConfigOption.__init__asYb  $TX..===dh======"'++i"8"8%++f:M:M di&$$&$&:>)< "   H"DO'#4t7G#G ? F" V V$V V V V# X X%X X X X#2D $,O4D$E$ED ! {#####returnc*tj|SN)rrepr_r%s r'__repr__zConfigOption.__repr__sz$r) get_val_funccN|js Jd|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%r0s r'__call__zConfigOption.__call__sE$   O O N O O O(/) r)c<|jdS|S)z$Get the value of this config option.N)rr.s r'valuezConfigOption.values$   %4!!###r)r5r cfd|_|tj|_n||_|jk|_|jr|jtjkr|j|j|j|j d}| r$ttj d|zddlm}|t }|tj d|zdSdSdS)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. cSr,)r5sr'z(ConfigOption.set_value..sUr)N)r file 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. ════════════════════════════════════════════════ )rr rr rrrr rr is_expiredrr"r#streamlit.loggerr=__name__warning)r%r5r detailsr=LOGGERs ` r'r$zConfigOption.set_values2+]]]  !-!@D  !.D 4#33 ?+ t1\5TTTx*#4, G  " &O       877777#H--O    ;+ + TTr)c|jsdSt|j}tj}||kS)z/Returns true if expiration_date is in the past.F)r_parse_yyyymmdd_strrdatetimenow)r%rrGs r'r>zConfigOption.is_expired&s@ 5-d.BCC##%%_$$r)c|jdd}dt|S)z^ Get the name of the environment variable that can be used to set the option. ._ STREAMLIT_)r replacerupper)r%rs r'env_varzConfigOption.env_var/s= xS))9M$//5577999r)r,)r@ __module__ __qualname__r2rSTREAMLIT_DEFINITIONstrrrboolr!r(r/rr3propertyr5r$r>rNr8r)r'r r s;;~%) &*%)#  *.)-%)`$`$ `$c]`$c] `$  `$  `$`$#3-`$"#`$c]`$`$`$`$`$`$D #    Xb#g%6>0$s$$$X$ ??s?8C=?D????B%D%%%%::X:::r)r date_strr*cvd|ddD\}}}tj|||S)Nc,g|]}t|Sr8)int).0tokens r' z'_parse_yyyymmdd_str..9sGGGuE GGGr)-)splitrF)rUyearmonthdays r'rErE8s?GGsA0F0FGGGD%  T5# . ..r))r2rFrr"typingrrr streamlitrstreamlit.case_convertersrstreamlit.errorsrr rRrEr8r)r'rfs=< **********333333------Z:Z:Z:Z:Z:Z:Z:Z:z/#/(*;//////r)