iGdZddlmZddlZddlZddlZddlmZmZddlm Z m Z m Z ddl m Z ddlmZddlmZdd lmZmZdd lmZe rdd lmZmZdd lmZdd lmZGdde Z d7d8dZej dZ!ej dZ"d9d:dZ#ej dZ$d7d;d Z%dd?d+Z'd@dAd.Z(Gd/d0e Z)ej d1Z*dBd3Z+ej d4Z,dBd5Z-gd6Z.dS)Cz!Functions for parsing parameters.) annotationsN)datetimetime) TYPE_CHECKINGAnyProtocol) CaselessDict)JCalParsingError)validate_token)DEFAULT_ENCODINGSEQUENCE_TYPES) tzid_from_dt)CallableSequence)VALUE) VPROPERTYceZdZdZddZdS) HasToIcalz+Protocol for objects with a to_ical method.returnbytescdS)zConvert to iCalendar format.Nselfs U/root/projects/butler/venv/lib/python3.11/site-packages/icalendar/parser/parameter.pyto_icalzHasToIcal.to_icals N)rr)__name__ __module__ __qualname____doc__rrrrrrs.55      rrFvalueSequence[str] | str | HasToIcal always_quoteboolrstrcft|tr$ttt||St|t rt t ||St t |tS)a.Convert a parameter value to its iCalendar representation. Applies :rfc:`6868` escaping and optionally quotes the value according to :rfc:`5545` parameter value formatting rules. Parameters: value: The parameter value to convert. Can be a sequence, string, or object with a ``to_ical()`` method. always_quote: If ``True``, always enclose the value in double quotes. Defaults to ``False`` (only quote when necessary). Returns: The formatted parameter value, escaped and quoted as needed. r$) isinstancer q_joinmaprfc_6868_escaper&dquoterdecoder )r"r$s r param_valuer/#s"%((Nc/511 MMMM%Ioe,,<HHHH /%--//"8"89I"J"JKK L LLrz [- -",:;]z [- -"]TquotedNonecn|rtnt}||rt|dS)a,Validate a parameter value for unsafe characters. Checks parameter values for characters that are not allowed according to :rfc:`5545`. Uses different validation rules for quoted and unquoted values. Parameters: value: The parameter value to validate. quoted: If ``True``, validate as a quoted value (allows more characters). If ``False``, validate as an unquoted value (stricter). Defaults to ``True``. Raises: ValueError: If the value contains unsafe characters for its quote state. N) QUNSAFE_CHAR UNSAFE_CHARfindall ValueError)r"r0 validators rvalidate_param_valuer8Bs@!'7 KI   ru[,;:’]valcv|dd}t|s|rd|dS|S)akEnclose parameter values in double quotes when needed. Parameter values containing special characters ``,``, ``;``, ``:`` or ``'`` must be enclosed in double quotes according to :rfc:`5545`. Double-quote characters in the value are replaced with single quotes since they're forbidden in parameter values. Parameters: val: The parameter value to quote. always_quote: If ``True``, always enclose in quotes regardless of content. Defaults to ``False`` (only quote when necessary). Returns: The value, enclosed in double quotes if needed or requested. "')replaceQUOTABLEsearch)r9r$s rr-r-[sE& ++c3  Cs|3zzz Jr,stsepmaxsplitint list[str]c<|dkr|gSg}d}t|}d}d}t|D]k\}} | dkr| }|s-| |kr'|||||dz}|dz }|dz|ks||kr|||dnl|S)aESplit a string on a separator, respecting double quotes. Splits the string on the separator character, but ignores separators that appear inside double-quoted sections. This is needed for parsing parameter values that may contain quoted strings. Parameters: st: The string to split. sep: The separator character. Defaults to ``,``. maxsplit: Maximum number of splits to perform. If ``-1`` (default), then perform all possible splits. Returns: The split string parts. Examples: .. code-block:: pycon >>> from icalendar.parser import q_split >>> q_split('a,b,c') ['a', 'b', 'c'] >>> q_split('a,"b,c",d') ['a', '"b,c"', 'd'] >>> q_split('a;b;c', sep=';') ['a', 'b', 'c'] rr;N)len enumerateappend) rBrCrDresultcursorlengthinquotesplitsichs rq_splitrSus61}}t F F WWFG F2  2 99!kG 299 MM"VAX, ' ' 'UF aKF q5F??f00 MM"VWW+ & & & E1 Mrlst Sequence[str]cF|fd|DS)aJoin a list with a separator, quoting items as needed. Joins list items with the separator, applying :func:`dquote` to each item to add double quotes when they contain special characters. Parameters: lst: The list of items to join. sep: The separator to use. Defaults to ``,``. always_quote: If ``True``, always quote all items. Defaults to ``False`` (only quote when necessary). Returns: The joined string with items quoted as needed. Examples: .. code-block:: pycon >>> from icalendar.parser import q_join >>> q_join(['a', 'b', 'c']) 'a,b,c' >>> q_join(['plain', 'has,comma']) 'plain,"has,comma"' c3:K|]}t|VdS)r(N)r-).0itmr$s r zq_join..s0JJsF3\:::JJJJJJr)join)rTrCr$s `rr*r*s,0 88JJJJcJJJ J JJrfuncCallable | Nonec,fd}||S||S)aCreate a parameter getter/setter for a single string parameter. Parameters: upper: Convert the value to uppercase func: The function to decorate. Returns: The property for the parameter or a decorator for the parameter if func is ``None``. c|jtj|d fd }d fd }d fd t|||jS) Nr Parameterscb|}|r|}|S)zGet the value.)getupper)rr"namercs rfgetz8single_string_parameter..decorator..fgets1HHTNNE U  Lrr" str | Nonec\| |dSr|}||<dS)z Set the valueNrc)rr"fdelrdrcs rfsetz8single_string_parameter..decorator..fsets;}T *!KKMME"T rc4|ddS)zDelete the value.N)pop)rrds rriz8single_string_parameter..decorator..fdels HHT4 r)doc)rr`)rr`r"rf)r functoolswrapspropertyr!)r\rerjrirdrcs @@r decoratorz*single_string_parameter..decorators}             # # # # # # # # ! ! ! ! ! !dDdl;;;;rr)r\rcrqs ` rsingle_string_parameterrrs7<<<<<4 | 9T??rceZdZdZfdZdZddiZdZd$d%d Ze d&d Z e d d'dZ d(dZ d&d)dZe d*dZdZd+dZe d,d Ze d-d#ZxZS).r`a/Parser and generator of Property parameter strings. It knows nothing of datatypes. Its main concern is textual structure. Examples: Modify parameters: .. code-block:: pycon >>> from icalendar import Parameters >>> params = Parameters() >>> params['VALUE'] = 'TEXT' >>> params.value 'TEXT' >>> params Parameters({'VALUE': 'TEXT'}) Create new parameters: .. code-block:: pycon >>> params = Parameters(value="BINARY") >>> params.value 'BINARY' Set a default: .. code-block:: pycon >>> params = Parameters(value="BINARY", default_value="TEXT") >>> params Parameters({'VALUE': 'BINARY'}) c|r|d |dd}fdtD}tj|i|D]\}}|||dS)zCreate new parameters.rNrHci|]G}|d)|dd|HS)default_N)lower startswithrl)rXkeykwargss r z'Parameters.__init__..sY   yy{{%%j11 GVZZ__   r)listkeyssuper__init__items setdefault)rargsr{defaultsrzr" __class__s ` rrzParameters.__init__s  DGO8D    FKKMM**    $)&)))"..** ( (JC OOC ' ' ' ' ( (r) ALTREPzDELEGATED-FROMz DELEGATED-TODIRMEMBERzSENT-BYz X-ADDRESSzX-TITLELINKRELCNz 'c*|S)zpIn RFC 5545 keys are called parameters, so this is to be consitent with the naming conventions. )r~rs rparamszParameters.params3syy{{rTsortedr%c| g}t|}|r||D]\} |dkr dkr|}|j|}||jvp|ot fd|D}t |}t|tr| t}| | tdz|zd|S)zReturns an :rfc:`5545` representation of the parameters. Parameters: sorted (bool): Sort the parameters before encoding. exclude_utc (bool): Exclude TZID if it is set to ``"UTC"`` TZIDUTCc3 K|]}|vV dSNr)rXcr"s rrZz%Parameters.to_ical..Ns'GGqU GGGGGGrr(=;)r}rsortrc quote_alsorb always_quotedanyr/r)r&encoder rKr[) rrrLrrz upper_keycheck_quoteable_charactersr$ quoted_valuer"s @rrzParameters.to_ical9sDTZZ\\""   JJLLL T TJCf}}% I)-)<) >A||C(( >QZZ__ >WWS\\,R==== $5b$9$9::::,Qu====!> KK(9!''))(D(DEEEE KK(9!(<(<===='"%F3KKYY!^^"&q'F3KK"&F3K    GG#GG  sEE## F-FFrhrVALUE | str | NonecdS)a|The VALUE parameter from :rfc:`5545`. Description: This parameter specifies the value type and format of the property value. The property values MUST be of a single value type. For example, a "RDATE" property cannot have a combination of DATE-TIME and TIME value types. If the property's value is the default value type, then this parameter need not be specified. However, if the property's default value type is overridden by some other allowable value type, then this parameter MUST be specified. Applications MUST preserve the value data for x-name and iana- token values that they don't recognize without attempting to interpret or parse the value data. For convenience, using this property, the value will be converted to an uppercase string. .. code-block:: pycon >>> from icalendar import Parameters >>> params = Parameters() >>> params.value = "unknown" >>> params Parameters({'VALUE': 'UNKNOWN'}) Nrrs rr"zParameters.value{rr"str | float | list | VPROPERTY7str | int | float | list[str] | list[int] | list[float]ct|trfd|DSt|dr9|}t |dkr|dS|ddSt t tfD]}t||r ||cS tdt|d|)zConvert a parameter value to jCal format. Parameters: value: The parameter value Returns: The jCal representation of the parameter value c:g|]}|Sr)_parameter_value_to_jcal)rXrrs r z7Parameters._parameter_value_to_jcal..s'DDDD11!44DDDrto_jcalNz6Unsupported parameter value type for jCal conversion:  ) r)r}hasattrrrIrEfloatr& TypeErrortype)rr"jcalts` rrz#Parameters._parameter_value_to_jcals eT " " EDDDDeDDD D 5) $ $ ==??D4yyA~~Aw8Ouc"  A%## qxx  'E{{ ' '" ' '   rdict[str, str]cfdD}|r|ddkr|d=|S)zReturn the jCal representation of the parameters. Parameters: exclude_utc (bool): Exclude the TZID parameter if it is UTC ci|]E\}}|dk||FSr")rxr)rXkrrs rr|z&Parameters.to_jcal..sR   1wwyyG## GGIIt44Q77###rtzidr)rrb)r exclude_utcrs` rrzParameters.to_jcals_           488F++u44V  rrfcdS)z$The TZID parameter from :rfc:`5545`.Nrrs rrzParameters.tzidrrc|jdkS)z"Whether the TZID parameter is UTC.r)rrs ris_utczParameters.is_utcsyE!!rdtdatetime | time | Anyr1c~t|ttfrt|}|dkr ||_dSdSdS)zUpdate the TZID parameter from a datetime object. This sets the TZID parameter or deletes it according to the datetime. :rfc:`5545#section-3.2.19` prohibits TZID on UTC datetimes, which use the ``Z`` suffix instead. rN)r)rrrr)rrrs rupdate_tzid_fromzParameters.update_tzid_fromsK b8T* + + !##Du}}   ! !}rrdict[str:str | list[str]]ct|tstd||D]\}}t|tstd||t|t rt d|Dr|s5t|tttfstd|||||S)zParse jCal parameters.z!The parameters must be a mapping.z$All parameter names must be strings.rc3ZK|]&}t|tttfV'dSr)r)r&rEr)rXrs rrZz'Parameters.from_jcal..s3LLJq3U*;<<LLLLLLrzGParameter values must be a string, integer or float or a list of those.) r)dictr rr&r}allrEr)rrrdr"s r from_jcalzParameters.from_jcals$%% M"#FLL L::<<  KD%dC(( &:Ct ud++ LLeLLLLL    ec3%677  '0 s4yyr jcal_propertyr}c4t|trt|dkrtd||d}tjd5||}dddn #1swxYwY|r|`|S)a*Create the parameters for a jCal property. Parameters: jcal_property (list): The jCal property [name, params, value, ...] default_value (str, optional): The default value of the property. If this is given, the default value will not be set. rz2The property must be a list with at least 4 items.rHN)r)r}rIr reraise_with_path_addedrrr)rr jcal_paramsrs rfrom_jcal_propertyzParameters.from_jcal_propertys-.. #m2D2Dq2H2H"Dc $A&  5a 8 8 . .==--D . . . . . . . . . . . . . . . ;;==   sA77A;>A;T)rr%F)rr)r"rrr)rr)rrf)rrrr1)rr)rr})rrr r!rrrrr classmethodrrrr"rrrrrrr __classcell__)rs@rr`r`s##J ( ( ( ( ( M dJ  !!!!!<!!![!F4(((   )( >    8     3333""" ! ! ! ![4[rr`z \^\^|\^n|\^'r/c`dtjddtfd|S)zTake care of :rfc:`6868` unescaping. - ^^ -> ^ - ^n -> system specific newline - ^' -> " - ^ with others stay intact ^r;)^^^n^'c||d|dSNrrbgroupm replacementss rz#rfc_6868_unescape..+,""1771::qwwqzz::r)oslinesepRFC_6868_UNESCAPE_REGEXsubr/rs @rrrsDjL # & &::::K  rz\^|\r\n|\r|\n|"cPddddddtfd|S)zXTake care of :rfc:`6868` escaping. - ^ -> ^^ - " -> ^' - newline -> ^n rrr)r  z r;c||d|dSrrrs rrz!rfc_6868_escape..2rr)RFC_6868_ESCAPE_REGEXrrs @rr,r,#sH  L ! $ $::::K  r)r`r-r/r*rSr,rr8r)r"r#r$r%rr&r)r"r&r0r%rr1)r9r&r$r%rr&)r@rA)rBr&rCr&rDrErrF)r@F)rTrUrCr&r$r%rr&)NF)r\r])r/r&rr&)/r! __future__rrnrrerrtypingrrricalendar.caselessdictr icalendar.errorr icalendar.parser.stringr icalendar.parser_toolsr r icalendar.timezone.tzidrcollections.abcrricalendar.enumsricalendar.proprrr/compiler4r3r8r>r-rSr*rrr`rrrr,__all__rrrrs''"""""" ########////////////////,,,,,,222222100000)22222222%%%%%%((((((        BGMMMMM6bj788 rz566      , 2:j ! !4-----`KKKKK6(((((V]]]]]]]]@ %"*_55$# #566&   r