U
    ovg6%                     @   s   d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ d	d
lm	Z	 d	dlm
Z
 G dd deZG dd deZG dd deZeZdS )a  

.. dialect:: mysql+mysqldb
    :name: mysqlclient (maintained fork of MySQL-Python)
    :dbapi: mysqldb
    :connectstring: mysql+mysqldb://<user>:<password>@<host>[:<port>]/<dbname>
    :url: https://pypi.org/project/mysqlclient/

Driver Status
-------------

The mysqlclient DBAPI is a maintained fork of the
`MySQL-Python <https://sourceforge.net/projects/mysql-python>`_ DBAPI
that is no longer maintained.  `mysqlclient`_ supports Python 2 and Python 3
and is very stable.

.. _mysqlclient: https://github.com/PyMySQL/mysqlclient-python

.. _mysqldb_unicode:

Unicode
-------

Please see :ref:`mysql_unicode` for current recommendations on unicode
handling.

.. _mysqldb_ssl:

SSL Connections
----------------

The mysqlclient and PyMySQL DBAPIs accept an additional dictionary under the
key "ssl", which may be specified using the
:paramref:`_sa.create_engine.connect_args` dictionary::

    engine = create_engine(
        "mysql+mysqldb://scott:tiger@192.168.0.134/test",
        connect_args={
            "ssl": {
                "ca": "/home/gord/client-ssl/ca.pem",
                "cert": "/home/gord/client-ssl/client-cert.pem",
                "key": "/home/gord/client-ssl/client-key.pem",
            }
        },
    )

For convenience, the following keys may also be specified inline within the URL
where they will be interpreted into the "ssl" dictionary automatically:
"ssl_ca", "ssl_cert", "ssl_key", "ssl_capath", "ssl_cipher",
"ssl_check_hostname". An example is as follows::

    connection_uri = (
        "mysql+mysqldb://scott:tiger@192.168.0.134/test"
        "?ssl_ca=/home/gord/client-ssl/ca.pem"
        "&ssl_cert=/home/gord/client-ssl/client-cert.pem"
        "&ssl_key=/home/gord/client-ssl/client-key.pem"
    )

.. seealso::

    :ref:`pymysql_ssl` in the PyMySQL dialect


Using MySQLdb with Google Cloud SQL
-----------------------------------

Google Cloud SQL now recommends use of the MySQLdb dialect.  Connect
using a URL like the following:

.. sourcecode:: text

    mysql+mysqldb://root@/<dbname>?unix_socket=/cloudsql/<projectid>:<instancename>

Server Side Cursors
-------------------

The mysqldb dialect supports server-side cursors. See :ref:`mysql_ss_cursors`.

    N   )MySQLCompiler)MySQLDialect)MySQLExecutionContext)MySQLIdentifierPreparer)TEXT   )sql)utilc                   @   s   e Zd ZdS )MySQLExecutionContext_mysqldbN__name__
__module____qualname__ r   r   E/tmp/pip-unpacked-wheel-uqd9otp_/sqlalchemy/dialects/mysql/mysqldb.pyr   e   s   r   c                   @   s   e Zd ZdS )MySQLCompiler_mysqldbNr   r   r   r   r   r   i   s   r   c                       s   e Zd ZdZdZdZdZdZdZdZ	e
ZeZeZ fddZdd Zejjdd	 Zed
d Z fddZdd Zd!ddZ fddZd"ddZdd Zdd Zdd Zdd Z  fdd Z!  Z"S )#MySQLDialect_mysqldbZmysqldbTformatc                    s<   t  jf | | jd k	r2t| jdr2| | jjnd| _d S )N__version__r   r   r   )super__init__dbapihasattr_parse_dbapi_versionr   Z_mysql_dbapi_version)selfkwargs	__class__r   r   r   {   s    
zMySQLDialect_mysqldb.__init__c                 C   s4   t d|}|r,tdd |dddD S dS d S )Nz(\d+)\.(\d+)(?:\.(\d+))?c                 s   s   | ]}|d k	rt |V  qd S N)int).0xr   r   r   	<genexpr>   s      z<MySQLDialect_mysqldb._parse_dbapi_version.<locals>.<genexpr>r      r   r   )rematchtuplegroup)r   versionmr   r   r   r      s    z)MySQLDialect_mysqldb._parse_dbapi_versionc              	   C   s8   zt dj}|j| _W dS  ttfk
r2   Y dS X d S )NzMySQLdb.cursorsTF)
__import__cursorsZSSCursorZ	_sscursorImportErrorAttributeError)r   r-   r   r   r   supports_server_side_cursors   s    
z1MySQLDialect_mysqldb.supports_server_side_cursorsc                 C   s   t dS )NZMySQLdb)r,   )clsr   r   r   import_dbapi   s    z!MySQLDialect_mysqldb.import_dbapic                    s   t     fdd}|S )Nc                    sB    d k	r |  |   }|d k	r>|  }|d|  |  d S )NzSET NAMES %s)character_set_namecursorexecuteclose)conncharset_namer4   Zsuper_r   r   
on_connect   s    z3MySQLDialect_mysqldb.on_connect.<locals>.on_connect)r   r:   )r   r:   r   r9   r   r:      s    
zMySQLDialect_mysqldb.on_connectc                 C   s   |   dS )NT)Zpingr   dbapi_connectionr   r   r   do_ping   s    zMySQLDialect_mysqldb.do_pingNc                 C   s   | ||}|d k	r||_d S r    )ZexecutemanyZ	_rowcount)r   r4   Z	statement
parameterscontextZrowcountr   r   r   do_executemany   s    z#MySQLDialect_mysqldb.do_executemanyc                    sn   | d| jd| jdf  }| jdko2|}|r\tttdt	dddg}ng }t
 ||S )	Nz:show collation where %s = 'utf8mb4' and %s = 'utf8mb4_bin'CharsetZ	Collation)   z'test collated returns'Zutf8mb4)charsetZutf8mb4_bin)Zexec_driver_sqlZidentifier_preparerquoteZscalarZserver_version_infor	   ZcollatecastZliteral_columnr   r   _check_unicode_returns)r   
connectionZ	collationZhas_utf8mb4_binZadditional_testsr   r   r   rF      s&    


z+MySQLDialect_mysqldb._check_unicode_returnsc           
      C   sT  |d krt dddd}|jf |}||j t|dt t|dt t|dt t|dt t|d	t t|d
t t|dt t|dt i }dtfdtfdtfdtfdtfdtfg}|D ]@\}}||kr|| ||dd  < t||dd  | ||= q|r||d< |	d	d}| 
 }	|	d k	rL||	O }||d	< g |gS )Ndbuserpasswd)Zdatabaseusernamepasswordcompressconnect_timeoutread_timeoutZwrite_timeoutclient_flagZlocal_infileZuse_unicoderC   Zssl_caZssl_keyZssl_certZ
ssl_capathZ
ssl_cipherZssl_check_hostname   sslr   )dictZtranslate_connect_argsupdatequeryr
   Zcoerce_kw_typeboolr!   strget_found_rows_client_flag)
r   urlZ_translate_argsoptsrR   keyskeyZkw_typerP   Zclient_flag_found_rowsr   r   r   create_connect_args   sJ      
z(MySQLDialect_mysqldb.create_connect_argsc              	   C   sN   | j d k	rFzt| j jd jj}W n ttfk
r<   Y d S X |jS nd S d S )Nz.constants.CLIENT)r   r,   r   	constantsZCLIENTr/   r.   Z
FOUND_ROWS)r   ZCLIENT_FLAGSr   r   r   rY      s    

z,MySQLDialect_mysqldb._found_rows_client_flagc                 C   s
   |j d S )Nr   )args)r   	exceptionr   r   r   _extract_error_code  s    z(MySQLDialect_mysqldb._extract_error_codec                 C   s8   z|j j}W n  tk
r,   td Y dS X | S dS )z:Sniff out the character set in use for connection results.zNo 'character_set_name' can be detected with this MySQL-Python version; please upgrade to a recent version of MySQL-Python.  Assuming latin1.latin1N)rG   r3   r/   r
   warn)r   rG   Z	cset_namer   r   r   _detect_charset  s    z$MySQLDialect_mysqldb._detect_charsetc                 C   s   dS )N)ZSERIALIZABLEzREAD UNCOMMITTEDzREAD COMMITTEDzREPEATABLE READ
AUTOCOMMITr   r;   r   r   r   get_isolation_level_values   s    z/MySQLDialect_mysqldb.get_isolation_level_valuesc                    s0   |dkr| d n| d t || d S )Nrf   TF)Z
autocommitr   set_isolation_level)r   r<   levelr   r   r   rh   )  s    
z(MySQLDialect_mysqldb.set_isolation_level)N)N)#r   r   r   ZdriverZsupports_statement_cacheZsupports_unicode_statementsZsupports_sane_rowcountZsupports_sane_multi_rowcountZsupports_native_decimalZdefault_paramstyler   Zexecution_ctx_clsr   Zstatement_compilerr   preparerr   r   r
   ZlanghelpersZmemoized_propertyr0   classmethodr2   r:   r=   r@   rF   r^   rY   rb   re   rg   rh   __classcell__r   r   r   r   r   m   s4   



3	r   )__doc__r&   baser   r   r   r   r    r	   r
   r   r   r   dialectr   r   r   r   <module>
   s   P E