ansible-collections/community.mysql
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.mysql.git synced 2025-07-25 14:20:24 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Enhance error handling and doc of get_driver_name and get_driver_version

Browse source
This commit is contained in:
Laurent Indermuehle 2023-01-23 15:30:40 +01:00
commit 240729d566
No known key found for this signature in database
GPG key ID: 93FA944C9F34DD09
2 changed files with 21 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
plugins/module_utils/mysql.py
View file

@ -38,27 +38,41 @@ mysql_driver_fail_msg = ('A MySQL module is required: for Python 2.7 either PyMy
def get_driver_name(mysql_driver): def get_driver_name(mysql_driver):
""" (class) -> str """ (class) -> str
Return the name of the driver (pymysql or mysqlclient (MySQLdb)). Return the name of the driver (pymysql or mysqlclient (MySQLdb))
or 'Unknown' if the driver name is not pymysql or MySQLdb. When adding a
connector here, also modify get_driver_version.
""" """
if mysql_driver is None or not hasattr(mysql_driver, '__name__'):
return 'Unknown'
if mysql_driver.__name__ not in ['pymysql', 'MySQLdb']:
return 'Unknown'
return mysql_driver.__name__ return mysql_driver.__name__
def get_driver_version(mysql_driver): def get_driver_version(mysql_driver):
""" (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'
""" """
if mysql_driver is None or mysql_driver.__name__ not in ['pymysql', 'MySQLdb']: if mysql_driver is None:
return 'Unknown' return 'Unknown'
if mysql_driver.__name__ == 'pymysql': driver_name = get_driver_name(mysql_driver)
if driver_name == 'Unknown':
return 'Unknown'
if driver_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 tupple (0, 7, 11, None) # - VERSION that returns the tupple (0, 7, 11, None)
v = mysql_driver.VERSION[:3] v = mysql_driver.VERSION[:3]
return '.'.join(map(str, v)) return '.'.join(map(str, v))
if mysql_driver.__name__ == 'MySQLdb': if driver_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 = mysql_driver.version_info[:3]
return '.'.join(map(str, v)) return '.'.join(map(str, v))

5
plugins/modules/mysql_info.py
View file

@ -207,13 +207,14 @@ slave_hosts:
sample: sample:
- { "2": { "Host": "", "Master_id": 1, "Port": 3306 } } - { "2": { "Host": "", "Master_id": 1, "Port": 3306 } }
connector_name: connector_name:
description: The python connector name used by the plugins description: Name of the python connector used by the plugin. When the driver is not identified, returns C(Unknown).
returned: always returned: always
type: str type: str
sample: sample:
- "pymysql" - "pymysql"
- "MySQLdb"
connector_version: connector_version:
description: The python connector version used by the plugins description: Version of the python connector used by the plugin. When the driver is not identified, returns C(Unknown).
returned: always returned: always
type: str type: str
sample: sample: