sierra-research 1.3.6__py3-none-any.whl → 1.5.0__py3-none-any.whl

sierra/core/variables/base_variable.py

@@ -9,16 +9,14 @@ import typing as tp
 import implements
 
 # Project packages
-from sierra.core.experiment import xml
+from sierra.core.experiment import definition
 
 
 class IBaseVariable(implements.Interface):
-    """Interface that all variables must implement.
+    """Interface that all variables must implement."""
 
-    """
-
-    def gen_attr_changelist(self) -> tp.List[xml.AttrChangeSet]:
-        """Generate XML attributes to change in a batch experiment definition.
+    def gen_attr_changelist(self) -> tp.List[definition.AttrChangeSet]:
+        """Generate expdef attributes to change in a batch experiment definition.
 
         Modifications are sets, one per experiment in the batch, because the
         order you apply them doesn't matter.
@@ -26,8 +24,8 @@ class IBaseVariable(implements.Interface):
         """
         raise NotImplementedError
 
-    def gen_tag_rmlist(self) -> tp.List[xml.TagRmList]:
-        """Generate XML tags to remove from the batch experiment definition.
+    def gen_tag_rmlist(self) -> tp.List[definition.ElementRmList]:
+        """Generate expdef tags to remove from the batch experiment definition.
 
         Modifications are lists, one per experiment in the batch, because the
         order you apply them matters.
@@ -35,8 +33,8 @@ class IBaseVariable(implements.Interface):
 
         raise NotImplementedError
 
-    def gen_tag_addlist(self) -> tp.List[xml.TagAddList]:
-        """Generate XML tags to add to the batch experiment definition.
+    def gen_element_addlist(self) -> tp.List[definition.ElementAddList]:
+        """Generate expdef elelemnts to add to the batch experiment definition.
 
         Modifications are lists, one per experiment in the batch, because the
         order you apply them matters.
@@ -44,14 +42,11 @@ class IBaseVariable(implements.Interface):
         raise NotImplementedError
 
     def gen_files(self) -> None:
-        """Generate one or more new files to add to the batch experiment definition.
-
-        Presumably, the created files will be referenced in the template input
-        file by path.
+        """Generate files to add to the batch experiment definition.
 
+        Presumably, the created files will be referenced in the
+        ``--expdef-template`` file by path.
         """
 
 
-__api__ = [
-    'IBaseVariable'
-]
+__all__ = ["IBaseVariable"]