Modify ssl_mode setting from constant to string

Author: Jun Yamasaki

MySQLdb/__init__.py

@@ -26,7 +26,7 @@
 paramstyle = "format"
 
 from ._mysql import *
-from MySQLdb.constants import FIELD_TYPE, SSL_MODE
+from MySQLdb.constants import FIELD_TYPE
 from MySQLdb.times import Date, Time, Timestamp, \
     DateFromTicks, TimeFromTicks, TimestampFromTicks
 

MySQLdb/connections.py

@@ -102,6 +102,13 @@ class object, used to create cursors (keyword only)
         :param int client_flag:
             flags to use or 0 (see MySQL docs or constants/CLIENTS.py)
 
+        :param str ssl_mode
+            specify the security settings for connection to the server;
+            see the MySQL documentation for more details
+            (mysql_option(), MYSQL_OPT_SSL_MODE).
+            Only one of 'DISABLED', 'PREFERRED', 'REQUIRED',
+            'VERIFY_CA', 'VERIFY_IDENTITY' can be specified.
+
         :param dict ssl:
             dictionary or mapping contains SSL connection parameters;
             see the MySQL documentation for more details
@@ -123,7 +130,7 @@ class object, used to create cursors (keyword only)
         There are a number of undocumented, non-standard methods. See the
         documentation for the MySQL C API for some hints on what they do.
         """
-        from MySQLdb.constants import CLIENT, FIELD_TYPE
+        from MySQLdb.constants import CLIENT, FIELD_TYPE, SSL_MODE
         from MySQLdb.converters import conversions, _bytes_or_str
         from weakref import proxy
 
@@ -162,6 +169,12 @@ class object, used to create cursors (keyword only)
 
         kwargs2['client_flag'] = client_flag
 
+        if 'ssl_mode' in kwargs:
+            if hasattr(SSL_MODE, kwargs['ssl_mode']):
+                kwargs2['ssl_mode'] = getattr(SSL_MODE, kwargs['ssl_mode'])
+            else:
+                raise NotSupportedError('Unknown MySQL ssl_mode specification: %s' % kwargs['ssl_mode'])
+
         # PEP-249 requires autocommit to be initially off
         autocommit = kwargs2.pop('autocommit', False)
 

doc/user_guide.rst

@@ -360,11 +360,12 @@ connect(parameters...)
          ssl_mode
             If present, specify the security settings for the
             connection to the server. For more information on ssl_mode,
-            see the MySQL documentation. The constants can be referenced
-            as follows: ``MySQLdb.constants.SSL_MODE.PREFERRED``
+            see the MySQL documentation. Only one of 'DISABLED',
+            'PREFERRED', 'REQUIRED', 'VERIFY_CA', 'VERIFY_IDENTITY'
+            can be specified.
 
             If not present, the session ssl_mode will be unchanged,
-            but it becomes PREFERRED in Version 5.7 or later.
+            but in version 5.7 and later, the default is PREFERRED.
 
             *This must be a keyword parameter.*