Merge branch 'master' into initial_flake8_test_module

Author: theotherjimmy

README.md

@@ -1,12 +1,19 @@
 # Mbed OS Tools
 
-This repository contains the python modules needed to work with Mbed OS. **The APIs in this repository are not stable**, as indicated by the 0.x.x semantic version. For this reason, it is recommened to continue using the existing python packages: [mbed-ls](https://github.com/ARMmbed/mbed-os-tools/tree/master/legacy/mbed-ls), [mbed-host-tests](https://github.com/ARMmbed/mbed-os-tools/tree/master/legacy/mbed-host-tests), and [mbed-greentea](https://github.com/ARMmbed/mbed-os-tools/tree/master/legacy/mbed-greentea).
+This repository contains the python modules needed to work with Mbed OS. Historically, the Mbed OS tools have been delivered in separate packages and repositories. Their APIs have evolved separately over time, each with their own style and syntax. This project is working to unify these packages into a single intuitive API.
 
-To contribute changes to these packages, please commit them to this repository. The mapping of these packages to the `mbed-os-tools` modules is as follows:
+## Packages
 
-- mbed-ls - `src/mbed_os_tools/detect` for the implementation, `test/detect` for the tests
-- mbed-greentea - `src/mbed_os_tools/test` for the implementation, `test/test` for the tests
-- mbed-host-tests - `src/mbed_os_tools/test` for the implementation, `test/test` for the tests
+Below is a table showing what packages are delivered from this repository:
+
+| PyPI Package | Source | Depends on | Stable API |
+| ------- | ------ | ---------- | ---------- |
+| mbed-os-tools | `src/` | | **No** |
+| mbed-ls | `legacy/mbed-ls/` | mbed-os-tools | **Yes** |
+| mbed-host-tests | `legacy/mbed-host-tests/` | mbed-os-tools | **Yes** |
+| mbed-greentea | `legacy/mbed-greentea/` | mbed-os-tools | **Yes** |
+
+As indicated above, **the API provided by `mbed-os-tools` is not stable**. For this reason, please continue to use the other packages.
 
 ## License and contributions
 

setup.py

@@ -46,7 +46,6 @@ def read(fname):
     install_requires=[
         "PySerial>=3.0",
         "requests",
-        "pyocd==0.14.0",
         "intelhex",
         "future",
         "PrettyTable>=0.7.2",
@@ -58,5 +57,7 @@ def read(fname):
         "colorama>=0.3,<0.5",
     ],
     tests_require=["mock>=2", "pytest>=3"],
-    extras_require={"colorized_logs": ["colorlog"]},
+    extras_require={
+        "pyocd": ["pyocd==0.14.0"]
+    },
 )

src/mbed_os_tools/test/host_tests_plugins/module_copy_pyocd.py

@@ -15,9 +15,13 @@
 
 import os
 from .host_test_plugins import HostTestPluginBase
-from pyocd.core.helpers import ConnectHelper
-from pyocd.flash.loader import FileProgrammer
 
+try:
+    from pyocd.core.helpers import ConnectHelper
+    from pyocd.flash.loader import FileProgrammer
+    PYOCD_PRESENT = True
+except ImportError:
+    PYOCD_PRESENT = False
 
 class HostTestPluginCopyMethod_pyOCD(HostTestPluginBase):
     # Plugin interface
@@ -44,6 +48,13 @@ def execute(self, capability, *args, **kwargs):
         @param kwargs Additional arguments
         @return Capability call return value
         """
+        if not PYOCD_PRESENT:
+            self.print_plugin_error(
+                'The "pyocd" feature is not installed. Please run '
+                '"pip install mbed-os-tools[pyocd]" to enable the "pyocd" copy plugin.'
+            )
+            return False
+
         if not self.check_parameters(capability, *args, **kwargs):
             return False
 

src/mbed_os_tools/test/host_tests_plugins/module_reset_pyocd.py

@@ -14,7 +14,12 @@
 # limitations under the License.
 
 from .host_test_plugins import HostTestPluginBase
-from pyocd.core.helpers import ConnectHelper
+
+try:
+    from pyocd.core.helpers import ConnectHelper
+    PYOCD_PRESENT = True
+except ImportError:
+    PYOCD_PRESENT = False
 
 
 class HostTestPluginResetMethod_pyOCD(HostTestPluginBase):
@@ -48,6 +53,13 @@ def execute(self, capability, *args, **kwargs):
         @details Each capability e.g. may directly just call some command line program or execute building pythonic function
         @return Capability call return value
         """
+        if not PYOCD_PRESENT:
+            self.print_plugin_error(
+                'The "pyocd" feature is not installed. Please run '
+                '"pip install mbed-os-tools[pyocd]" to enable the "pyocd" reset plugin.'
+            )
+            return False
+
         if not kwargs['target_id']:
             self.print_plugin_error("Error: target_id not set")
             return False