BUG#37541353: (Contribution) Fix typing annotation of MySQLConnectionAbstract's close function

As part of the connection API, improved the type
hint of `close()` which is an alias of the instance
method `disconnect()`. Thanks, Parul Gupta, for the
contribution!

Additionally, since `close()` is the preferred term (see
[PEP 249 – Python Database API Specification v2.0]),
with this patch, we also changed roles by letting
`disconnect()` now be an alias of `close()`.

From a functional perspective, nothing changes, this
modification is oriented to provide consistency and
clarity to the interface declaration.

Change-Id: I61d407186fcc9fa5496c617f05593c4c69bdfac8

Author: oscpache

CHANGES.txt

@@ -12,6 +12,7 @@ v9.3.0
 ======
 
 - WL#16327: Remove Cursors Prepared Raw and Named Tuple
+- BUG#37541353: (Contribution) Fix typing annotation of MySQLConnectionAbstract's close function
 - BUG#37453587: Github links in PyPI project's pages do not work
 - BUG#37418436: Arbitrary File Read in MySQL Python Client library
 

mysql-connector-python/lib/mysql/connector/abstracts.py

@@ -46,6 +46,7 @@
     Any,
     BinaryIO,
     Callable,
+    ClassVar,
     Deque,
     Dict,
     Generator,
@@ -1494,7 +1495,7 @@ def _post_connection(self) -> None:
             self._execute_query(self._init_command)
 
     @abstractmethod
-    def disconnect(self) -> None:
+    def close(self) -> None:
         """Disconnects from the MySQL server.
 
         This method tries to send a `QUIT` command and close the socket. It raises
@@ -1507,7 +1508,7 @@ def disconnect(self) -> None:
         use `shutdown()`.
         """
 
-    close: Callable[[], Any] = disconnect
+    disconnect: ClassVar[Callable[["MySQLConnectionAbstract"], None]] = close
 
     def connect(self, **kwargs: Any) -> None:
         """Connects to the MySQL server.

mysql-connector-python/lib/mysql/connector/aio/abstracts.py

@@ -48,8 +48,10 @@
     TYPE_CHECKING,
     Any,
     AsyncGenerator,
+    Awaitable,
     BinaryIO,
     Callable,
+    ClassVar,
     Deque,
     Dict,
     Generator,
@@ -1445,7 +1447,7 @@ async def close(self) -> None:
         no exceptions.
         """
 
-    disconnect: Callable[[], Any] = close
+    disconnect: ClassVar[Callable[["MySQLConnectionAbstract"], Awaitable[None]]] = close
 
     @abstractmethod
     async def cursor(

mysql-connector-python/lib/mysql/connector/aio/connection.py

@@ -47,7 +47,6 @@
     Any,
     AsyncGenerator,
     BinaryIO,
-    Callable,
     Dict,
     List,
     Mapping,
@@ -750,17 +749,6 @@ async def shutdown(self) -> None:
             pass  # Getting an exception would mean we are disconnected.
 
     async def close(self) -> None:
-        """Close the connection.
-
-        It closes any opened cursor associated to this connection, and closes the
-        underling socket connection.
-
-        `MySQLConnection.close()` is a synonymous for `MySQLConnection.disconnect()`
-        method name and more commonly used.
-
-        This method tries to send a `QUIT` command and close the socket. It raises
-        no exceptions.
-        """
         with contextlib.suppress(Error):
             for cursor in tuple(self._cursors):
                 await cursor.close()
@@ -773,7 +761,7 @@ async def close(self) -> None:
             await self._socket.close_connection()
         self._socket = None
 
-    disconnect: Callable[[], Any] = close
+    disconnect = close
 
     async def cursor(
         self,

mysql-connector-python/lib/mysql/connector/connection.py

@@ -449,7 +449,6 @@ def shutdown(self) -> None:
             pass  # Getting an exception would mean we are disconnected.
 
     def close(self) -> None:
-        """Disconnect from the MySQL server"""
         if self._span and self._span.is_recording():
             # pylint: disable=possibly-used-before-assignment
             record_exception_event(self._span, sys.exc_info()[1])

mysql-connector-python/lib/mysql/connector/connection_cext.py

@@ -377,7 +377,6 @@ def _open_connection(self) -> None:
                 warn_ciphersuites_deprecated(cipher, tls_version)
 
     def close(self) -> None:
-        """Disconnect from the MySQL server"""
         if self._span and self._span.is_recording():
             # pylint: disable=possibly-used-before-assignment
             record_exception_event(self._span, sys.exc_info()[1])