Add docstrings, typehinting

Author: SteveMicroNova

admin/cli.py

@@ -276,12 +276,14 @@ def connect(c, tunnel_id, command="/bin/bash", pty=True):
     device.sudo(command, pty=pty)
 
 
-def is_remote_directory(remote_device, remote_path):
+def is_remote_directory(remote_device: Connection, remote_path: str):
+    """Determines if a remote path is a directory using a bash command over a tunnel connection, returns true or false"""
     result = remote_device.run(f"if [ -d '{remote_path}' ]; then echo 'directory'; else echo 'file'; fi", hide=True).stdout.strip()
     return result == 'directory'
 
 
-def send_file(remote_device, local_file, remote_dir):
+def send_file(remote_device: Connection, local_file: str, remote_dir: str):
+    """Copies local file to remote directory via a tunnel connection"""
     filename = path.basename(local_file)
     remote_path = path.join(remote_dir, filename).replace("./", "")  # path.join adds an unneccessary ./ when combining things with their own directory, making the prints down the line look odd
 
@@ -293,7 +295,8 @@ def send_file(remote_device, local_file, remote_dir):
     print(f"File successfully uploaded to {remote_path}")
 
 
-def send_directory(remote_device, local_dir, remote_dir):
+def send_directory(remote_device: Connection, local_dir: str, remote_dir: str):
+    """Recursively copies everything in a local directory to a remote directory via a tunnel connection"""
     for root, _, files in walk(local_dir):
         relative_root = path.relpath(root, local_dir)
         remote_root = path.join(remote_dir, relative_root)
@@ -320,7 +323,8 @@ def sfile(c, tunnel_id, local, remote):
         send_file(device, local, remote)
 
 
-def get_file(remote_device, local_dir, remote_file):
+def get_file(remote_device: Connection, local_dir: str, remote_file: str):
+    """Copies a remote file to a local directory using a tunnel connection"""
     filename = path.basename(remote_file)
     local_path = path.join(local_dir, filename)
 
@@ -330,6 +334,7 @@ def get_file(remote_device, local_dir, remote_file):
 
 
 def get_directory(remote_device, remote_dir, local_dir):
+    """Recursively copies everything in a remote directory to the local directory using a tunnel connection"""
     # List all files and directories under the remote directory
     result = remote_device.run(f"find {remote_dir} -type d -or -type f", hide=True).stdout.splitlines()