BUG#27489972: Several COM_% commands have been deprecated

nmariz · nmariz · commit 426d7ce7d76f · 2023-01-13T09:35:45.000Z
Several COM_% commands have been deprecated in MySQL server.
A DeprecationWarning is now raised if any of these commands are used.

  - COM_FIELD_LIST
  - COM_REFRESH
  - COM_SHUTDOWN
  - COM_PROCESS_INFO
  - COM_PROCESS_KILL

Change-Id: I0aa5af0d85705e183a783a803e75bdc34d6ee8b1
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -14,6 +14,7 @@ v8.0.33
 - WL#15435: Improve the logging system
 - WL#15401: Support for type hints in module mysqlx
 - BUG#30103652: Connector/Python ClientFlag SESION_TRACK is a misspelling
+- BUG#27489972: Several COM_% commands have been deprecated
 - BUG#27359063: Support for dictionary, named_tuple, and raw to prepared statements cursor
 
 v8.0.32
diff --git a/lib/mysql/connector/constants.py b/lib/mysql/connector/constants.py
@@ -31,7 +31,7 @@
 import warnings
 
 from abc import ABC, ABCMeta
-from typing import Dict, List, Optional, Sequence, Tuple, Union, ValuesView
+from typing import Any, Dict, List, Optional, Sequence, Tuple, Union, ValuesView
 
 from .charsets import MYSQL_CHARACTER_SETS, MYSQL_CHARACTER_SETS_57
 from .errors import ProgrammingError
@@ -112,8 +112,18 @@ def flag_is_set(flag: int, flags: int) -> bool:
 
 
 def _obsolete_option(name: str, new_name: str, value: int) -> int:
+    """Raise a deprecation warning and advise a new option name.
+
+    Args:
+        name (str): The name of the option.
+        new_name (str): The new option name.
+        value (int): The value of the option.
+
+    Returns:
+        int: The value of the option.
+    """
     warnings.warn(
-        f'The option "{name}" has been deprecated, use "{new_name}" instead.',
+        f"The option '{name}' has been deprecated, use '{new_name}' instead.",
         category=DeprecationWarning,
     )
     return value
@@ -339,7 +349,27 @@ class FieldFlag(_Flags):
     }
 
 
-class ServerCmd(_Constants):
+class ServerCmdMeta(ABCMeta):
+    """ClientFlag Metaclass."""
+
+    def __getattribute__(cls, name: str) -> Any:
+        deprecated_options = (
+            "FIELD_LIST",
+            "REFRESH",
+            "SHUTDOWN",
+            "PROCESS_INFO",
+            "PROCESS_KILL",
+        )
+        if name in deprecated_options:
+            warnings.warn(
+                f"The option 'ServerCmd.{name}' is deprecated and will be removed in "
+                "a future release.",
+                category=DeprecationWarning,
+            )
+        return super().__getattribute__(name)
+
+
+class ServerCmd(_Constants, metaclass=ServerCmdMeta):
     """MySQL Server Commands"""
 
     _prefix: str = "COM_"
