o bj@sdZddlZddlZddlZddlZddlZddlmZmZddl m Z e e fZ eeejfZdddZdd d Zd d Zd dZdddZdddZddZddZdS)z&This module contains helper functions.N)TLS_CIPHER_SUITES TLS_VERSIONS)InterfaceErrorutf-8cCst|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. ) isinstancebytesencodevalueencodingr M/var/www/secure340b-portal/env/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. )rrdecoder r r rdecode_from_bytes9s rcCst|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)objkeyr r rget_item_or_attrFs rcs2ddt|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. cSs|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)r r r r_escape^s&            zescape.._escapercsg|]}|qSr r ).0argr&r r tszescape..r)len)argsr r)rescapeSs  r-cCs,|dkr d|ddSd|ddS)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. Z ANSI_QUOTESz"{0}"r!z""z`{0}``z``)formatr%) identifierZsql_moder r rquote_identifierxs r2csfdd}|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. 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 cstfdd}|S)zDecorate function.cspdjg}r|dr|dtj}tjd|t t |j |j d|i|S)zWrapper function. Args: *args: Variable length argument list. **kwargs: Arbitrary keyword arguments. z'{}' is deprecatedz since version {}z. {}r.)categoryfilenamelineno) r0__name__appendinspect currentframef_backwarnings warn_explicitjoinDeprecationWarninggetfilef_codef_lineno)r,kwargsmessageframe)funcreasonversionr rwrappers   z-deprecated..decorate..wrapper) functoolswraps)rErHrFrG)rErdecorateszdeprecated..decorater )rGrFrLr rKr deprecatedsrMcCsxg}i}tt|dD] }|tt|q |D]}d|vr'||q||vr3|||qtd||S)zTranslates 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. r-z5The '{}' in cipher suites is not a valid cipher suite)rangerindexupdaterr7rr0)Z tls_versionZcipher_suites_namesZtranslated_namesZ cipher_suitesrPnamer r riani_to_openssl_cs_names rScCst|dS)zReturn the hexadecimal representation of the binary data. Args: data (str): The binary data. Returns: bytes: The hexadecimal representation of data. r)binasciihexlifyr)datar r rrUs rU)r)r.)NN)__doc__rTdecimalrIr8r; constantsrrerrorsrr$rZ BYTE_TYPESintfloatDecimalr#rrrr-r2rMrSrUr r r rs$      % *