Address CI messages (#3)

* address pyright messages

* update vscode settings

* enable test coverage

* publish coverage data

Author: vassilyl

.github/workflows/CI.yml

@@ -39,11 +39,14 @@ jobs:
         npx pyright
     - name: Test with pytest
       run: |
-        pytest --junitxml=junit/test-results-${{ matrix.python-version }}.xml --cov=com --cov-report=xml --cov-report=html
+        pytest --junitxml=junit/test-results-${{ matrix.python-version }}.xml --cov=msrc.appconfig --cov=msrc.appconfig_decl --cov-report=xml --cov-report=html
     - name: Upload pytest test results
       uses: actions/upload-artifact@v2
       with:
         name: pytest-results-${{ matrix.python-version }}
-        path: junit/test-results-${{ matrix.python-version }}.xml
+        path: |
+          junit/test-results-${{ matrix.python-version }}.xml
+          coverage.xml
+          htmlcov 
       # Use always() to always run this step to publish test results when there are test failures
       if: ${{ always() }}

.vscode/settings.json

@@ -1,12 +1,12 @@
 {
-    "python.pythonPath": "c:\\v\\github\\microsoft\\msrc-appconfig\\.venv\\Scripts\\python.exe",
-    "python.analysis.typeCheckingMode": "basic",
+    "python.analysis.typeCheckingMode": "strict",
     "python.analysis.extraPaths": [
         "msrc-appconfig",
         "msrc-appconfig/tests",
         "msrc-appconfig-attrs",
         "msrc-appconfig-dataclasses",
         "msrc-appconfig-param"
     ],
-    "python.testing.pytestEnabled": true
+    "python.testing.pytestEnabled": true,
+    "python.linting.flake8Enabled": true
 }

api_md.py

@@ -79,7 +79,7 @@ def write_fun(fn: FunctionType, f: TextIOWrapper):
     with open("API.md", "w", encoding="utf8") as f:
         writelines(f, [
             f"<!--\n    THIS FILE HAS BEEN AUTO-GENERATED BY {__file__}\n-->",
-            f"# {pkg.__name__}", '', trim(pkg.__doc__), '',
+            f"# {pkg.__name__}", '', trim(pkg.__doc__ or ''), '',
             '| Functions | |', '| --- | --- |'])
         writelines(f, [
             summary_row(getattr(pkg, fn)) for fn in pkg.__all__

msrc-appconfig/msrc/appconfig/logger.py

@@ -1,4 +1,4 @@
 import logging
 
 
-logger = logging.getLogger(__package__)
+logger: logging.Logger = logging.getLogger(__package__)

msrc-appconfig/msrc/appconfig/read_all.py

@@ -218,7 +218,7 @@ def log_discovered(
     for v in discovered.values():
         logger.info("final %s", v)
     # check required fileds
-    missing_fileds = set()
+    missing_fileds: ty.Set[str] = set()
     for name, el in schema.deep_items():
         if not el.has_default:
             if name not in discovered.keys():

msrc-appconfig/msrc/appconfig/schema.py

@@ -125,7 +125,7 @@ def __init__(self,
                  length: int,
                  parse_to_list: bool = False
                  ):
-        self.length = int(length)
+        self.length: int = int(length)
         if self.length < 0:
             raise ValueError(
                 "Tuple length must be 0 (unrestricted) or a positive integer.")
@@ -169,11 +169,11 @@ def __init__(
         help: Optional[str] = None,
         is_secret: bool = False
     ):
-        self.help = help
+        self.help: Optional[str] = help
         _validate_element_type(element_type)
-        self.element_type = element_type
-        self.is_secret = is_secret
-        self.has_default = has_default
+        self.element_type: ElementType = element_type
+        self.is_secret: bool = is_secret
+        self.has_default: bool = has_default
         self.default_value = default_value
         if has_default and not self.type_check(default_value):
             raise ValueError("Element default value %r must have type %r."
@@ -293,7 +293,7 @@ def parseBase(v: object) -> object:
             generator = map(parseBase, values)
             if t.parse_to_list:
                 return cast(ConfigValueType, list(generator))
-            return tuple(generator)
+            return cast(ConfigValueType, tuple(generator))
         if isinstance(self.element_type, AtomicType):
             return parseAtomic(self.element_type, value)
         elif isinstance(self.element_type, TupleType):
@@ -399,7 +399,7 @@ def interpret_type(t: type) -> Optional[ElementType]:
 
     Returns a type label or None for unsupported types."""
     def tryAtomic(t: type) -> Optional[
-            Union[AtomicType, Type[Enum], Schema[object]]]:
+            Union[AtomicType, Type[Enum], Schema[Any]]]:
         try:
             if issubclass(t, Enum):
                 return t
@@ -411,7 +411,8 @@ def tryAtomic(t: type) -> Optional[
                 return AtomicType.INT
             if issubclass(t, float):
                 return AtomicType.FLOAT
-            return Schema(t)
+            return Schema(t)  # type: ignore
+            # Schema constructor raises runtime  exceptions for improper types
         except (TypeError, ValueError):
             return None