add CI and test changing a parameter (#5)

* add CI and test changing a parameter

* bump version

* publish action

* badge

* use sentinel (fix Use sentinel object  #1)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/publish.yaml

@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+      - name: Publish
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry publish --build

.github/workflows/pytest.yaml

@@ -0,0 +1,47 @@
+name: pytest
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: '14 3 * * 1'  # at 03:14 on Monday.
+
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.12"
+          - "3.11"
+          - "3.10"
+        os:
+          - ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+      - name: Install package
+        run: |
+          poetry install --no-interaction
+      - name: Run pytest
+        run: |
+          poetry run python --version
+          poetry run coverage run -m pytest
+          poetry run coverage lcov
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: coverage.lcov

README.md

@@ -1,3 +1,7 @@
+[![zincware](https://img.shields.io/badge/Powered%20by-zincware-darkcyan)](https://github.com/zincware)
+[![PyPI version](https://badge.fury.io/py/znfields.svg)](https://badge.fury.io/py/znfields)
+[![Coverage Status](https://coveralls.io/repos/github/zincware/znfields/badge.svg?branch=main)](https://coveralls.io/github/zincware/znfields?branch=main)
+
 # znfields
 
 Provide a `getter` for `dataclasses.fields` to allow e.g. for lazy evaluation.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "znfields"
-version = "0.1.0"
+version = "0.1.1"
 description = "Lazy evaluation of dataclass fields"
 authors = ["Fabian Zills <[email protected]>"]
 license = "Apache-2.0"
@@ -12,6 +12,7 @@ python = "^3.10"
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.8.0"
 pytest = "^8.3.2"
+coverage = "^7.6.1"
 
 
 

tests/test_znfields.py

@@ -17,6 +17,13 @@ def test_example1():
     assert example.parameter == "parameter:1"
 
 
+def test_example1_with_update():
+    example = Example1(parameter=1)
+    assert example.parameter == "parameter:1"
+    example.parameter = 2
+    assert example.parameter == "parameter:2"
+
+
 @dataclasses.dataclass
 class Example2(znfields.Base):
     parameter: float = znfields.field()
@@ -46,7 +53,7 @@ def test_example3():
     field = dataclasses.fields(example)[0]
     assert field.metadata == {
         "category": "test",
-        znfields._GETTER: example1_parameter_getter,
+        znfields.ZNFIELDS_GETTER_TYPE: example1_parameter_getter,
     }
 
 

znfields/__init__.py

@@ -2,7 +2,12 @@
 import functools
 from typing import Any, Callable, Optional
 
-_GETTER = "znfields.getter"
+
+class _ZNFIELDS_GETTER_TYPE:
+    pass
+
+
+ZNFIELDS_GETTER_TYPE = _ZNFIELDS_GETTER_TYPE()
 
 
 class Base:
@@ -17,7 +22,7 @@ def __getattribute__(self, name: str) -> Any:
             )
         except StopIteration:
             return super().__getattribute__(name)
-        lazy = field.metadata.get(_GETTER)
+        lazy = field.metadata.get(ZNFIELDS_GETTER_TYPE)
         if lazy:
             return lazy(self, name)
         return super().__getattribute__(name)
@@ -31,7 +36,7 @@ def field(*, getter: Optional[Callable[[Any, str], Any]] = None, **kwargs):
                 raise TypeError(
                     f"metadata must be a dict, not {type(kwargs['metadata'])}"
                 )
-            kwargs["metadata"][_GETTER] = getter
+            kwargs["metadata"][ZNFIELDS_GETTER_TYPE] = getter
         else:
-            kwargs["metadata"] = {_GETTER: getter}
+            kwargs["metadata"] = {ZNFIELDS_GETTER_TYPE: getter}
     return dataclasses.field(**kwargs)