Merge pull request #17 from angrybayblade/test/coverage

Test coverage

Author: angrybayblade

.github/workflows/workflow.yml

@@ -11,20 +11,20 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ ubuntu-latest ]
+        os: [ubuntu-latest]
         python-version: ["3.10.9"]
     timeout-minutes: 5
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@master
-      with:
-        python-version: ${{ matrix.python-version }}
-    - if: matrix.os != 'windows-latest'
-      name: Lock check
-      run: |
-        pip install poetry
-        rm -rf poetry.lock
-        time poetry lock
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@master
+        with:
+          python-version: ${{ matrix.python-version }}
+      - if: matrix.os != 'windows-latest'
+        name: Lock check
+        run: |
+          pip install poetry
+          rm -rf poetry.lock
+          time poetry lock
 
   linter_checks:
     continue-on-error: False
@@ -35,31 +35,70 @@ jobs:
         python-version: ["3.10.9"]
     timeout-minutes: 30
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@master
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run:  |
-        sudo apt-get update --fix-missing
-        sudo apt-get autoremove
-        sudo apt-get autoclean
-        pip install --user --upgrade setuptools
-        pip install tox==4.6.3
-    # TODO
-    # - name: Security checks
-    #   run: |
-    #     tox -e bandit
-    #     tox -e safety
-    - name: Code style check
-      run: |
-        tox -e black-check
-        tox -e isort-check
-        tox -e flake8
-        # TODO
-        # tox -e vulture
-        # tox -e darglint
-    - name: Static type check
-      run: tox -e mypy
-    - name: Pylint
-      run: tox -e pylint
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@master
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          sudo apt-get update --fix-missing
+          sudo apt-get autoremove
+          sudo apt-get autoclean
+          pip install --user --upgrade setuptools
+          pip install tox==4.6.3
+      # TODO
+      # - name: Security checks
+      #   run: |
+      #     tox -e bandit
+      #     tox -e safety
+      - name: Code style check
+        run: |
+          tox -e black-check
+          tox -e isort-check
+          tox -e flake8
+          # TODO
+          # tox -e vulture
+          # tox -e darglint
+      - name: Static type check
+        run: tox -e mypy
+      - name: Pylint
+        run: tox -e pylint
+
+  test:
+    continue-on-error: True
+    needs:
+      - lock_check
+      - linter_checks
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.8", "3.9", "3.10.9", "3.11"]
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: actions/setup-python@master
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update --fix-missing
+          sudo apt-get autoremove
+          sudo apt-get autoclean
+          pip install --user --upgrade setuptools
+          pip install tox==4.6.3
+      - name: Unittests
+        run: |
+          tox -e unittests
+      - if: matrix.python-version == '3.10.9'
+        name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.gitignore

@@ -2,6 +2,10 @@ temp/
 build/
 dist/
 site/
+htmlcov/
+
+.coverage
+coverage.xml
 
 .tox/
 .mypy_cache/

clea/__init__.py

@@ -1,3 +1,20 @@
 """
-A lightweight clea for writing CLI tools in python.
+A lightweight framework for writing CLI tools in python.
 """
+
+from .context import Context  # noqa: F401
+from .params import (  # noqa: F401
+    Boolean,
+    Choice,
+    ChoiceByFlag,
+    ContextParameter,
+    Directory,
+    File,
+    Float,
+    Integer,
+    String,
+    StringList,
+    VersionParameter,
+)
+from .runner import run  # noqa: F401
+from .wrappers import command, group  # noqa: F401

clea/params.py

@@ -47,11 +47,14 @@ def short_flag(self) -> t.Optional[str]:
         return self._short_flag
 
     @property
-    def long_flag(self) -> str:
+    def long_flag(self) -> t.Optional[str]:
         """FLag"""
-        if self._long_flag is not None:
-            return self._long_flag
-        return "--" + t.cast(str, self.name).replace("_", "-")
+        return self._long_flag
+
+    def create_long_flag(self) -> str:
+        """Set the value of long flag."""
+        self._long_flag = "--" + t.cast(str, self.name).replace("_", "-")
+        return self._long_flag
 
     @property
     def default(self) -> t.Optional[ParameterType]:
@@ -106,7 +109,7 @@ def help(self) -> str:
         """Help string."""
         if self.short_flag is not None:
             help_string = f"{self.short_flag}, "
-        else:
+        else:  # pragma: nocover
             help_string = ""
         help_string += f"{self.long_flag}"
         if self._help is not None:
@@ -183,7 +186,7 @@ def help(self) -> str:
         if self.short_flag is not None:
             help_string = f"{self.short_flag}, "
         else:
-            help_string = ""
+            help_string = ""  # pragma: nocover
         help_string += f"{self.long_flag}"
         if self._help is not None:
             help_string += " " * (HELP_COL_LENGTH - len(help_string))
@@ -228,7 +231,7 @@ def help(self) -> str:
         if self.short_flag is not None:
             help_string = f"{self.short_flag}, "
         else:
-            help_string = ""
+            help_string = ""  # pragma: nocover
         help_string += f"{self.long_flag}"
         choices = "|".join(list(map(lambda x: x.value, self.enum)))
         help_string += f"  [{choices}]"
@@ -237,7 +240,7 @@ def help(self) -> str:
             if str_len < HELP_COL_LENGTH:
                 help_string += " " * (HELP_COL_LENGTH - str_len)
                 help_string += self._help
-            else:
+            else:  # pragma: nocover # TODO
                 help_string += "\n"
                 help_string += " " * HELP_COL_LENGTH
                 help_string += f"    {self._help}"
@@ -287,7 +290,7 @@ def help(self) -> str:
             if str_len < HELP_COL_LENGTH:
                 help_string += " " * (HELP_COL_LENGTH - str_len)
                 help_string += self._help
-            else:
+            else:  # pragma: nocover # TODO
                 help_string += "\n"
                 help_string += " " * HELP_COL_LENGTH
                 help_string += f"    {self._help}"

clea/parser.py

@@ -20,7 +20,7 @@
 class BaseParser:
     """Argument parser."""
 
-    _args: deque[Parameter]
+    _args: t.Deque[Parameter]
     _kwargs: t.Dict[str, Parameter]
 
     def __init__(self) -> None:
@@ -49,21 +49,28 @@ def add(self, defintion: Parameter) -> None:
                 self._kwargs[long_flag] = defintion
             return
 
-        if defintion.default is not None:
+        if (
+            defintion.default is None
+            and defintion.short_flag is None
+            and defintion.long_flag is None
+        ):
+            self._args.append(defintion)
+            return
+
+        if defintion.default is not None and defintion.long_flag is None:
+            self._kwargs[defintion.create_long_flag()] = defintion
+
+        if defintion.long_flag is not None:
             self._kwargs[defintion.long_flag] = defintion
 
         if defintion.short_flag is not None:
             self._kwargs[defintion.short_flag] = defintion
-            return
-
-        if defintion.default is None:
-            self._args.append(defintion)
 
     def parse(  # pylint: disable=unused-argument
         self, argv: Argv, commands: t.Optional[t.Dict[str, t.Any]] = None
     ) -> t.Tuple:
         """Parse and return kwargs."""
-        return NotImplemented
+        return NotImplemented  # pragma: nocover
 
 
 class CommandParser(BaseParser):
@@ -93,6 +100,9 @@ def parse(  # pylint: disable=too-many-branches
                 kwargs[definition.name] = definition.parse(value=value)
                 if definition.is_container:
                     self._kwargs[flag] = definition
+                else:
+                    self._kwargs.pop(definition.short_flag or "", None)
+                    self._kwargs.pop(definition.long_flag or "", None)
             else:
                 if len(self._args) == 0:
                     raise ExtraArgumentProvided(f"Extra argument provided `{arg}`")
@@ -105,7 +115,7 @@ def parse(  # pylint: disable=too-many-branches
         if len(self._kwargs) > 0:
             for kwarg in self._kwargs.values():
                 if kwarg.name == "version":
-                    continue
+                    continue  # pragma: nocover
                 if kwarg.is_container:
                     kwargs[kwarg.name] = kwarg.container
                 else:
@@ -155,6 +165,9 @@ def parse(  # pylint: disable=too-many-branches
                 kwargs[definition.name] = definition.parse(value=value)
                 if definition.is_container:
                     self._kwargs[flag] = definition
+                else:
+                    self._kwargs.pop(definition.short_flag or "", None)
+                    self._kwargs.pop(definition.long_flag or "", None)
             else:
                 if len(self._args) == 0:
                     raise ExtraArgumentProvided(f"Extra argument provided `{arg}`")
@@ -167,7 +180,7 @@ def parse(  # pylint: disable=too-many-branches
         if len(self._kwargs) > 0:
             for kwarg in self._kwargs.values():
                 if kwarg.name == "version":
-                    continue
+                    continue  # pragma: nocover
                 if kwarg.is_container:
                     kwargs[kwarg.name] = kwarg.container
                 else:

clea/runner.py

@@ -63,6 +63,7 @@ def run(
     argv = argv if argv is not None else sys.argv[1:].copy()
     result = _run_isolated(cli=cli, argv=argv) if isolated else _run(cli=cli, argv=argv)
     if not isolated:
-        sys.stderr.write(result.stderr)
+        if result.stderr != "":  # pragma: nocover
+            sys.stderr.write(result.stderr + "\n")
         sys.exit(result.exit_code)
     return result

clea/wrappers.py

@@ -95,7 +95,7 @@ def help(self) -> int:
             self._parser._kwargs.values()  # pylint: disable=protected-access
         ):
             if parameter.name == "context":
-                continue
+                continue  # pragma: nocover
             print(f"    {parameter.help()}")
         print("    --help                        Show help and exit.")
         return 0
@@ -113,7 +113,7 @@ def invoke(  # pylint: disable=unused-argument
         self, argv: Argv, isolated: bool = False
     ) -> int:
         """Run the command."""
-        return NotImplemented
+        return NotImplemented  # pragma: nocover
 
 
 class Command(BaseWrapper):
@@ -448,7 +448,7 @@ def help(self) -> int:
             self._parser._kwargs.values()  # pylint: disable=protected-access
         ):
             if parameter.name == "context":
-                continue
+                continue  # pragma: nocover
             print(f"    {parameter.help()}")
         print("    --help                        Show help and exit.")
         print("\nCommands:\n")

docs/command.md

@@ -77,4 +77,9 @@ Usage: add-numbers [OPTIONS] N1 N2
 Options:
 
     --help                        Show help and exit.
-```
+```
+
+## Next steps 
+
+- [Group](/clea/group)
+- [Parameters](/clea/parameters)

docs/context.md

@@ -62,3 +62,7 @@ def home(context: Context) -> None:
 if __name__ == "__main__":
     run(cli=home)
 ```
+
+## Next steps 
+
+- [Testing](/clea/testing)

docs/group.md

@@ -91,4 +91,10 @@ Options:
 Commands:
 
     add                           Add two numbers.
-```
+```
+
+## Next steps 
+
+- [Parameters](/clea/parameters)
+- [Context](/clea/context)
+- [Testing](/clea/testing)

docs/parameters.md

@@ -294,4 +294,9 @@ As before the input will be parsed as enum value
 $ python command.py --tcp
 
 ctype=<ConnectionType.TCP: 'tcp'>
-```
+```
+
+## Next steps 
+
+- [Context](/clea/context)
+- [Testing](/clea/testing)