Add imports to Configuration

Author: LourensVeen

ymmsl/conversion/convert_v0_1_to_v0_2.py

@@ -25,7 +25,8 @@ def convert_v0_1_to_v0_2(config: v0_1.PartialConfiguration) -> v0_2.Configuratio
     resume = deepcopy(config.resume)
 
     return v0_2.Configuration(
-            description, model, settings, programs, resources, checkpoints, resume)
+            description, None, model, settings, programs, resources, checkpoints,
+            resume)
 
 
 def convert_component(component: v0_1.Component) -> v0_2.Component:

ymmsl/io.py

@@ -25,8 +25,9 @@
         v0_1_MulticastConduit,
         v0_2.BaseEnv, v0_2.CheckpointRangeRule, v0_2.CheckpointAtRule,
         v0_2.CheckpointRule, v0_2.Checkpoints, v0_2.Component, v0_2.Configuration,
-        v0_2.Document, v0_1.ExecutionModel, v0_2.Identifier, v0_2.KeepsStateForNextUse,
-        v0_2.Model, v0_2.MPICoresResReq, v0_2.MPINodesResReq, v0_2.Ports, v0_2.Program,
+        v0_2.Document, v0_1.ExecutionModel, v0_2.Identifier, v0_2.ImportKind,
+        v0_2.ImportStatement, v0_2.KeepsStateForNextUse, v0_2.Model,
+        v0_2.MPICoresResReq, v0_2.MPINodesResReq, v0_2.Ports, v0_2.Program,
         v0_2.Reference, v0_2.ResourceRequirements, v0_2.Settings, v0_2.ThreadedResReq)
 
 

ymmsl/v0_2/__init__.py

@@ -1,5 +1,6 @@
 from ymmsl.v0_2.checkpoint import (
         CheckpointRule, CheckpointRangeRule, CheckpointAtRule, Checkpoints)
+from ymmsl.v0_2.imports import ImportKind, ImportStatement
 from ymmsl.v0_2.ports import Operator, Port, Ports
 from ymmsl.v0_2.program import BaseEnv, ExecutionModel, KeepsStateForNextUse
 from ymmsl.v0_2.identity import Identifier, Reference, ReferencePart
@@ -18,8 +19,8 @@
 __all__ = [
         'BaseEnv', 'CheckpointRule', 'CheckpointRangeRule', 'CheckpointAtRule',
         'Checkpoints', 'Component', 'Ports', 'Conduit', 'Configuration', 'Document',
-        'ExecutionModel', 'Identifier', 'Implementation', 'KeepsStateForNextUse',
-        'Model', 'MPICoresResReq', 'MPINodesResReq', 'Operator', 'Port', 'Ports',
-        'Program', 'Reference', 'ReferencePart', 'ResourceRequirements', 'Settings',
-        'SettingValue', 'ThreadedResReq'
-        ]
+        'ExecutionModel', 'Identifier', 'Implementation', 'ImportKind',
+        'ImportStatement', 'KeepsStateForNextUse', 'Model', 'MPICoresResReq',
+        'MPINodesResReq', 'Operator', 'Port', 'Ports', 'Program', 'Reference',
+        'ReferencePart', 'ResourceRequirements', 'Settings', 'SettingValue',
+        'ThreadedResReq']

ymmsl/v0_2/configuration.py

@@ -10,6 +10,7 @@
 from ymmsl.v0_2.checkpoint import Checkpoints
 from ymmsl.v0_2.resources import ResourceRequirements
 from ymmsl.v0_2.identity import Reference
+from ymmsl.v0_2.imports import ImportStatement
 from ymmsl.v0_2.settings import Settings
 from ymmsl.v0_2.document import Document
 from ymmsl.v0_2.implementation import Implementation
@@ -25,6 +26,7 @@ class Configuration(Document):
 
     Attributes:
         description: A human-readable description of the configuration
+        imports: A list of import statements
         models: A list of possibly connected models to run
         settings: Settings to run the models with
         programs: Programs to use to run the model. Dictionary mapping program names (as
@@ -36,6 +38,7 @@ class Configuration(Document):
     """
     def __init__(
             self, description: str,
+            imports: Optional[Sequence[ImportStatement]] = None,
             models: Optional[Union[Model, Sequence[Model]]] = None,
             settings: Optional[Settings] = None,
             programs: Optional[Union[
@@ -54,15 +57,20 @@ def __init__(
 
         Args:
             description: Human-readable description
+            imports: A list of import statements
+            models: A list of possibly connected models to run
             settings: Settings to run the model with.
+            programs: Programs to use when running the model
             resources: Resources to allocate for the model components.
             checkpoints: When each component should create a snapshot
             resume: What snapshot each component should resume from
-
         """
         self.description = description
 
-        # TODO: imports
+        if imports is None:
+            self.imports: List[ImportStatement] = list()
+        else:
+            self.imports = list(imports)
 
         if models is None:
             self.models: Sequence[Model] = list()
@@ -131,6 +139,8 @@ def check_consistent(self) -> None:
 
                 # TODO: check that resources and implementation both do or don't MPI
 
+        # TODO: no two implementations (programs or models) with the same name
+
         if errors:
             raise RuntimeError(
                     'The configuration is internally inconsistent. The following'
@@ -151,6 +161,12 @@ def update(self, overlay: 'Configuration') -> None:
         elif overlay.description:
             self.description += '\n\n' + overlay.description
 
+        if not self.imports:
+            self.imports = overlay.imports
+        else:
+            if overlay.imports:
+                self.imports.extend(overlay.imports)
+
         if self.models and overlay.models:
             raise RuntimeError(
                     'Multiple ymmsl files containing models specified. Please'
@@ -267,6 +283,10 @@ def _yatiml_sweeten(cls, node: yatiml.Node) -> None:
             # output multi-line string in literal mode
             cast(yaml.ScalarNode, descr.yaml_node).style = '|'
 
+        imports = node.get_attribute('imports')
+        if imports.is_sequence() and imports.is_empty():
+            node.remove_attribute('imports')
+
         models = node.get_attribute('models')
         if models.is_sequence() and models.is_empty():
             node.remove_attribute('models')

ymmsl/v0_2/tests/conftest.py

@@ -67,7 +67,7 @@ def test_config4() -> Configuration:
               Ref('bf2smc'): Path('/path/to/snapshots/bf2smc.pack')}
 
     return Configuration(
-            description, None, None, None, resources, checkpoints, resume)
+            description, None, None, None, None, resources, checkpoints, resume)
 
 
 @pytest.fixture
@@ -156,7 +156,7 @@ def test_config6() -> Configuration:
             MPINodesResReq(Reference('submodel.mpi_nodes1'), 10, 16),
             MPINodesResReq(Reference('submodel.mpi_nodes2'), 10, 4, 4)]
 
-    return Configuration('config6', [model1, model2], None, None, resources)
+    return Configuration('config6', None, [model1, model2], None, None, resources)
 
 
 @pytest.fixture
@@ -166,7 +166,7 @@ def test_config7() -> Configuration:
             'missing_resources', None, [Component('singlethreaded', Ports(), 'b')])
     resources = [ThreadedResReq(Ref('got_resources.singlethreaded'), 1)]
 
-    return Configuration('test_config7', [model1, model2], None, None, resources)
+    return Configuration('test_config7', None, [model1, model2], None, None, resources)
 
 
 @pytest.fixture
@@ -205,7 +205,7 @@ def test_config8() -> Configuration:
             MPICoresResReq(Reference('impl_with_ports'), 4, 4),
             ]
 
-    return Configuration('config8', [model1, model2], None, programs, resources)
+    return Configuration('config8', None, [model1, model2], None, programs, resources)
 
 
 @pytest.fixture
@@ -250,4 +250,4 @@ def test_config9() -> Configuration:
             ThreadedResReq(Reference('impl_extra_ports'), 1),
             ]
 
-    return Configuration('config9', [model1, model2], None, programs, resources)
+    return Configuration('config9', None, [model1, model2], None, programs, resources)