Make can_connect private

SciCatProject · Jan 19, 2024 · d34272c · d34272c
1 parent c637477
commit d34272c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 10 deletions.
diff --git a/src/scitacean/testing/sftp/__init__.py b/src/scitacean/testing/sftp/__init__.py
@@ -102,15 +102,13 @@ def test_sftp_upload(
     IgnorePolicy,
     SFTPAccess,
     SFTPUser,
-    can_connect,
     configure,
     local_access,
     wait_until_sftp_server_is_live,
 )
 
 __all__ = [
     "add_pytest_option",
-    "can_connect",
     "configure",
     "local_access",
     "sftp_enabled",

diff --git a/src/scitacean/testing/sftp/_sftp.py b/src/scitacean/testing/sftp/_sftp.py
@@ -108,7 +108,7 @@ def configure(target_dir: Union[Path, str]) -> Path:
     return config_target
 
 
-def can_connect(sftp_access: SFTPAccess) -> bool:
+def _can_connect(sftp_access: SFTPAccess) -> bool:
     try:
         _make_client(sftp_access)
     except paramiko.SSHException:
@@ -121,10 +121,10 @@ def wait_until_sftp_server_is_live(
 ) -> None:
     # The container takes a while to be fully live.
     for _ in range(n_tries):
-        if can_connect(sftp_access):
+        if _can_connect(sftp_access):
             return
         time.sleep(max_time / n_tries)
-    if not can_connect(sftp_access):
+    if not _can_connect(sftp_access):
         raise RuntimeError("Cannot connect to SFTP server")
 
 

diff --git a/src/scitacean/testing/ssh/__init__.py b/src/scitacean/testing/ssh/__init__.py
@@ -102,15 +102,13 @@ def test_ssh_upload(
     IgnorePolicy,
     SSHAccess,
     SSHUser,
-    can_connect,
     configure,
     local_access,
     wait_until_ssh_server_is_live,
 )
 
 __all__ = [
     "add_pytest_option",
-    "can_connect",
     "configure",
     "local_access",
     "ssh_enabled",

diff --git a/src/scitacean/testing/ssh/_ssh.py b/src/scitacean/testing/ssh/_ssh.py
@@ -98,7 +98,7 @@ def configure(target_dir: Union[Path, str]) -> Path:
     return config_target
 
 
-def can_connect(ssh_access: SSHAccess) -> bool:
+def _can_connect(ssh_access: SSHAccess) -> bool:
     try:
         _make_client(ssh_access)
     except paramiko.SSHException:
@@ -111,10 +111,10 @@ def wait_until_ssh_server_is_live(
 ) -> None:
     # The container takes a while to be fully live.
     for _ in range(n_tries):
-        if can_connect(ssh_access):
+        if _can_connect(ssh_access):
             return
         time.sleep(max_time / n_tries)
-    if not can_connect(ssh_access):
+    if not _can_connect(ssh_access):
         raise RuntimeError("Cannot connect to SSH server")