Merge pull request #952 from linsword13/object-imp

Support import same-directory sources from an object file

Author: rfbgo

lib/ramble/ramble/repository.py

@@ -1493,6 +1493,13 @@ def __init__(self, fullname, repo, object_name):
         self.fullname = fullname
         super().__init__(self.fullname, self.object_py, prepend=self._object_prepend)
 
+    def is_package(self, fullname):
+        parent_dir = os.path.dirname(self.path)
+        # Use the presence of __init__.py to determine if load it as a package.
+        # TODO: since every Ramble object already has a containing directory,
+        # it might make sense to treat all of them as python packages.
+        return os.path.isfile(os.path.join(parent_dir, "__init__.py"))
+
 
 class RepositoryNamespaceLoader:
     def create_module(self, spec):

lib/ramble/ramble/test/end_to_end/object_import.py

@@ -0,0 +1,46 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+import os
+
+import pytest
+
+import ramble.workspace
+from ramble.main import RambleCommand
+
+pytestmark = pytest.mark.usefixtures(
+    "mutable_config", "mutable_mock_workspace_path", "mutable_mock_apps_repo"
+)
+
+workspace = RambleCommand("workspace")
+
+
+def test_object_import_separate_python_source(request):
+    ws_name = request.node.name
+    ws = ramble.workspace.create(ws_name)
+    global_args = ["-w", ws_name]
+
+    workspace(
+        "manage",
+        "experiments",
+        "import-test",
+        "-v",
+        "n_nodes=1",
+        "-v",
+        "processes_per_node=1",
+        global_args=global_args,
+    )
+
+    workspace("setup", global_args=global_args)
+
+    rendered_script = os.path.join(
+        ws.experiment_dir, "import-test", "test", "generated", "execute_experiment"
+    )
+    with open(rendered_script) as f:
+        content = f.read()
+        assert "echo 1" in content

var/ramble/repos/builtin.mock/applications/import-test/__init__.py

@@ -0,0 +1,9 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+# An empty file to signal to the loader that this is a Python package.

var/ramble/repos/builtin.mock/applications/import-test/application.py

@@ -0,0 +1,27 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+from ramble.app.builtin.mock.import_test import helpers
+from ramble.appkit import *
+
+
+class ImportTest(ExecutableApplication):
+    """An example application that imports a module"""
+
+    name = "import-test"
+
+    tags("test-app")
+
+    executable(
+        "test",
+        helpers.get_test_executable(),
+        use_mpi=False,
+        output_capture=OUTPUT_CAPTURE.ALL,
+    )
+
+    workload("test", executable="test")

var/ramble/repos/builtin.mock/applications/import-test/helpers.py

@@ -0,0 +1,11 @@
+# Copyright 2022-2025 The Ramble Authors
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+
+def get_test_executable():
+    return "echo 1"