make sample_name a property of sample instead

pepkit · May 21, 2024 · f1bd23f · f1bd23f
1 parent d68d31e
commit f1bd23f
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/peppy/project.py b/peppy/project.py
@@ -660,9 +660,6 @@ def _assert_samples_have_names(self):
                     )
                 else:
                     raise InvalidSampleTableFileException(message)
-            else:
-                if self.st_index != SAMPLE_NAME_ATTR:
-                    sample[SAMPLE_NAME_ATTR] = self.st_index
 
     def _auto_merge_duplicated_names(self):
         """

diff --git a/peppy/sample.py b/peppy/sample.py
@@ -302,6 +302,16 @@ def project(self):
         """
         return self[PRJ_REF]
 
+    @property
+    def sample_name(self):
+        """
+        Get the sample's name
+
+        :return str: current sample name derived from project's st_index
+        """
+
+        return self[self[PRJ_REF].st_index]
+
     # The __reduce__ function provides an interface for
     # correct object serialization with the pickle module.
     def __reduce__(self):

diff --git a/tests/test_Project.py b/tests/test_Project.py
@@ -331,7 +331,7 @@ def test_sample_name_custom_index(self, example_pep_cfg_custom_index):
         """
         p = Project(cfg=example_pep_cfg_custom_index)
         assert p.sample_name_colname == "NOT_SAMPLE_NAME"
-        assert p.samples[0].sample_name == "NOT_SAMPLE_NAME"
+        assert p.samples[0].sample_name == "frog_1"
 
     @pytest.mark.parametrize(
         "example_pep_cfg_path",