Get the hostname in 'connect()', not '__init__()' (#115)

* Get the hostname in 'connect()', not '__init__()'

* Add missing functions to tables of contents

Author: JeffLIrion

adb_shell/adb_device.py

@@ -47,6 +47,7 @@
     * :meth:`AdbDevice.close`
     * :meth:`AdbDevice.connect`
     * :meth:`AdbDevice.list`
+    * :attr:`AdbDevice.max_chunk_size`
     * :meth:`AdbDevice.pull`
     * :meth:`AdbDevice.push`
     * :meth:`AdbDevice.root`
@@ -62,7 +63,6 @@
 
 import logging
 import os
-import socket
 import struct
 import time
 
@@ -71,7 +71,7 @@
 from .adb_message import AdbMessage, checksum, unpack
 from .transport.base_transport import BaseTransport
 from .transport.tcp_transport import TcpTransport
-from .hidden_helpers import DeviceFile, _AdbTransactionInfo, _FileSyncTransactionInfo, get_files_to_push
+from .hidden_helpers import DeviceFile, _AdbTransactionInfo, _FileSyncTransactionInfo, get_banner, get_files_to_push
 
 try:
     from .transport.usb_transport import UsbTransport
@@ -112,16 +112,10 @@ class AdbDevice(object):
     """
 
     def __init__(self, transport, banner=None):
-        if banner:
-            if not isinstance(banner, (bytes, bytearray)):
-                self._banner = bytearray(banner, 'utf-8')
-            else:
-                self._banner = banner
+        if banner and not isinstance(banner, (bytes, bytearray)):
+            self._banner = bytearray(banner, 'utf-8')
         else:
-            try:
-                self._banner = bytearray(socket.gethostname(), 'utf-8')
-            except:  # noqa pylint: disable=bare-except
-                self._banner = bytearray('unknown', 'utf-8')
+            self._banner = banner
 
         if not isinstance(transport, BaseTransport):
             raise exceptions.InvalidTransportError("`transport` must be an instance of a subclass of `BaseTransport`")
@@ -208,6 +202,10 @@ def connect(self, rsa_keys=None, transport_timeout_s=None, auth_timeout_s=consta
             Invalid auth response from the device
 
         """
+        # 0. Get `self._banner` if it was not provided in the constructor
+        if not self._banner:
+            self._banner = get_banner()
+
         # 1. Use the transport to establish a connection
         self._transport.close()
         self._transport.connect(transport_timeout_s)

adb_shell/adb_device_async.py

@@ -45,6 +45,7 @@
     * :meth:`AdbDeviceAsync.close`
     * :meth:`AdbDeviceAsync.connect`
     * :meth:`AdbDeviceAsync.list`
+    * :attr:`AdbDeviceAsync.max_chunk_size`
     * :meth:`AdbDeviceAsync.pull`
     * :meth:`AdbDeviceAsync.push`
     * :meth:`AdbDeviceAsync.root`
@@ -60,7 +61,6 @@
 from asyncio import get_running_loop
 import logging
 import os
-import socket
 import struct
 import time
 
@@ -71,7 +71,7 @@
 from .adb_message import AdbMessage, checksum, unpack
 from .transport.base_transport_async import BaseTransportAsync
 from .transport.tcp_transport_async import TcpTransportAsync
-from .hidden_helpers import DeviceFile, _AdbTransactionInfo, _FileSyncTransactionInfo, get_files_to_push
+from .hidden_helpers import DeviceFile, _AdbTransactionInfo, _FileSyncTransactionInfo, get_banner, get_files_to_push
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -107,17 +107,10 @@ class AdbDeviceAsync(object):
     """
 
     def __init__(self, transport, banner=None):
-        if banner:
-            if not isinstance(banner, (bytes, bytearray)):
-                self._banner = bytearray(banner, 'utf-8')
-            else:
-                self._banner = banner
+        if banner and not isinstance(banner, (bytes, bytearray)):
+            self._banner = bytearray(banner, 'utf-8')
         else:
-            try:
-                # TODO: make this async / don't do I/O
-                self._banner = bytearray(socket.gethostname(), 'utf-8')
-            except:  # noqa pylint: disable=bare-except
-                self._banner = bytearray('unknown', 'utf-8')
+            self._banner = banner
 
         if not isinstance(transport, BaseTransportAsync):
             raise exceptions.InvalidTransportError("`transport` must be an instance of a subclass of `BaseTransportAsync`")
@@ -204,6 +197,10 @@ async def connect(self, rsa_keys=None, transport_timeout_s=None, auth_timeout_s=
             Invalid auth response from the device
 
         """
+        # 0. Get `self._banner` if it was not provided in the constructor
+        if not self._banner:
+            self._banner = await get_running_loop().run_in_executor(None, get_banner)
+
         # 1. Use the transport to establish a connection
         await self._transport.close()
         await self._transport.connect(transport_timeout_s)

adb_shell/hidden_helpers.py

@@ -27,13 +27,15 @@
 
     * :meth:`_FileSyncTransactionInfo.can_add_to_send_buffer`
 
+* :func:`get_banner`
 * :func:`get_files_to_push`
 
 """
 
 
 from collections import namedtuple
 import os
+import socket
 import struct
 
 from . import constants
@@ -69,6 +71,21 @@ def get_files_to_push(local_path, device_path):
     return local_path_is_dir, local_paths, device_paths
 
 
+def get_banner():
+    """Get the ``banner`` that will be signed in :meth:`adb_shell.adb_device.AdbDevice.connect` / :meth:`adb_shell.adb_device_async.AdbDeviceAsync.connect`.
+
+    Returns
+    -------
+    bytearray
+        The hostname, or "unknown" if it could not be determined
+
+    """
+    try:
+        return bytearray(socket.gethostname(), 'utf-8')
+    except:  # noqa pylint: disable=bare-except
+        return bytearray('unknown', 'utf-8')
+
+
 class _AdbTransactionInfo(object):  # pylint: disable=too-few-public-methods
     """A class for storing info and settings used during a single ADB "transaction."
 

tests/test_adb_device.py

@@ -96,6 +96,8 @@ def test_init_banner(self):
 
         with patch('socket.gethostname', side_effect=Exception):
             device_banner_unknown = AdbDevice(transport=patchers.FakeTcpTransport('host', 5555))
+            device_banner_unknown._transport._bulk_read = self.device._transport._bulk_read
+            self.assertTrue(device_banner_unknown.connect())
             self.assertEqual(device_banner_unknown._banner, b'unknown')
 
         # Clear the `_bulk_read` buffer so that `self.tearDown()` passes

tests/test_adb_device_async.py

@@ -102,6 +102,8 @@ async def test_init_banner(self):
 
         with patch('socket.gethostname', side_effect=Exception):
             device_banner_unknown = AdbDeviceAsync(transport=FakeTcpTransportAsync('host', 5555))
+            device_banner_unknown._transport._bulk_read = self.device._transport._bulk_read
+            self.assertTrue(await device_banner_unknown.connect())
             self.assertEqual(device_banner_unknown._banner, b'unknown')
 
         # Clear the `_bulk_read` buffer so that `self.tearDown()` passes