test

Author: dweindl

petab/v2/core.py

@@ -240,6 +240,14 @@ class Change(BaseModel):
 
     A change to the model or model state, corresponding to an individual
     row of the PEtab conditions table.
+
+    >>> Change(
+    ...     target_id="k1",
+    ...     operation_type=OperationType.SET_CURRENT_VALUE,
+    ...     target_value="10",
+    ... )  # doctest: +NORMALIZE_WHITESPACE
+    Change(target_id='k1', operation_type='setCurrentValue',
+    target_value=10.0000000000000)
     """
 
     #: The ID of the target entity to change
@@ -284,6 +292,19 @@ class ChangeSet(BaseModel):
     A set of simultaneously occurring changes to the model or model state,
     corresponding to a perturbation of the underlying system. This corresponds
     to all rows of the PEtab conditions table with the same condition ID.
+
+    >>> ChangeSet(
+    ...     id="condition1",
+    ...     changes=[
+    ...         Change(
+    ...             target_id="k1",
+    ...             operation_type=OperationType.SET_CURRENT_VALUE,
+    ...             target_value="10",
+    ...         )
+    ...     ],
+    ... )  # doctest: +NORMALIZE_WHITESPACE
+    ChangeSet(id='condition1', changes=[Change(target_id='k1',
+    operation_type='setCurrentValue', target_value=10.0000000000000)])
     """
 
     #: The condition ID

pyproject.toml

@@ -114,6 +114,7 @@ convention = "pep257"
 "tests/*" = ["T201"]
 
 [tool.ruff.format]
+docstring-code-format = true
 exclude = [
     "petab/math/_generated/*",  # auto-generated
 ]

pytest.ini

@@ -1,4 +1,5 @@
 [pytest]
+addopts = --doctest-modules
 filterwarnings =
     error
     # TODO: until tests are reorganized for petab.v1