Rename AdjustAnnotations to Variant

This commit renames the `AdjustAnnotations` class to `Variant` in both
Python and C++ source files, as well as in tests and build configurations.
All references to the old name have been removed, and related files
have been renamed for consistency.

- Renamed `AdjustAnnotations` to `Variant` in `plugins/python/python/phlex/__init__.py`
- Renamed C++ class `AdjustAnnotations` to `Variant` in `plugins/python/src/modulewrap.cpp`
- Updated `test/python/adder.py` to use `Variant`
- Renamed `test/python/unit_test_annotations.py` to `test/python/unit_test_variant.py`
- Renamed `test/python/pymismatch_annotations.jsonnet` to `test/python/pymismatch_variant.jsonnet`
- Updated `test/python/CMakeLists.txt` to reflect the name and file changes.

Co-authored-by: greenc-FNAL <2372949+greenc-FNAL@users.noreply.github.com>

Author: google-labs-jules[bot]

plugins/python/python/phlex/__init__.py

@@ -7,7 +7,7 @@
 from typing import Any, Callable
 
 
-class AdjustAnnotations:
+class Variant:
     """Wrapper to associate custom annotations with a callable.
 
     This class wraps a callable and provides custom ``__annotations__`` and
@@ -30,7 +30,7 @@ class AdjustAnnotations:
         >>> def add(i: Number, j: Number) -> Number:
         ...     return i + j
         ...
-        >>> int_adder = AdjustAnnotations(add, {"i": int, "j": int, "return": int}, "iadd")
+        >>> int_adder = Variant(add, {"i": int, "j": int, "return": int}, "iadd")
     """
 
     def __init__(
@@ -70,14 +70,14 @@ def __init__(
     def __call__(self, *args, **kwargs):
         """Raises an error if called directly.
 
-        AdjustAnnotations instances should not be called directly. The framework should
+        Variant instances should not be called directly. The framework should
         extract ``phlex_callable`` instead and call that.
 
         Raises:
             AssertionError: To indicate incorrect usage, unless overridden.
         """
         assert self._allow_call, (
-            f"AdjustAnnotations '{self.__name__}' was called directly. "
+            f"Variant '{self.__name__}' was called directly. "
             f"The framework should extract phlex_callable instead."
         )
         return self.phlex_callable(*args, **kwargs)  # type: ignore

plugins/python/src/modulewrap.cpp

@@ -670,12 +670,12 @@ namespace {
 // back to dictionary iteration only if introspection fails.
 //
 // This logic mirrors the Python test class variant.py originally from PR #245.
-class AdjustAnnotations {
+class Variant {
   PyObject* m_callable;
   PyObject* m_annotations;
 
 public:
-  AdjustAnnotations(PyObject* callable) : m_callable(callable), m_annotations(nullptr)
+  Variant(PyObject* callable) : m_callable(callable), m_annotations(nullptr)
   {
     PyObject* name = PyUnicode_FromString("__annotations__");
     m_annotations = PyObject_GetAttr(m_callable, name);
@@ -691,7 +691,7 @@ class AdjustAnnotations {
     Py_DECREF(name);
   }
 
-  ~AdjustAnnotations() { Py_XDECREF(m_annotations); }
+  ~Variant() { Py_XDECREF(m_annotations); }
 
   void get_input_types(std::vector<std::string>& types)
   {
@@ -830,7 +830,7 @@ static PyObject* parse_args(PyObject* args,
   // retrieve C++ (matching) types from annotations
   input_types.reserve(input_labels.size());
 
-  AdjustAnnotations adj(callable);
+  Variant adj(callable);
   adj.get_return_type(output_types);
   adj.get_input_types(input_types);
 

test/python/CMakeLists.txt

@@ -68,7 +68,7 @@ if(HAS_CPPYY)
     set(PYTHON_TEST_PHLEX_INSTALL ${CMAKE_SOURCE_DIR})
   endif()
 
-  set(PYTHON_TEST_FILES test_phlex.py unit_test_annotations.py)
+  set(PYTHON_TEST_FILES test_phlex.py unit_test_variant.py)
 
   # Determine pytest command based on coverage support
   if(HAS_PYTEST_COV AND ENABLE_COVERAGE)
@@ -156,15 +156,15 @@ if(HAS_NUMPY)
   list(APPEND ACTIVE_PY_CPHLEX_TESTS py:baduint)
 
   add_test(
-    NAME py:mismatch_ann
-    COMMAND phlex -c ${CMAKE_CURRENT_SOURCE_DIR}/pymismatch_annotations.jsonnet
+    NAME py:mismatch_variant
+    COMMAND phlex -c ${CMAKE_CURRENT_SOURCE_DIR}/pymismatch_variant.jsonnet
   )
   set_tests_properties(
-    py:mismatch_ann
+    py:mismatch_variant
     PROPERTIES
       PASS_REGULAR_EXPRESSION "number of inputs .* does not match number of annotation types"
   )
-  list(APPEND ACTIVE_PY_CPHLEX_TESTS py:mismatch_ann)
+  list(APPEND ACTIVE_PY_CPHLEX_TESTS py:mismatch_variant)
 
   add_test(NAME py:veclists COMMAND phlex -c ${CMAKE_CURRENT_SOURCE_DIR}/pyveclists.jsonnet)
   list(APPEND ACTIVE_PY_CPHLEX_TESTS py:veclists)
@@ -256,7 +256,7 @@ set_tests_properties(
 
 # Unit tests for the phlex python package
 add_test(
-  NAME py:unit_annotations
-  COMMAND ${Python_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/unit_test_annotations.py
+  NAME py:unit_variant
+  COMMAND ${Python_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/unit_test_variant.py
 )
-set_tests_properties(py:unit_annotations PROPERTIES ENVIRONMENT "${PYTHON_TEST_ENVIRONMENT}")
+set_tests_properties(py:unit_variant PROPERTIES ENVIRONMENT "${PYTHON_TEST_ENVIRONMENT}")

test/python/adder.py

@@ -6,7 +6,7 @@
 
 from typing import Protocol, TypeVar
 
-from phlex import AdjustAnnotations
+from phlex import Variant
 
 
 class AddableProtocol[T](Protocol):
@@ -54,5 +54,5 @@ def PHLEX_REGISTER_ALGORITHMS(m, config):
     Returns:
         None
     """
-    int_adder = AdjustAnnotations(add, {"i": int, "j": int, "return": int}, "iadd")
+    int_adder = Variant(add, {"i": int, "j": int, "return": int}, "iadd")
     m.transform(int_adder, input_family=config["input"], output_products=config["output"])

…st/python/pymismatch_annotations.jsonnet test/python/pymismatch_variant.jsonnettest/python/pymismatch_annotations.jsonnet renamed to test/python/pymismatch_variant.jsonnet test/python/pymismatch_annotations.jsonnet renamed to test/python/pymismatch_variant.jsonnet

@@ -1,23 +1,23 @@
 #!/usr/bin/env python3
-"""Unit tests for the phlex.AdjustAnnotations class."""
+"""Unit tests for the phlex.Variant class."""
 
 import unittest
 
-from phlex import AdjustAnnotations
+from phlex import Variant
 
 
 def example_func(a, b=1):
     """Example function for testing."""
     return a + b
 
 
-class TestAdjustAnnotations(unittest.TestCase):
-    """Tests for AdjustAnnotations wrapper."""
+class TestVariant(unittest.TestCase):
+    """Tests for Variant wrapper."""
 
     def test_initialization(self):
         """Test proper initialization and attribute exposure."""
         ann = {"a": int, "b": int, "return": int}
-        wrapper = AdjustAnnotations(example_func, ann, "example_wrapper")
+        wrapper = Variant(example_func, ann, "example_wrapper")
 
         self.assertEqual(wrapper.__name__, "example_wrapper")
         self.assertEqual(wrapper.__annotations__, ann)
@@ -28,21 +28,21 @@ def test_initialization(self):
 
     def test_call_by_default_raises(self):
         """Test that calling the wrapper raises AssertionError by default."""
-        wrapper = AdjustAnnotations(example_func, {}, "no_call")
+        wrapper = Variant(example_func, {}, "no_call")
         with self.assertRaises(AssertionError) as cm:
             wrapper(1)
         self.assertIn("was called directly", str(cm.exception))
 
     def test_allow_call(self):
         """Test that calling is allowed when configured."""
-        wrapper = AdjustAnnotations(example_func, {}, "yes_call", allow_call=True)
+        wrapper = Variant(example_func, {}, "yes_call", allow_call=True)
         self.assertEqual(wrapper(10, 20), 30)
 
     def test_clone_shallow(self):
         """Test shallow cloning behavior."""
         # For a function, copy.copy just returns the function itself usually,
-        # but let's test the flag logic in AdjustAnnotations
-        wrapper = AdjustAnnotations(example_func, {}, "clone_shallow", clone=True)
+        # but let's test the flag logic in Variant
+        wrapper = Variant(example_func, {}, "clone_shallow", clone=True)
         # function copy is same object
         self.assertEqual(wrapper.phlex_callable, example_func)
 
@@ -51,7 +51,7 @@ class CallableObj:
             def __call__(self): pass
 
         obj = CallableObj()
-        wrapper_obj = AdjustAnnotations(obj, {}, "obj_clone", clone=True)
+        wrapper_obj = Variant(obj, {}, "obj_clone", clone=True)
         self.assertNotEqual(id(wrapper_obj.phlex_callable), id(obj))  # copy was made?
         # copy.copy of a custom object usually creates a new instance if generic
 
@@ -62,7 +62,7 @@ def __init__(self): self.data = [1]
             def __call__(self): return self.data[0]
 
         c = Container()
-        wrapper = AdjustAnnotations(c, {}, "deep_clone", clone="deep")
+        wrapper = Variant(c, {}, "deep_clone", clone="deep")
         self.assertNotEqual(id(wrapper.phlex_callable), id(c))
         self.assertNotEqual(id(wrapper.phlex_callable.data), id(c.data))