Add Codecov

.github/workflows/ci.yml

@@ -19,13 +19,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v3
 
       - name: Install Poetry
         run: pipx install poetry==${{ env.POETRY_VERSION }}
 
       - name: Set up Python with Poetry cache
-        uses: actions/setup-python@v4.6.1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           cache: poetry
@@ -54,4 +54,7 @@ jobs:
         run: poetry run mypy paramdb tests
 
       - name: Test (Pytest)
-        run: poetry run pytest
+        run: poetry run pytest --cov=paramdb --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/publish.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v3
 
       - name: Install Poetry
         run: pipx install poetry==${{ env.POETRY_VERSION }}
@@ -22,7 +22,7 @@ jobs:
         run: poetry build
 
       - name: Upload package artifact
-        uses: actions/upload-artifact@v3.1.2
+        uses: actions/upload-artifact@v3
         with:
           name: paramdb-release
           path: dist
@@ -36,10 +36,10 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/download-artifact@v3.0.2
+      - uses: actions/download-artifact@v3
         with:
           name: paramdb-release
           path: dist
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.6
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -13,6 +13,8 @@ jupyter_execute/
 __pycache__/
 .mypy_cache/
 .pytest_cache/
+.coverage
+coverage.xml
 
 # Database files
 *.db

paramdb/_database.py

@@ -165,13 +165,13 @@ def commit(self, message: str, data: T) -> int:
     @overload
     def load(
         self, commit_id: int | None = None, *, load_classes: Literal[True] = True
-    ) -> T:
+    ) -> T:  # pragma: no cover
         ...
 
     @overload
     def load(
         self, commit_id: int | None = None, *, load_classes: Literal[False]
-    ) -> dict[str, Any]:
+    ) -> dict[str, Any]:  # pragma: no cover
         ...
 
     def load(self, commit_id: int | None = None, *, load_classes: bool = True) -> Any:

paramdb/_param_data/_collections.py

@@ -61,22 +61,22 @@ def __init__(self, iterable: Iterable[T] | None = None) -> None:
                 self._add_child(item)
 
     @overload
-    def __getitem__(self, index: SupportsIndex) -> T:
+    def __getitem__(self, index: SupportsIndex) -> T:  # pragma: no cover
         ...
 
     @overload
-    def __getitem__(self, index: slice) -> list[T]:
+    def __getitem__(self, index: slice) -> list[T]:  # pragma: no cover
         ...
 
     def __getitem__(self, index: Any) -> Any:
         return self._contents[index]
 
     @overload
-    def __setitem__(self, index: SupportsIndex, value: T) -> None:
+    def __setitem__(self, index: SupportsIndex, value: T) -> None:  # pragma: no cover
         ...
 
     @overload
-    def __setitem__(self, index: slice, value: Iterable[T]) -> None:
+    def __setitem__(self, index: slice, value: Iterable[T]) -> None:  # pragma: no cover
         ...
 
     def __setitem__(self, index: SupportsIndex | slice, value: Any) -> None:

paramdb/_param_data/_dataclasses.py

@@ -29,7 +29,7 @@ def __setitem__(self, name: str, value: Any) -> None:
 
     @property
     @abstractmethod
-    def last_updated(self) -> datetime | None:
+    def last_updated(self) -> datetime | None:  # pragma: no cover
         ...
 
     def to_dict(self) -> dict[str, Any]:

pyproject.toml

@@ -19,6 +19,7 @@ astropy = ["astropy"]
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.3.1"
+pytest-cov = "^4.1.0"
 flake8 = "^6.0.0"
 pylint = "^2.17.4"
 mypy = "^1.3.0"