Add tests and compilation

Author: znicholls

meson.build

@@ -147,12 +147,10 @@ if pyprojectwheelbuild_enabled
   # this is where that operation happens.
   # Files get copied to <python directory>/site-packages/<subdir>
   foreach python_src : python_srcs
-    message(python_src)
-    message(python_project_name)
-    message(fs.relative_to(python_src, python_project_name))
+    message(fs.relative_to(python_src, 'src' / python_project_name))
     py.install_sources(
         python_src,
-        subdir: python_project_name / fs.relative_to(python_src, python_project_name),
+        subdir: fs.parent(fs.relative_to(python_src, 'src')),
         pure: false,
     )
 

pyproject.toml

@@ -99,6 +99,7 @@ tests-min = [
     # Key dependencies
     # ----------------
     "pytest>=8.3.4",
+    "pytest-regressions>=2.8.2",
 ]
 # Full test dependencies.
 tests-full = [
@@ -112,6 +113,7 @@ tests-full = [
 tests = [
     {include-group = "tests-min"},
     {include-group = "tests-full"},
+    "ipython>=8.18.1",
 ]
 all-dev = [
     {include-group = "dev"},

requirements-only-tests-locked.txt

@@ -1,12 +1,33 @@
 # This file was autogenerated by uv via the following command:
 #    uv export -o requirements-only-tests-locked.txt --no-hashes --no-dev --no-emit-project --only-group tests
+asttokens==3.0.0
 colorama==0.4.6 ; sys_platform == 'win32'
 coverage==7.6.10
+decorator==5.1.1
 exceptiongroup==1.3.0 ; python_full_version < '3.11'
+executing==2.1.0
 iniconfig==2.0.0
+ipython==8.18.1 ; python_full_version < '3.10'
+ipython==8.37.0 ; python_full_version == '3.10.*'
+ipython==9.4.0 ; python_full_version >= '3.11'
+ipython-pygments-lexers==1.1.1 ; python_full_version >= '3.11'
+jedi==0.19.2
+matplotlib-inline==0.1.7
 packaging==24.2
+parso==0.8.4
+pexpect==4.9.0 ; (python_full_version < '3.10' and sys_platform == 'emscripten') or (sys_platform != 'emscripten' and sys_platform != 'win32')
 pluggy==1.5.0
+prompt-toolkit==3.0.48
+ptyprocess==0.7.0 ; (python_full_version < '3.10' and sys_platform == 'emscripten') or (sys_platform != 'emscripten' and sys_platform != 'win32')
+pure-eval==0.2.3
+pygments==2.19.1
 pytest==8.3.4
 pytest-cov==6.0.0
+pytest-datadir==1.8.0
+pytest-regressions==2.8.2
+pyyaml==6.0.2
+stack-data==0.6.3
 tomli==2.2.1 ; python_full_version <= '3.11'
-typing-extensions==4.12.2 ; python_full_version < '3.11'
+traitlets==5.14.3
+typing-extensions==4.12.2 ; python_full_version < '3.12'
+wcwidth==0.2.13

requirements-only-tests-min-locked.txt

@@ -6,5 +6,8 @@ iniconfig==2.0.0
 packaging==24.2
 pluggy==1.5.0
 pytest==8.3.4
+pytest-datadir==1.8.0
+pytest-regressions==2.8.2
+pyyaml==6.0.2
 tomli==2.2.1 ; python_full_version < '3.11'
 typing-extensions==4.12.2 ; python_full_version < '3.11'

src/example_fgen_basic/error_v/creation.py

@@ -8,10 +8,10 @@
 from example_fgen_basic.pyfgen_runtime.exceptions import CompiledExtensionNotFoundError
 
 try:
-    from example._lib import (  # type: ignore
+    from example_fgen_basic._lib import (  # type: ignore
         m_error_v_creation_w,
     )
-except (ModuleNotFoundError, ImportError) as exc:
+except (ModuleNotFoundError, ImportError) as exc:  # pragma: no cover
     raise CompiledExtensionNotFoundError("example._lib.m_error_v_creation_w") from exc
 
 

src/example_fgen_basic/error_v/error_v.py

@@ -4,6 +4,8 @@
 
 from __future__ import annotations
 
+from typing import Any
+
 from attrs import define
 
 from example_fgen_basic.pyfgen_runtime.base_finalisable import (
@@ -13,10 +15,10 @@
 from example_fgen_basic.pyfgen_runtime.exceptions import CompiledExtensionNotFoundError
 
 try:
-    from example._lib import (  # type: ignore
+    from example_fgen_basic._lib import (  # type: ignore
         m_error_v_creation_w,
     )
-except (ModuleNotFoundError, ImportError) as exc:
+except (ModuleNotFoundError, ImportError) as exc:  # pragma: no cover
     raise CompiledExtensionNotFoundError("example._lib.m_error_v_creation_w") from exc
 
 
@@ -26,6 +28,15 @@ class ErrorV(FinalisableWrapperBase):
     TODO: auto docstring e.g. "Wrapper around the Fortran :class:`ErrorV`"
     """
 
+    # Bug in Ipython pretty hence have to put this on every object?
+    def _repr_pretty_(self, p: Any, cycle: bool) -> None:
+        """
+        Get pretty representation of self
+
+        Used by IPython notebooks and other tools
+        """
+        super()._repr_pretty_(p=p, cycle=cycle)
+
     @property
     def exposed_attributes(self) -> tuple[str, ...]:
         """

tests/unit/test_error_v_creation.py

@@ -6,6 +6,9 @@
 (deliberately, just to see how it goes).
 """
 
+import pytest
+from IPython.lib.pretty import pretty
+
 from example_fgen_basic.error_v import ErrorV
 from example_fgen_basic.error_v.creation import create_error
 
@@ -38,10 +41,40 @@ def test_create_error_negative():
     assert res.message == "Negative number supplied"
 
 
-# Tests to write:
-# - if we create more errors than we have available, we don't segfault.
-#   Instead, we should get an error back.
-#   That error should just use the instance ID of the last available array index
-#   (it is ok to overwrite an already used error to avoid a complete failure,
-#   but we should probably include that we did this in the error message).
-# - we can resize the available number of error instances to avoid hitting limits
+def test_error_too_many_instances():
+    pytest.skip("Causes segfault right now")
+    # - if we create more errors than we have available, we don't segfault.
+    #   Instead, we should get an error back.
+    #   That error should just use the instance ID of the last available array index
+    #   (it is ok to overwrite an already used error to avoid a complete failure,
+    #   but we should probably include that we did this in the error message).
+    # TODO: expect error here
+    for _ in range(4097):
+        create_error(1)
+
+
+def test_increase_number_of_instances():
+    raise NotImplementedError
+    # - Make 4096 instances
+    # - show that making one more raises an error
+    # - increase number of instances
+    # - show that making one more now works without error
+
+
+# Some test to illustrate what the formatting does
+def test_error_str(file_regression):
+    res = create_error(1.0)
+
+    file_regression.check(str(res))
+
+
+def test_error_pprint(file_regression):
+    res = create_error(1.0)
+
+    file_regression.check(pretty(res))
+
+
+def test_error_html(file_regression):
+    res = create_error(1.0)
+
+    file_regression.check(res._repr_html_(), extension=".html")

tests/unit/test_error_v_creation/test_error_html.html

@@ -0,0 +1,41 @@
+<div>
+  <style>
+.fgen-wrap {
+  /*font-family: monospace;*/
+  width: 540px;
+}
+
+.fgen-header {
+  padding: 6px 0 6px 3px;
+  border-bottom: solid 1px #777;
+  color: #555;;
+}
+
+.fgen-header > div {
+  display: inline;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+.fgen-basefinalizable-cls,
+.fgen-basefinalizable-instance-index {
+  margin-left: 2px;
+  margin-right: 10px;
+}
+
+.fgen-basefinalizable-cls {
+  font-weight: bold;
+  color: #000000;
+}
+  </style>
+  <div class='fgen-wrap'>
+    <div class='fgen-header'>
+      <div class='fgen-basefinalizable-cls'>ErrorV</div>
+        <div class='fgen-basefinalizable-instance-index'>instance_index=6</div>
+        <table><tbody>
+          <tr><th>code</th><td style='text-align:left;'>0</td></tr>
+          <tr><th>message</th><td style='text-align:left;'></td></tr>
+        </tbody></table>
+    </div>
+  </div>
+</div>

tests/unit/test_error_v_creation/test_error_pprint.txt

@@ -0,0 +1 @@
+ErrorV(instance_index=5, code=0, message=)

tests/unit/test_error_v_creation/test_error_str.txt

@@ -0,0 +1 @@
+ErrorV(instance_index=4, code=0, message=)