From 83add95c8acb68163a9e674e7319c9f79f7b291f Mon Sep 17 00:00:00 2001
From: Gergely Polonkai <gergely@polonkai.eu>
Date: Mon, 13 Nov 2023 06:29:06 +0100
Subject: [PATCH] feat: Rename the disconnect method of each SHSEndpoint to
 close

The two verbs have the same meaning in this context, and this unifies the two interfaces, which helps type checking in
code using this library.
---
 secret_handshake/network.py | 21 ++++++++++++++-------
 tests/test_network.py       |  4 ++--
 2 files changed, 16 insertions(+), 9 deletions(-)

diff --git a/secret_handshake/network.py b/secret_handshake/network.py
index 5a577d8..fb0c1e1 100644
--- a/secret_handshake/network.py
+++ b/secret_handshake/network.py
@@ -27,7 +27,7 @@ from typing import AsyncIterator, Awaitable, Callable, List, Optional
 
 from nacl.public import PrivateKey
 from nacl.signing import SigningKey
-from typing_extensions import Self
+from typing_extensions import Self, deprecated
 
 from .boxstream import BoxStream, UnboxStream, get_stream_pair
 from .crypto import SHSClientCrypto, SHSCryptoBase, SHSServerCrypto
@@ -91,10 +91,16 @@ class SHSEndpoint:
 
         self._on_connect = cb
 
-    def disconnect(self) -> None:  # pragma: no cover
+    def close(self) -> None:  # pragma: no cover
         """Disconnect the endpoint"""
 
-        raise NotImplementedError
+        raise NotImplementedError()
+
+    @deprecated("Use close instead")
+    def disconnect(self) -> None:
+        """Disconnect the endpoint"""
+
+        self.close()
 
 
 class SHSServer(SHSEndpoint):
@@ -145,10 +151,14 @@ class SHSServer(SHSEndpoint):
 
         await start_server(self.handle_connection, self.host, self.port)
 
-    def disconnect(self) -> None:
+    def close(self) -> None:
         for connection in self.connections:
             connection.close()
 
+    @deprecated("Use close instead")
+    def disconnect(self) -> None:
+        self.close()
+
 
 class SHSServerConnection(SHSDuplexStream):
     """SHS server connection"""
@@ -221,6 +231,3 @@ class SHSClient(SHSDuplexStream, SHSEndpoint):
 
         if self._on_connect:
             await self._on_connect(self)
-
-    def disconnect(self) -> None:
-        self.close()
diff --git a/tests/test_network.py b/tests/test_network.py
index 23fbefa..a7b8cd4 100644
--- a/tests/test_network.py
+++ b/tests/test_network.py
@@ -145,7 +145,7 @@ async def test_client(mocker: MockerFixture) -> None:
     await client.open()
     reader.append(b"TEST")
     assert (await client.read()) == b"TEST"
-    client.disconnect()
+    client.close()
 
 
 @pytest.mark.asyncio
@@ -155,7 +155,7 @@ async def test_server(mocker: MockerFixture) -> None:
     resolve = Event()
 
     async def _on_connect(_: Any) -> None:
-        server.disconnect()
+        server.close()
         resolve.set()
 
     _, _, _create_mock_server = _server_stream_mocker()