3 S^@sddZddlZddlZddlZddlmZdddZddd Zd d Zd d Z dddZ dddZ dS)z&This module contains helper functions.N) NUMERIC_TYPESutf-8cCst|tr|S|j|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. ) isinstancebytesencode)valueencodingr @/tmp/pip-build-8app2_gc/mysql-connector-python/mysqlx/helpers.pyencode_to_bytes&s r cCst|tr|j|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. )rrdecode)rr r r r decode_from_bytes2s 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 r get_item_or_attr?s rcs2ddt|dkr&fdd|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|dkr |St|tr|St|ttfrr|jdd}|jdd}|jdd}|jdd }|jd d }|jd d }nH|jdd}|jdd}|jdd}|jdd}|jdd}|jdd}|S)zEscapes special characters.N\s\\ s\n s\r's\'"s\"s\\z\\ z\n z\r'z\'"z\"z\)rrr bytearrayreplace)rr r r _escapeWs$            zescape.._escapercsg|] }|qSr r ).0arg)r"r r mszescape..r)len)argsr )r"r escapeLs  r(cCs,|dkrdj|jddSdj|jddS)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}"rz""z`{0}``z``)formatr!) identifierZsql_moder r r quote_identifierqs r-csfdd}|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 cstjfdd}|S)zDecorate function.csldjjg}r"|jdjr6|jdjtjj}tjdj|t tj |j |j d||S)zWrapper function. Args: *args: Variable length argument list. **kwargs: Arbitrary keyword arguments. z'{}' is deprecatedz since version {}z. {}r))categoryfilenamelineno) r+__name__appendinspect currentframef_backwarnings warn_explicitjoinDeprecationWarninggetfilef_codef_lineno)r'kwargsmessageframe)funcreasonversionr r wrappers    z-deprecated..decorate..wrapper) functoolswraps)r@rC)rArB)r@r decorateszdeprecated..decorater )rBrArFr )rArBr deprecatedsrG)r)r)r))NN) __doc__rDr3r6compatrr rrr(r-rGr r r r s   %