Merge pull request #65 from bridadan/move_detect_deprecated_functions

Move detect deprecated functions

Author: theotherjimmy

packages/mbed-ls/mbed_lstools/lstools_base.py

@@ -21,189 +21,5 @@
 
 from mbed_os_tools.detect.lstools_base import (
     FSInteraction,
-    MbedDetectLsToolsBase,
+    MbedLsToolsBase,
 )
-
-logger = logging.getLogger("mbedls.lstools_base")
-logger.addHandler(logging.NullHandler())
-
-def deprecated(reason):
-    """Deprecate a function/method with a decorator"""
-    def actual_decorator(func):
-        @functools.wraps(func)
-        def new_func(*args, **kwargs):
-            logger.warning("Call to deprecated function %s. %s",
-                        func.__name__, reason)
-            return func(*args, **kwargs)
-        return new_func
-    return actual_decorator
-
-class MbedLsToolsBase(MbedDetectLsToolsBase):
-    """ Base class for mbed-lstools, defines mbed-ls tools interface for
-    mbed-enabled devices detection for various hosts
-    """
-
-    @deprecated("Functionality has been moved into 'list_mbeds'. "
-                "Please use list_mbeds with 'unique_names=True' and "
-                "'read_details_txt=True'")
-    def list_mbeds_ext(self):
-        """! Function adds extra information for each mbed device
-        @return Returns list of mbed devices plus extended data like 'platform_name_unique'
-        @details Get information about mbeds with extended parameters/info included
-        """
-
-        return self.list_mbeds(unique_names=True, read_details_txt=True)
-
-    @deprecated("List formatting methods are deprecated for a simpler API. "
-                "Please use 'list_mbeds' instead.")
-    def list_manufacture_ids(self):
-        """! Creates list of all available mappings for target_id -> Platform
-        @return String with table formatted output
-        """
-        from prettytable import PrettyTable, HEADER
-
-        columns = ['target_id_prefix', 'platform_name']
-        pt = PrettyTable(columns, junction_char="|", hrules=HEADER)
-        for col in columns:
-            pt.align[col] = 'l'
-
-        for target_id_prefix, platform_name in sorted(self.plat_db.items()):
-            pt.add_row([target_id_prefix, platform_name])
-
-        return pt.get_string()
-
-    @deprecated("List formatting methods are deprecated to simplify the API. "
-                "Please use 'list_mbeds' instead.")
-    def list_platforms(self):
-        """! Useful if you just want to know which platforms are currently available on the system
-        @return List of (unique values) available platforms
-        """
-        result = []
-        mbeds = self.list_mbeds()
-        for i, val in enumerate(mbeds):
-            platform_name = str(val['platform_name'])
-            if platform_name not in result:
-                result.append(platform_name)
-        return result
-
-    @deprecated("List formatting methods are deprecated to simplify the API. "
-                "Please use 'list_mbeds' instead.")
-    def list_platforms_ext(self):
-        """! Useful if you just want to know how many platforms of each type are currently available on the system
-        @return Dict of platform: platform_count
-        """
-        result = {}
-        mbeds = self.list_mbeds()
-        for i, val in enumerate(mbeds):
-            platform_name = str(val['platform_name'])
-            if platform_name not in result:
-                result[platform_name] = 1
-            else:
-                result[platform_name] += 1
-        return result
-
-    @deprecated("List formatting methods are deprecated to simplify the API. "
-                "Please use 'list_mbeds' instead.")
-    def list_mbeds_by_targetid(self):
-        """! Get information about mbeds with extended parameters/info included
-        @return Returns dictionary where keys are TargetIDs and values are mbed structures
-        @details Ordered by target id (key: target_id).
-        """
-        result = {}
-        mbed_list = self.list_mbeds_ext()
-        for mbed in mbed_list:
-            target_id = mbed['target_id']
-            result[target_id] = mbed
-        return result
-
-    @deprecated("List formatting methods are deprecated to simplify the API. "
-                "Please use 'list_mbeds' instead.")
-    def get_string(self, border=False, header=True, padding_width=1, sortby='platform_name'):
-        """! Printing with some sql table like decorators
-        @param border Table border visibility
-        @param header Table header visibility
-        @param padding_width Table padding
-        @param sortby Column used to sort results
-        @return Returns string which can be printed on console
-        """
-        from prettytable import PrettyTable, HEADER
-        result = ''
-        mbeds = self.list_mbeds(unique_names=True, read_details_txt=True)
-        if mbeds:
-            """ ['platform_name', 'mount_point', 'serial_port', 'target_id'] - columns generated from USB auto-detection
-                ['platform_name_unique', ...] - columns generated outside detection subsystem (OS dependent detection)
-            """
-            columns = ['platform_name', 'platform_name_unique', 'mount_point', 'serial_port', 'target_id', 'daplink_version']
-            pt = PrettyTable(columns, junction_char="|", hrules=HEADER)
-            for col in columns:
-                pt.align[col] = 'l'
-
-            for mbed in mbeds:
-                row = []
-                for col in columns:
-                    row.append(mbed[col] if col in mbed and mbed[col] else 'unknown')
-                pt.add_row(row)
-            result = pt.get_string(border=border, header=header, padding_width=padding_width, sortby=sortby)
-        return result
-
-    # Private functions supporting API
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def get_json_data_from_file(self, json_spec_filename, verbose=False):
-        """! Loads from file JSON formatted string to data structure
-        @return None if JSON can be loaded
-        """
-        try:
-            with open(json_spec_filename) as data_file:
-                try:
-                    return json.load(data_file)
-                except ValueError as json_error_msg:
-                    logger.error("Parsing file(%s): %s", json_spec_filename, json_error_msg)
-                    return None
-        except IOError as fileopen_error_msg:
-            logger.warning(fileopen_error_msg)
-            return None
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def get_htm_target_id(self, mount_point):
-        target_id, _ = self._read_htm_ids(mount_point)
-        return target_id
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def get_mbed_htm(self, mount_point):
-        _, build_info = self._read_htm_ids(mount_point)
-        return build_info
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def get_mbed_htm_comment_section_ver_build(self, line):
-        return self._mbed_htm_comment_section_ver_build(line)
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def get_mbed_htm_lines(self, mount_point):
-        return self._htm_lines(mount_point)
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def get_details_txt(self, mount_point):
-        return self._details_txt(mount_point)
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def parse_details_txt(self, lines):
-        return self._parse_details(lines)
-
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def scan_html_line_for_target_id(self, line):
-        return self._target_id_from_htm(line)
-
-    @staticmethod
-    @deprecated("This method will be removed from the public API. "
-                "Please use 'list_mbeds' instead")
-    def run_cli_process(cmd, shell=True):
-        return MbedLsToolsBase._run_cli_process(cmd, shell)

packages/mbed-ls/test/mbedls_toolsbase.py

@@ -102,8 +102,8 @@ def test_list_mbeds_invalid_platform(self):
                                    'target_id_usb_id': u'not_in_target_db',
                                    'serial_port': "dummy_serial_port"}]
         for qos in [FSInteraction.BeforeFilter, FSInteraction.AfterFilter]:
-            with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._read_htm_ids") as _read_htm,\
-                patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as _mpr,\
+            with patch("mbed_lstools.lstools_base.MbedLsToolsBase._read_htm_ids") as _read_htm,\
+                patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as _mpr,\
                 patch("mbed_os_tools.detect.platform_database.PlatformDatabase.get") as _get,\
                 patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir:
                 _mpr.return_value = True
@@ -121,7 +121,7 @@ def test_list_mbeds_unmount_mid_read(self):
         self.base.return_value = [{'mount_point': 'dummy_mount_point',
                                    'target_id_usb_id': u'0240DEADBEEF',
                                    'serial_port': "dummy_serial_port"}]
-        with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as _mpr,\
+        with patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as _mpr,\
              patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir:
             _mpr.return_value = True
             _listdir.side_effect = OSError
@@ -133,7 +133,7 @@ def _test(mock):
             self.base.return_value = [{'mount_point': 'dummy_mount_point',
                                        'target_id_usb_id': u'0240DEADBEEF',
                                        'serial_port': "dummy_serial_port"}]
-            with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as _mpr,\
+            with patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as _mpr,\
                  patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir,\
                  patch('mbed_os_tools.detect.lstools_base.open', mock, create=True):
                 _mpr.return_value = True
@@ -179,7 +179,7 @@ def _handle_open(*args, **kwargs):
                 return DEFAULT
 
         m = mock_open(read_data=details_txt_contents)
-        with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as _mpr,\
+        with patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as _mpr,\
              patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir,\
              patch('mbed_os_tools.detect.lstools_base.open', m, create=True) as mocked_open:
             mocked_open.side_effect = _handle_open
@@ -195,9 +195,9 @@ def _test(mock):
             self.base.return_value = [{'mount_point': 'dummy_mount_point',
                                        'target_id_usb_id': u'0240DEADBEEF',
                                        'serial_port': "dummy_serial_port"}]
-            with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as _mpr,\
+            with patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as _mpr,\
                  patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir,\
-                 patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._update_device_from_htm") as _htm,\
+                 patch("mbed_lstools.lstools_base.MbedLsToolsBase._update_device_from_htm") as _htm,\
                  patch('mbed_os_tools.detect.lstools_base.open', mock, create=True):
                 _mpr.return_value = True
                 _htm.side_effect = None
@@ -219,7 +219,7 @@ def test_list_mbeds_unmount_mid_read_list_unmounted(self):
         self.base.return_value = [{'mount_point': 'dummy_mount_point',
                                    'target_id_usb_id': u'0240DEADBEEF',
                                    'serial_port': "dummy_serial_port"}]
-        with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as _mpr,\
+        with patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as _mpr,\
              patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir:
             _mpr.return_value = True
             _listdir.side_effect = OSError
@@ -357,8 +357,8 @@ def test_fs_never(self):
             'serial_port': 'invalid_serial_port'
         }
         self.base.return_value = [device]
-        with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._update_device_from_fs") as _up_fs,\
-             patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as mount_point_ready:
+        with patch("mbed_lstools.lstools_base.MbedLsToolsBase._update_device_from_fs") as _up_fs,\
+             patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as mount_point_ready:
             mount_point_ready.return_value = True
 
             filter = None
@@ -395,9 +395,9 @@ def test_fs_after(self):
             'mount_point': 'invalid_mount_point',
             'serial_port': 'invalid_serial_port'
         }
-        with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._read_htm_ids") as _read_htm,\
-             patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._details_txt") as _up_details,\
-             patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as mount_point_ready,\
+        with patch("mbed_lstools.lstools_base.MbedLsToolsBase._read_htm_ids") as _read_htm,\
+             patch("mbed_lstools.lstools_base.MbedLsToolsBase._details_txt") as _up_details,\
+             patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as mount_point_ready,\
              patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir:
             new_device_id = "00017531642046"
             _read_htm.return_value = (new_device_id, {})
@@ -469,9 +469,9 @@ def test_fs_before(self):
             'mount_point': 'invalid_mount_point',
             'serial_port': 'invalid_serial_port'
         }
-        with patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._read_htm_ids") as _read_htm,\
-             patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase._details_txt") as _up_details,\
-             patch("mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready") as mount_point_ready,\
+        with patch("mbed_lstools.lstools_base.MbedLsToolsBase._read_htm_ids") as _read_htm,\
+             patch("mbed_lstools.lstools_base.MbedLsToolsBase._details_txt") as _up_details,\
+             patch("mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready") as mount_point_ready,\
              patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir:
             new_device_id = u'00017575430420'
             _read_htm.return_value = (new_device_id, {})
@@ -564,8 +564,8 @@ def test_list_mbeds_valid_platform(self):
         self.base.return_value = [{'mount_point': 'dummy_mount_point',
                                    'target_id_usb_id': u'0240DEADBEEF',
                                    'serial_port': None}]
-        with patch('mbed_lstools.lstools_base.MbedDetectLsToolsBase._read_htm_ids') as _read_htm,\
-             patch('mbed_lstools.lstools_base.MbedDetectLsToolsBase.mount_point_ready') as _mpr,\
+        with patch('mbed_lstools.lstools_base.MbedLsToolsBase._read_htm_ids') as _read_htm,\
+             patch('mbed_lstools.lstools_base.MbedLsToolsBase.mount_point_ready') as _mpr,\
              patch('mbed_os_tools.detect.platform_database.PlatformDatabase.get') as _get,\
              patch("mbed_os_tools.detect.lstools_base.listdir") as _listdir:
             _mpr.return_value = True

src/mbed_os_tools/detect/darwin.py

@@ -23,7 +23,7 @@
     from plistlib import readPlistFromString as loads
 from xml.parsers.expat import ExpatError
 
-from .lstools_base import MbedDetectLsToolsBase
+from .lstools_base import MbedLsToolsBase
 
 import logging
 
@@ -108,12 +108,12 @@ def _dfs_usb_info(obj, parents):
     return output
 
 
-class MbedLsToolsDarwin(MbedDetectLsToolsBase):
+class MbedLsToolsDarwin(MbedLsToolsBase):
     """ mbed-enabled platform detection on Mac OS X
     """
 
     def __init__(self, **kwargs):
-        MbedDetectLsToolsBase.__init__(self, **kwargs)
+        MbedLsToolsBase.__init__(self, **kwargs)
         self.mac_version = float(".".join(platform.mac_ver()[0].split(".")[:2]))
 
     def find_candidates(self):

src/mbed_os_tools/detect/linux.py

@@ -16,7 +16,7 @@
 import re
 import os
 
-from .lstools_base import MbedDetectLsToolsBase
+from .lstools_base import MbedLsToolsBase
 
 import logging
 
@@ -35,14 +35,14 @@ def _readlink(link):
         return content
 
 
-class MbedLsToolsLinuxGeneric(MbedDetectLsToolsBase):
+class MbedLsToolsLinuxGeneric(MbedLsToolsBase):
     """ mbed-enabled platform for Linux with udev
     """
 
     def __init__(self, **kwargs):
         """! ctor
         """
-        MbedDetectLsToolsBase.__init__(self, **kwargs)
+        MbedLsToolsBase.__init__(self, **kwargs)
         self.nlp = re.compile(r"(pci|usb)-[0-9a-zA-Z:_-]*_(?P<usbid>[0-9a-zA-Z]*)-.*$")
         self.mmp = re.compile(r"(?P<dev>(/[^/ ]*)+) on (?P<dir>(/[^/ ]*)+) ")
         self.udp = re.compile(r"^[0-9]+-[0-9]+[^:\s]*$")