o h{@sXdZddlZddlZddlZddlZddlZddlmZmZm Z m Z m Z ddl m Z mZddlmZddlmZmZeefZeeejfZd'd ed ed efd d Zd'd ed ed efddZdeded efddZded e ee effddZ d(deded efddZ!d)de ede ed efddZ"d ed!e ed e efd"d#Z#d$ed efd%d&Z$dS)*z&This module contains helper functions.N)AnyCallableListOptionalUnion)TLS_CIPHER_SUITES TLS_VERSIONS)InterfaceError) EscapeTypes StrOrBytesutf-8valueencodingreturncCst|tr|S||S)zReturns an encoded version of the string as a bytes object. Args: encoding (str): The encoding. Resturns: bytes: The encoded version of the string as a bytes object. ) isinstancebytesencoderrrI/var/www/html/scripts/venv/lib/python3.10/site-packages/mysqlx/helpers.pyencode_to_bytes/s rcCst|tr ||S|S)zReturns a string decoded from the given bytes. Args: value (bytes): The value to be decoded. encoding (str): The encoding. Returns: str: The value decoded from bytes. )rrdecoderrrrdecode_from_bytes;s robjkeycCst|tr ||St||S)zGet item from dictionary or attribute from object. Args: obj (object): Dictionary or object. key (str): Key. Returns: object: The object for the provided key. )rdictgetattr)rrrrrget_item_or_attrHs rargscs<dtdtfddt|dkrfdd|DS|dS) a Escapes special characters as they are expected to be when MySQL receives them. As found in MySQL source mysys/charset.c Args: value (object): Value to be escaped. Returns: str: The value if not a string, or the escaped string. rrcSs|dur|St|tr |St|ttfr:|dd}|dd}|dd}|dd }|d d }|d d }|S|dd}|dd}|dd}|dd}|dd}|dd}|S)zEscapes special characters.N\s\\ s\n s\r's\'"s\"s\\z\\ z\n z\r'z\'"z\"z\)r NUMERIC_TYPESr bytearrayreplace)rrrr_escapeas&            zescape.._escapercsg|]}|qSrr).0argr/rr xszescape..r)r len)rrr2rescapeUs  r5 identifiersql_modecCs8|dkr|dd}d|dS|dd}d|dS)acQuote the given identifier with backticks, converting backticks (`) in the identifier name with the correct escape sequence (``) unless the identifier is quoted (") as in sql_mode set to ANSI_QUOTES. Args: identifier (str): Identifier to quote. Returns: str: Returns string with the identifier quoted with backticks. ANSI_QUOTESr*z""`z``)r.)r7r8quotedrrrquote_identifier|s     r<versionreasoncsdtdtffdd }|S)aThis is a decorator used to mark functions as deprecated. Args: version (Optional[string]): Version when was deprecated. reason (Optional[string]): Reason or extra information to be shown. Returns: Callable: A decorator used to mark functions as deprecated. Usage: .. code-block:: python from mysqlx.helpers import deprecated @deprecated('8.0.12', 'Please use other_function() instead') def deprecated_function(x, y): return x + y funcrcs,tdtdtdtffdd }|S)zDecorate function.rkwargsrcsrdjdg}r|dr|dtj}tjd|tt |j |j d|i|S)zWrapper function. Args: *args: Variable length argument list. **kwargs: Arbitrary keyword arguments. r)z' is deprecatedz since version z. r6)categoryfilenamelineno) __name__appendinspect currentframef_backwarnings warn_explicitjoinDeprecationWarninggetfilef_codef_lineno)rr@messageframe)r?r>r=rrwrappers  z-deprecated..decorate..wrapper) functoolswrapsrr)r?rRr>r=)r?rdecorates zdeprecated..decorate)r)r=r>rVrrUr deprecatedsrW tls_versioncipher_suites_namescCszg}i}tt|dD] }|tt|q |D]}d|vr'||q||vr3|||qtd|d|S)aTranslates a cipher suites names list; from IANI names to OpenSSL names. Args: TLS_version (str): The TLS version to look at for a translation. cipher_suite_names (list): A list of cipher suites names. Returns: List[str]: List of translated names. r-zThe 'z.' in cipher suites is not a valid cipher suite)ranger indexupdaterrEr )rXrYtranslated_names cipher_suitesr\namerrriani_to_openssl_cs_names   radatacCst|dS)zReturn the hexadecimal representation of the binary data. Args: data (bytes): The binary data. Returns: str: The decoded hexadecimal representation of data. r )binasciihexlifyr)rbrrrrds rd)r )r6)NN)%__doc__rcdecimalrSrFrItypingrrrrr constantsrr errorsr typesr r r-r BYTE_TYPESintfloatDecimalr,strrrobjectrr5r<rWrardrrrrs4     ' 3