Merge pull request #122 from neutrinoceros/support_metadata_in_userde…

…f_dep

pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gpgi"
-version = "0.12.0"
+version = "0.13.0"
 description = "A Generic Particle+Grid Interface"
 authors = [
     { name = "C.M.T. Robert" },

src/gpgi/__init__.py

@@ -2,4 +2,4 @@
 
 from .api import load
 
-__version__ = "0.12.0"
+__version__ = "0.13.0"

src/gpgi/types.py

@@ -5,7 +5,7 @@
 import warnings
 from abc import ABC, abstractmethod
 from copy import deepcopy
-from functools import cached_property, reduce
+from functools import cached_property, partial, reduce
 from itertools import chain
 from time import monotonic_ns
 from typing import TYPE_CHECKING, Any, Dict, Literal, Protocol, Tuple, cast
@@ -558,7 +558,13 @@ def deposit(
             method = "ngp"
 
         if callable(method):
-            func = method
+            from inspect import signature
+
+            sig = signature(method)
+            if "metadata" in sig.parameters:
+                func = cast(DepositionMethodT, partial(method, metadata=self.metadata))
+            else:
+                func = method
         else:
             if method not in _deposition_method_names:
                 raise ValueError(

tests/test_deposit.py

@@ -98,6 +98,21 @@ def test_callable_method(sample_2D_dataset):
     sample_2D_dataset.deposit("mass", method=_deposit_ngp_2D)
 
 
+def test_callable_method_with_metadata(sample_2D_dataset):
+    _is_used = False
+    _md_is_received = False
+
+    def fake_dep(*args, metadata=None, **kwargs):
+        nonlocal _is_used, _md_is_received
+        _is_used = True
+        _md_is_received = metadata is not None
+        return _deposit_ngp_2D(*args, **kwargs)
+
+    sample_2D_dataset.deposit("mass", method=fake_dep)
+    assert _is_used
+    assert _md_is_received
+
+
 @pytest.mark.parametrize("method", ["ngp", "cic", "tsc"])
 @pytest.mark.mpl_image_compare
 def test_2D_deposit(sample_2D_dataset, method):