emod-api 3.2.1__tar.gz → 3.2.2__tar.gz

{emod_api-3.2.1/emod_api.egg-info → emod_api-3.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: emod-api
-Version: 3.2.1
+Version: 3.2.2
 Summary: Core tools for modeling using EMOD
 Author-email: Sharon Chen <sharon.chen@gatesfoundation.org>, Zhaowei Du <zhaowei.du@gatesfoundation.org>, Clark Kirkman IV <clark.kirkmand@gatesfoundation.org>, Daniel Bridenbecker <daniel.bridenbecker@gatesfoundation.org>, Svetlana Titova <svetlana.titova@gatesfoundation.org>, Ye Chen <ye.chen@gatesfoundation.org>
 License-Expression: MIT

emod_api-3.2.2/emod_api/__init__.py

@@ -0,0 +1 @@
+__version__ = "3.2.2"

{emod_api-3.2.1 → emod_api-3.2.2}/emod_api/campaign.py

@@ -217,7 +217,7 @@ def _validate_custom_events(listened_list, broadcast_list, builtin_list, level):
     return list(broadcast)
 
 
-def get_custom_coordinator_events():
+def validate_custom_coordinator_events():
     """Validate and return deduplicated custom coordinator-level events.
 
     Returns:
@@ -231,7 +231,7 @@ def get_custom_coordinator_events():
     return _validate_custom_events(coordinator_events_listened, coordinator_events_broadcast, coordinator_builtin_events, "coordinator")
 
 
-def get_custom_node_events():
+def validate_custom_node_events():
     """Validate and return deduplicated custom node-level events.
 
     Returns:
@@ -245,7 +245,7 @@ def get_custom_node_events():
     return _validate_custom_events(node_events_listened, node_events_broadcast, node_builtin_events, "node")
 
 
-def get_custom_individual_events():
+def validate_custom_individual_events():
     """Validate and return deduplicated custom individual-level events.
 
     Returns:
@@ -263,7 +263,7 @@ def get_recv_trigger(trigger, old=use_old_adhoc_handling):
     """Register an individual-level event as listened to.
 
     Tracks which individual events are used throughout the simulation
-    so that ``get_custom_individual_events`` can validate that every
+    so that ``validate_custom_individual_events`` can validate that every
     listened-to event has a corresponding broadcast.
 
     Args:
@@ -283,7 +283,7 @@ def set_listened_node_event(event: str) -> str:
     """Register a node-level event as listened to.
 
     Tracks which node events are used throughout the simulation so
-    that ``get_custom_node_events`` can validate that every listened-to
+    that ``validate_custom_node_events`` can validate that every listened-to
     event has a corresponding broadcast.
 
     Args:
@@ -302,7 +302,7 @@ def set_listened_coordinator_event(event: str) -> str:
     """Register a coordinator-level event as listened to.
 
     Tracks which coordinator events are used throughout the simulation
-    so that ``get_custom_coordinator_events`` can validate that every
+    so that ``validate_custom_coordinator_events`` can validate that every
     listened-to event has a corresponding broadcast.
 
     Args:
@@ -337,7 +337,7 @@ def set_broadcast_node_event(event: str) -> str:
     """Register a node-level event as broadcast.
 
     Tracks which node events are used throughout the simulation so
-    that ``get_custom_node_events`` can validate that every broadcast
+    that ``validate_custom_node_events`` can validate that every broadcast
     event has something listening to it.
 
     Args:
@@ -356,7 +356,7 @@ def set_broadcast_coordinator_event(event: str) -> str:
     """Register a coordinator-level event as broadcast.
 
     Tracks which coordinator events are used throughout the simulation
-    so that ``get_custom_coordinator_events`` can validate that every
+    so that ``validate_custom_coordinator_events`` can validate that every
     broadcast event has something listening to it.
 
     Args:

{emod_api-3.2.1 → emod_api-3.2.2}/emod_api/demographics/node.py

@@ -50,6 +50,7 @@ class Node(Updateable):
         super().__init__()
         self.forced_id = forced_id
         self.meta = meta if meta else {}
+        # EMOD requires IndividualAttributes in every node, even if empty.
         self.individual_attributes = individual_attributes if individual_attributes else IndividualAttributes()
         self.individual_properties = individual_properties if individual_properties else IndividualProperties()
 
@@ -90,9 +91,7 @@ class Node(Updateable):
              "NodeAttributes": self.node_attributes.to_dict()}
 
         if self.individual_attributes:
-            ia_dict = self.individual_attributes.to_dict()
-            if ia_dict:
-                d["IndividualAttributes"] = ia_dict
+            d["IndividualAttributes"] = self.individual_attributes.to_dict()
 
         if self.individual_properties:
             ip_dict = {"IndividualProperties": []}

{emod_api-3.2.1 → emod_api-3.2.2/emod_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: emod-api
-Version: 3.2.1
+Version: 3.2.2
 Summary: Core tools for modeling using EMOD
 Author-email: Sharon Chen <sharon.chen@gatesfoundation.org>, Zhaowei Du <zhaowei.du@gatesfoundation.org>, Clark Kirkman IV <clark.kirkmand@gatesfoundation.org>, Daniel Bridenbecker <daniel.bridenbecker@gatesfoundation.org>, Svetlana Titova <svetlana.titova@gatesfoundation.org>, Ye Chen <ye.chen@gatesfoundation.org>
 License-Expression: MIT

{emod_api-3.2.1 → emod_api-3.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "emod-api"
-version = "3.2.1"
+version = "3.2.2"
 description = "Core tools for modeling using EMOD"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -75,7 +75,7 @@ Issues = "https://github.com/EMOD-Hub/issues-and-discussions/issues"
 find = {include = ["emod_api*"]}
 
 [tool.bumpversion]
-current_version = "3.2.1"
+current_version = "3.2.2"
 commit = true
 
 [[tool.bumpversion.files]]

{emod_api-3.2.1 → emod_api-3.2.2}/tests/test_campaign_module.py

@@ -107,21 +107,21 @@ class TestCampaignWithSchema(unittest.TestCase):
             data = json.load(f)
         self.assertDictEqual(data, self.campaign.campaign_dict)
 
-    def test_get_custom_individual_events_builtin_excluded(self):
+    def test_validate_custom_individual_events_builtin_excluded(self):
         if not self.campaign.individual_builtin_events:
             self.skipTest("No individual builtin events in schema")
         builtin_event = self.campaign.individual_builtin_events[0]
         self.campaign.get_recv_trigger(builtin_event)
-        result = self.campaign.get_custom_individual_events()
+        result = self.campaign.validate_custom_individual_events()
         self.assertNotIn(builtin_event, result)
 
-    def test_get_custom_individual_events_broadcast_mirrors_builtin_warns(self):
+    def test_validate_custom_individual_events_broadcast_mirrors_builtin_warns(self):
         if not self.campaign.individual_builtin_events:
             self.skipTest("No individual builtin events in schema")
         builtin_event = self.campaign.individual_builtin_events[0]
         self.campaign.get_send_trigger(builtin_event)
         with self.assertWarns(UserWarning):
-            self.campaign.get_custom_individual_events()
+            self.campaign.validate_custom_individual_events()
 
     def test_set_schema_populates_node_builtin_events(self):
         if not self.campaign.node_builtin_events:
@@ -244,54 +244,54 @@ class TestValidateCustomEvents(unittest.TestCase):
     def test_individual_valid_pair(self):
         self.campaign.get_recv_trigger("CustomEvt")
         self.campaign.get_send_trigger("CustomEvt")
-        result = self.campaign.get_custom_individual_events()
+        result = self.campaign.validate_custom_individual_events()
         self.assertIn("CustomEvt", result)
 
     def test_individual_listened_not_broadcast_raises(self):
         self.campaign.get_recv_trigger("OrphanedEvt")
         with self.assertRaises(ValueError):
-            self.campaign.get_custom_individual_events()
+            self.campaign.validate_custom_individual_events()
 
     def test_individual_broadcast_not_listened_warns(self):
         self.campaign.get_send_trigger("UnlistenedEvt")
         with self.assertWarns(UserWarning):
-            self.campaign.get_custom_individual_events()
+            self.campaign.validate_custom_individual_events()
 
     # --- node ---
 
     def test_node_valid_pair(self):
         self.campaign.set_listened_node_event("NodeEvt")
         self.campaign.set_broadcast_node_event("NodeEvt")
-        result = self.campaign.get_custom_node_events()
+        result = self.campaign.validate_custom_node_events()
         self.assertIn("NodeEvt", result)
 
     def test_node_listened_not_broadcast_raises(self):
         self.campaign.set_listened_node_event("OrphanedNodeEvt")
         with self.assertRaises(ValueError):
-            self.campaign.get_custom_node_events()
+            self.campaign.validate_custom_node_events()
 
     def test_node_broadcast_not_listened_warns(self):
         self.campaign.set_broadcast_node_event("UnlistenedNodeEvt")
         with self.assertWarns(UserWarning):
-            self.campaign.get_custom_node_events()
+            self.campaign.validate_custom_node_events()
 
     # --- coordinator ---
 
     def test_coordinator_valid_pair(self):
         self.campaign.set_listened_coordinator_event("CoordEvt")
         self.campaign.set_broadcast_coordinator_event("CoordEvt")
-        result = self.campaign.get_custom_coordinator_events()
+        result = self.campaign.validate_custom_coordinator_events()
         self.assertIn("CoordEvt", result)
 
     def test_coordinator_listened_not_broadcast_raises(self):
         self.campaign.set_listened_coordinator_event("OrphanedCoordEvt")
         with self.assertRaises(ValueError):
-            self.campaign.get_custom_coordinator_events()
+            self.campaign.validate_custom_coordinator_events()
 
     def test_coordinator_broadcast_not_listened_warns(self):
         self.campaign.set_broadcast_coordinator_event("UnlistenedCoordEvt")
         with self.assertWarns(UserWarning):
-            self.campaign.get_custom_coordinator_events()
+            self.campaign.validate_custom_coordinator_events()
 
     # --- builtin filtering ---
 

{emod_api-3.2.1 → emod_api-3.2.2}/tests/test_node.py

@@ -93,7 +93,9 @@ class NodeTest(unittest.TestCase):
         node = Node(lat=0,lon=0,pop=100, individual_attributes=individual_attributes_1)
         self.assertEqual(node.to_dict()["IndividualAttributes"]["user_defined_2"], 2)
         node = Node(lat=0,lon=0,pop=100, individual_attributes=individual_attributes_2)
-        self.assertNotIn("IndividualAttributes", node.to_dict())
+        # EMOD requires IndividualAttributes in every node, even if empty
+        self.assertIn("IndividualAttributes", node.to_dict())
+        self.assertNotIn("user_defined_2", node.to_dict()["IndividualAttributes"])
 
         ips = [IndividualProperty(property='cloudy', values=["yes", "no"], initial_distribution=[0.5, 0.5])]
         individual_properties_1 = IndividualProperties(ips)
@@ -118,7 +120,9 @@ class NodeTest(unittest.TestCase):
         node_3 = Node(lat=1, lon=2, pop=100, node_attributes=node_attributes, individual_attributes=individual_attributes)
 
         self.assertEqual(node_1.to_dict()["NodeAttributes"]["Test_1"], 1)
-        self.assertTrue("IndividualAttributes" not in node_1.to_dict())
+        # EMOD requires IndividualAttributes in every node, even if empty
+        self.assertIn("IndividualAttributes", node_1.to_dict())
+        self.assertNotIn("Test_2", node_1.to_dict()["IndividualAttributes"])
 
         self.assertTrue("Test_1" not in node_2.to_dict()["NodeAttributes"])
         self.assertEqual(node_2.to_dict()["IndividualAttributes"]["Test_2"], 2)

emod_api-3.2.1/emod_api/__init__.py

@@ -1 +0,0 @@
-__version__ = "3.2.1"