'documentation' branch: remove comments and apply black formatting

Author: JeffLIrion

adb/adb_commands.py

@@ -7,19 +7,22 @@
 from adb import common
 from adb import filesync_protocol
 
+try:
+    file_types = (file, io.IOBase)
+except NameError:
+    file_types = (io.IOBase,)
+
 
 CLASS = 0xFF
+
+
 SUBCLASS = 0x42
-PROTOCOL = 0x01
 
-DeviceIsAvailable = common.InterfaceMatcher(CLASS, SUBCLASS, PROTOCOL)
 
-try:
+PROTOCOL = 0x01
 
-    from adb.sign_cryptography import CryptographySigner
-except ImportError:
 
-    pass
+DeviceIsAvailable = common.InterfaceMatcher(CLASS, SUBCLASS, PROTOCOL)
 
 
 class AdbCommands(object):
@@ -28,16 +31,15 @@ class AdbCommands(object):
     filesync_handler = filesync_protocol.FilesyncProtocol
 
     def __init__(self):
-
-        self.__reset()
-
-    def __reset(self):
         self.build_props = None
-        self._handle = None
         self._device_state = None
-
+        self._handle = None
         self._service_connections = {}
 
+    def __reset(self):
+
+        self.__init__()
+
     def _get_service_connection(
         self, service, service_command=None, create=True, timeout_ms=None
     ):
@@ -89,6 +91,7 @@ def ConnectDevice(
         return self
 
     def Close(self):
+
         for conn in list(self._service_connections.values()):
             if conn:
                 try:
@@ -121,6 +124,7 @@ def Devices(cls):
         return common.UsbHandle.FindDevices(DeviceIsAvailable)
 
     def GetState(self):
+
         return self._device_state
 
     def Install(
@@ -154,7 +158,7 @@ def Install(
         ret = self.Shell(" ".join(cmd), timeout_ms=timeout_ms)
 
         rm_cmd = ["rm", destination_path]
-        rmret = self.Shell(" ".join(rm_cmd), timeout_ms=timeout_ms)
+        self.Shell(" ".join(rm_cmd), timeout_ms=timeout_ms)
 
         return ret
 
@@ -214,10 +218,10 @@ def Pull(
             dest_file = io.BytesIO()
         elif isinstance(dest_file, str):
             dest_file = open(dest_file, "wb")
-        elif isinstance(dest_file, file):
+        elif isinstance(dest_file, file_types):
             pass
         else:
-            raise ValueError("destfile is of unknown type")
+            raise ValueError("dest_file is of unknown type")
 
         conn = self.protocol_handler.Open(
             self._handle, destination=b"sync:", timeout_ms=timeout_ms
@@ -228,12 +232,12 @@ def Pull(
         conn.Close()
         if isinstance(dest_file, io.BytesIO):
             return dest_file.getvalue()
-        else:
-            dest_file.close()
-            if hasattr(dest_file, "name"):
-                return os.path.exists(dest_file.name)
 
-            return True
+        dest_file.close()
+        if hasattr(dest_file, "name"):
+            return os.path.exists(dest_file.name)
+
+        return True
 
     def Stat(self, device_filename):
 

adb/adb_debug.py

@@ -60,6 +60,7 @@ def List(device, device_path):
             + ("x" if f.mode & stat.S_IXOTH else "-")
         )
         t = time.gmtime(f.mtime)
+
         yield "%s %*d %04d-%02d-%02d %02d:%02d:%02d %-*s\n" % (
             mode,
             maxsize,
@@ -77,37 +78,38 @@ def List(device, device_path):
 
 @functools.wraps(adb_commands.AdbCommands.Logcat)
 def Logcat(device, *options):
+
     return device.Logcat(device, " ".join(options), timeout_ms=0)
 
 
 def Shell(device, *command):
 
     if command:
         return device.StreamingShell(" ".join(command))
-    else:
 
-        terminal_prompt = device.InteractiveShell()
-        print(terminal_prompt.decode("utf-8"))
+    terminal_prompt = device.InteractiveShell()
+    print(terminal_prompt.decode("utf-8"))
 
-        while True:
-            cmd = input("> ")
-            if not cmd:
-                continue
-            elif cmd == "exit":
-                break
-            else:
-                stdout = device.InteractiveShell(
-                    cmd, strip_cmd=True, delim=terminal_prompt, strip_delim=True
-                )
-                if stdout:
-                    if isinstance(stdout, bytes):
-                        stdout = stdout.decode("utf-8")
-                        print(stdout)
+    while True:
+        cmd = input("> ")
+        if not cmd:
+            continue
+        elif cmd == "exit":
+            break
+        else:
+            stdout = device.InteractiveShell(
+                cmd, strip_cmd=True, delim=terminal_prompt, strip_delim=True
+            )
+            if stdout:
+                if isinstance(stdout, bytes):
+                    stdout = stdout.decode("utf-8")
+                    print(stdout)
 
-        device.Close()
+    device.Close()
 
 
 def main():
+
     common = common_cli.GetCommonArguments()
     common.add_argument(
         "--rsa_key_path",
@@ -121,9 +123,9 @@ def main():
         default=60.0,
         metavar="60",
         type=int,
-        help="Seconds to wait for the dialog to be accepted when using "
-        "authenticated ADB.",
+        help="Seconds to wait for the dialog to be accepted when using authenticated ADB.",
     )
+
     device = common_cli.GetDeviceArguments()
     parents = [common, device]
 
@@ -136,6 +138,7 @@ def main():
     subparser = subparsers.add_parser(
         name="devices", help="Lists the available devices", parents=[common]
     )
+
     subparser.add_argument(
         "--output_port_path",
         action="store_true",
@@ -157,8 +160,7 @@ def main():
         parents,
         adb_commands.AdbCommands.Pull,
         {
-            "dest_file": "Filename to write to on the host, if not specified, "
-            "prints the content to stdout."
+            "dest_file": "Filename to write to on the host, if not specified, prints the content to stdout."
         },
     )
     common_cli.MakeSubparser(subparsers, parents, adb_commands.AdbCommands.Reboot)
@@ -180,18 +182,22 @@ def main():
     args = parser.parse_args()
     if args.verbose:
         logging.basicConfig(level=logging.DEBUG)
+
     if not args.rsa_key_path:
         default = os.path.expanduser("~/.android/adbkey")
         if os.path.isfile(default):
             args.rsa_key_path = [default]
+
     if args.rsa_key_path and not rsa_signer:
         parser.error("Please install either cryptography, python-rsa, or PycryptoDome")
 
     if args.command_name == "devices":
         return Devices(args)
+
     if args.command_name == "help":
         parser.print_help()
         return 0
+
     if args.command_name == "logcat":
         args.positional = args.options
     elif args.command_name == "shell":