make release-tag: Merge branch 'main' into stable

Author: amontanez24

HISTORY.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## v1.22.1 - 2025-06-03
+
+### Bugs Fixed
+
+* Original metadata object passed to ProgrammableConstraint - Issue [#2565](https://github.com/sdv-dev/SDV/issues/2565) by @frances-h
+
 ## v1.22.0 - 2025-06-02
 
 ### New Features

pyproject.toml

@@ -39,7 +39,7 @@ dependencies = [
     'ctgan>=0.11.0',
     'deepecho>=0.7.0',
     'rdt>=1.17.0',
-    'sdmetrics>=0.21.0.dev0',
+    'sdmetrics>=0.21.0',
     'platformdirs>=4.0',
     'pyyaml>=6.0.1',
 ]
@@ -144,7 +144,7 @@ namespaces = false
 version = {attr = 'sdv.__version__'}
 
 [tool.bumpversion]
-current_version = "1.22.0"
+current_version = "1.22.1.dev1"
 parse = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<candidate>\d+))?'
 serialize = [
     '{major}.{minor}.{patch}.{release}{candidate}',

sdv/__init__.py

@@ -6,7 +6,7 @@
 
 __author__ = 'DataCebo, Inc.'
 __email__ = 'info@sdv.dev'
-__version__ = '1.22.0'
+__version__ = '1.22.1.dev1'
 
 
 import sys

sdv/cag/programmable_constraint.py

@@ -1,5 +1,7 @@
 """Programmable constraints base classes."""
 
+from copy import deepcopy
+
 from sdv.cag._errors import ConstraintNotMetError
 from sdv.cag.base import BaseConstraint
 
@@ -154,6 +156,7 @@ def _validate_constraint_with_data(self, data, metadata):
         self.programmable_constraint.validate_input_data(data)
 
     def _get_updated_metadata(self, metadata):
+        metadata = deepcopy(metadata)
         return self.programmable_constraint.get_updated_metadata(metadata)
 
     def _fit(self, data, metadata):

static_code_analysis.txt

@@ -1,4 +1,4 @@
-Run started:2025-06-02 18:59:40.969469
+Run started:2025-06-03 16:48:44.576975
 
 Test results:
 >> Issue: [B110:try_except_pass] Try, Except, Pass detected.

tests/integration/cag/test_programmable_constraint.py

@@ -4,6 +4,7 @@
 
 from sdv.cag import FixedCombinations, ProgrammableConstraint, SingleTableProgrammableConstraint
 from sdv.datasets.demo import download_demo
+from sdv.metadata import Metadata
 from sdv.multi_table import HMASynthesizer
 from sdv.single_table import GaussianCopulaSynthesizer
 
@@ -196,3 +197,46 @@ def test_end_to_end_simple_constraint_with_no_fit(programmable_constraint):
     true_values = (sampled_data['has_rewards']) & (sampled_data['amenities_fee'] == 0.0)
     false_values = ~sampled_data['has_rewards']
     assert all((true_values) | (false_values))
+
+
+def test_get_updated_metadata_is_passed_metadata_copy(single_table_programmable_constraint):
+    """Test that the ``get_updated_metadata`` is not given the original metadata."""
+    # Setup
+    data, metadata = download_demo('single_table', 'fake_hotel_guests')
+    original_metadata = Metadata.load_from_dict(metadata.to_dict())
+
+    def get_updated_metadata(self, metadata):
+        for column in self.column_names:
+            metadata.remove_column(column)
+
+        metadata.add_column(self._joint_column, sdtype='categorical')
+        return metadata
+
+    single_table_programmable_constraint.get_updated_metadata = get_updated_metadata
+    my_constraint = single_table_programmable_constraint(
+        column_names=['has_rewards', 'room_type'], table_name='fake_hotel_guests'
+    )
+
+    synthesizer = GaussianCopulaSynthesizer(metadata)
+
+    # Run
+    synthesizer.add_constraints([my_constraint])
+    synthesizer.fit(data)
+    updated_metadata = synthesizer.get_metadata('modified')
+
+    # Assert
+    assert metadata.to_dict() == original_metadata.to_dict()
+    expected_modified_metadata = Metadata.load_from_dict({
+        'tables': {
+            'fake_hotel_guests': {
+                'columns': {
+                    col: meta
+                    for col, meta in original_metadata.tables['fake_hotel_guests'].columns.items()
+                    if col not in ['has_rewards', 'room_type']
+                },
+                'primary_key': 'guest_email',
+            }
+        }
+    })
+    expected_modified_metadata.add_column('has_rewards#room_type', sdtype='categorical')
+    assert updated_metadata.to_dict() == expected_modified_metadata.to_dict()

tests/unit/cag/test_programmable_constraint.py

@@ -1,7 +1,7 @@
 """Test ProgrammableConstraint and ProgrammableConstraintHarness."""
 
 import re
-from unittest.mock import Mock
+from unittest.mock import Mock, patch
 
 import pandas as pd
 import pytest
@@ -158,12 +158,17 @@ def test__validate_constraint_with_data_single_table(self):
         # Assert
         programmable_constraint.validate_input_data.assert_called_once_with(data_dict['table'])
 
-    def test__get_updated_metadata(self):
+    @patch('sdv.cag.programmable_constraint.deepcopy')
+    def test__get_updated_metadata(self, mock_deepcopy):
         """Test the ``_get_updated_metadata`` method."""
         # Setup
         metadata = Metadata().load_from_dict({
             'tables': {'table': {'columns': {'col_A': {'sdtype': 'numerical'}}}}
         })
+        copied_metadata = Metadata().load_from_dict({
+            'tables': {'table': {'columns': {'col_A': {'sdtype': 'numerical'}}}}
+        })
+        mock_deepcopy.return_value = copied_metadata
         programmable_constraint = ProgrammableConstraint()
         programmable_constraint.get_updated_metadata = Mock()
         instance = ProgrammableConstraintHarness(programmable_constraint)
@@ -172,7 +177,7 @@ def test__get_updated_metadata(self):
         instance._get_updated_metadata(metadata)
 
         # Assert
-        programmable_constraint.get_updated_metadata.assert_called_once_with(metadata)
+        programmable_constraint.get_updated_metadata.assert_called_once_with(copied_metadata)
 
     def test__fit(self):
         """Test the ``_fit`` method."""