From 0b64604eb9a370267aaca2a045378a2db5eaebcb Mon Sep 17 00:00:00 2001
From: Eric Lin <anselor@gmail.com>
Date: Thu, 16 Jul 2020 17:29:11 -0400
Subject: Added type annotations for fields in cmd2.Cmd. Cleaned up docstring
 in external test plugin Updated some initialization to match new approach for
 version info discovery. Tagged some IDE-only lines as no-cover Adds plugin
 coverage reporting.

---
 plugins/ext_test/cmd2_ext_test/__init__.py      |  8 ++++----
 plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py |  2 +-
 plugins/tasks.py                                |  5 +++--
 plugins/template/cmd2_myplugin/__init__.py      | 13 +++++++++----
 plugins/template/cmd2_myplugin/myplugin.py      |  2 +-
 5 files changed, 18 insertions(+), 12 deletions(-)

(limited to 'plugins')

diff --git a/plugins/ext_test/cmd2_ext_test/__init__.py b/plugins/ext_test/cmd2_ext_test/__init__.py
index dbbc4250..21fd000b 100644
--- a/plugins/ext_test/cmd2_ext_test/__init__.py
+++ b/plugins/ext_test/cmd2_ext_test/__init__.py
@@ -1,19 +1,19 @@
 #
 # coding=utf-8
-"""Description of myplugin
+"""cmd2 External Python Testing Mixin
 
-An overview of what myplugin does.
+Allows developers to exercise their cmd2 application using the PyScript interface
 """
 
 try:
     # For python 3.8 and later
     import importlib.metadata as importlib_metadata
-except ImportError:
+except ImportError:  # pragma: no cover
     # For everyone else
     import importlib_metadata
 try:
     __version__ = importlib_metadata.version(__name__)
-except importlib_metadata.PackageNotFoundError:
+except importlib_metadata.PackageNotFoundError:  # pragma: no cover
     # package is not installed
     __version__ = 'unknown'
 
diff --git a/plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py b/plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py
index 731a0f3b..df54e112 100644
--- a/plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py
+++ b/plugins/ext_test/cmd2_ext_test/cmd2_ext_test.py
@@ -6,7 +6,7 @@ from typing import Optional, TYPE_CHECKING
 
 import cmd2
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     _Base = cmd2.Cmd
 else:
     _Base = object
diff --git a/plugins/tasks.py b/plugins/tasks.py
index 06104429..26ec1adb 100644
--- a/plugins/tasks.py
+++ b/plugins/tasks.py
@@ -8,14 +8,15 @@ Make sure you satisfy the following Python module requirements if you are trying
     - wheel >= 0.31.0
     - setuptools >= 39.1.0
 """
-import os
 import invoke
 
 from plugins.ext_test import tasks as ext_test_tasks
 from plugins.template import tasks as template_tasks
 
 # create namespaces
-namespace = invoke.Collection(ext_test=ext_test_tasks, template=template_tasks)
+namespace = invoke.Collection(ext_test=ext_test_tasks,
+                              template=template_tasks,
+                              )
 namespace_clean = invoke.Collection('clean')
 namespace.add_collection(namespace_clean, 'clean')
 
diff --git a/plugins/template/cmd2_myplugin/__init__.py b/plugins/template/cmd2_myplugin/__init__.py
index 41f0b9cc..e66b62cd 100644
--- a/plugins/template/cmd2_myplugin/__init__.py
+++ b/plugins/template/cmd2_myplugin/__init__.py
@@ -5,11 +5,16 @@
 An overview of what myplugin does.
 """
 
-from pkg_resources import get_distribution, DistributionNotFound
-
 from .myplugin import empty_decorator, MyPluginMixin  # noqa: F401
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    # For python 3.8 and later
+    import importlib.metadata as importlib_metadata
+except ImportError:  # pragma: no cover
+    # For everyone else
+    import importlib_metadata
+try:
+    __version__ = importlib_metadata.version(__name__)
+except importlib_metadata.PackageNotFoundError:  # pragma: no cover
+    # package is not installed
     __version__ = 'unknown'
diff --git a/plugins/template/cmd2_myplugin/myplugin.py b/plugins/template/cmd2_myplugin/myplugin.py
index 5fa12caf..4f1ff0e9 100644
--- a/plugins/template/cmd2_myplugin/myplugin.py
+++ b/plugins/template/cmd2_myplugin/myplugin.py
@@ -7,7 +7,7 @@ from typing import Callable, TYPE_CHECKING
 
 import cmd2
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     _Base = cmd2.Cmd
 else:
     _Base = object
-- 
cgit v1.2.1