mirror of
https://github.com/ansible-collections/community.mysql.git
synced 2025-04-24 11:21:26 -07:00
Rename driver to connector for consistency
This commit is contained in:
parent
776de7acc2
commit
5f34a5f8b4
2 changed files with 22 additions and 22 deletions
|
@ -38,41 +38,41 @@ mysql_driver_fail_msg = ('A MySQL module is required: for Python 2.7 either PyMy
|
||||||
from ansible_collections.community.mysql.plugins.module_utils.database import mysql_quote_identifier
|
from ansible_collections.community.mysql.plugins.module_utils.database import mysql_quote_identifier
|
||||||
|
|
||||||
|
|
||||||
def get_driver_name(mysql_driver):
|
def get_connector_name(connector):
|
||||||
""" (class) -> str
|
""" (class) -> str
|
||||||
Return the name of the driver (pymysql or mysqlclient (MySQLdb))
|
Return the name of the connector (pymysql or mysqlclient (MySQLdb))
|
||||||
or 'Unknown' if the driver name is not pymysql or MySQLdb. When adding a
|
or 'Unknown' if not pymysql or MySQLdb. When adding a
|
||||||
connector here, also modify get_driver_version.
|
connector here, also modify get_connector_version.
|
||||||
"""
|
"""
|
||||||
if mysql_driver is None or not hasattr(mysql_driver, '__name__'):
|
if connector is None or not hasattr(connector, '__name__'):
|
||||||
return 'Unknown'
|
return 'Unknown'
|
||||||
|
|
||||||
if mysql_driver.__name__ not in ['pymysql', 'MySQLdb']:
|
if connector.__name__ not in ['pymysql', 'MySQLdb']:
|
||||||
return 'Unknown'
|
return 'Unknown'
|
||||||
|
|
||||||
return mysql_driver.__name__
|
return connector.__name__
|
||||||
|
|
||||||
|
|
||||||
def get_driver_version(mysql_driver):
|
def get_connector_version(connector):
|
||||||
""" (class) -> str
|
""" (class) -> str
|
||||||
Return the version of pymysql or mysqlclient (MySQLdb).
|
Return the version of pymysql or mysqlclient (MySQLdb).
|
||||||
If the driver name is unknown, this method also return 'Unknown'.
|
Return 'Unknown' if the connector name is unknown.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
if mysql_driver is None:
|
if connector is None:
|
||||||
return 'Unknown'
|
return 'Unknown'
|
||||||
|
|
||||||
driver_name = get_driver_name(mysql_driver)
|
connector_name = get_connector_name(connector)
|
||||||
|
|
||||||
if driver_name == 'pymysql':
|
if connector_name == 'pymysql':
|
||||||
# pymysql has two methods:
|
# pymysql has two methods:
|
||||||
# - __version__ that returns the string: 0.7.11.None
|
# - __version__ that returns the string: 0.7.11.None
|
||||||
# - VERSION that returns the tuple (0, 7, 11, None)
|
# - VERSION that returns the tuple (0, 7, 11, None)
|
||||||
v = mysql_driver.VERSION[:3]
|
v = connector.VERSION[:3]
|
||||||
return '.'.join(map(str, v))
|
return '.'.join(map(str, v))
|
||||||
elif driver_name == 'MySQLdb':
|
elif connector_name == 'MySQLdb':
|
||||||
# version_info returns the tuple (2, 1, 1, 'final', 0)
|
# version_info returns the tuple (2, 1, 1, 'final', 0)
|
||||||
v = mysql_driver.version_info[:3]
|
v = connector.version_info[:3]
|
||||||
return '.'.join(map(str, v))
|
return '.'.join(map(str, v))
|
||||||
else:
|
else:
|
||||||
return 'Unknown'
|
return 'Unknown'
|
||||||
|
|
|
@ -231,8 +231,8 @@ from ansible_collections.community.mysql.plugins.module_utils.mysql import (
|
||||||
mysql_common_argument_spec,
|
mysql_common_argument_spec,
|
||||||
mysql_driver,
|
mysql_driver,
|
||||||
mysql_driver_fail_msg,
|
mysql_driver_fail_msg,
|
||||||
get_driver_name,
|
get_connector_name,
|
||||||
get_driver_version,
|
get_connector_version,
|
||||||
)
|
)
|
||||||
from ansible.module_utils.six import iteritems
|
from ansible.module_utils.six import iteritems
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils._text import to_native
|
||||||
|
@ -575,8 +575,8 @@ def main():
|
||||||
if mysql_driver is None:
|
if mysql_driver is None:
|
||||||
module.fail_json(msg=mysql_driver_fail_msg)
|
module.fail_json(msg=mysql_driver_fail_msg)
|
||||||
|
|
||||||
driver_name = get_driver_name(mysql_driver)
|
connector_name = get_connector_name(mysql_driver)
|
||||||
driver_version = get_driver_version(mysql_driver)
|
connector_version = get_connector_version(mysql_driver)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
cursor, db_conn = mysql_connect(module, login_user, login_password,
|
cursor, db_conn = mysql_connect(module, login_user, login_password,
|
||||||
|
@ -586,7 +586,7 @@ def main():
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
msg = ('unable to connect to database using %s %s, check login_user '
|
msg = ('unable to connect to database using %s %s, check login_user '
|
||||||
'and login_password are correct or %s has the credentials. '
|
'and login_password are correct or %s has the credentials. '
|
||||||
'Exception message: %s' % (driver_name, driver_version, config_file, to_native(e)))
|
'Exception message: %s' % (connector_name, connector_version, config_file, to_native(e)))
|
||||||
module.fail_json(msg)
|
module.fail_json(msg)
|
||||||
|
|
||||||
###############################
|
###############################
|
||||||
|
@ -595,8 +595,8 @@ def main():
|
||||||
mysql = MySQL_Info(module, cursor)
|
mysql = MySQL_Info(module, cursor)
|
||||||
|
|
||||||
module.exit_json(changed=False,
|
module.exit_json(changed=False,
|
||||||
connector_name=driver_name,
|
connector_name=connector_name,
|
||||||
connector_version=driver_version,
|
connector_version=connector_version,
|
||||||
**mysql.get_info(filter_, exclude_fields, return_empty_dbs))
|
**mysql.get_info(filter_, exclude_fields, return_empty_dbs))
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue