Support for Introspection API's by abhilash-kumar-nair · Pull Request #339 · modelon-community/impact-client-python

abhilash-kumar-nair · 2026-05-20T10:53:16Z

This PR adds support for introspecting the Model source, Model parameters, Top level packages and recursively look into their subpackages/models.

# Explore packages
print("Top level packages")
for package in ws.get_packages():
    print(f"  {package.name}")
    if package.name == "Unnamed":
        print("  Sub-packages:", package.get_sub_packages())
        print("  Sub-models:", package.get_sub_models())

# Inspect Model
model = ws.get_model("Unnamed.test")
print("Modelica source code")
print(model.get_source())

print("Model parameters")
print(model.get_parameters())

efredriksson-modelon

Looks really cool 🧇

I think the main thing is to have get_model on the modeling_session object and accept that workspace.get_model().get_source() will not work. Otherwise there are too many ways you can create issues and this also streamlines the design significantly.

I also wonder about the async vs sync websocket client connection, which might be good to take a look at.

efredriksson-modelon · 2026-05-21T12:01:57Z

+        self, uri: URI, http_client: HTTPClient, ws_client: SyncWebSocketClient
+    ):
+        self._base_uri = uri
+        self._http_client = http_client


Not used and can be removed?

efredriksson-modelon · 2026-05-21T12:02:50Z


 [tool.poetry.dependencies]
-python = "^3.8.0"
+python = ">=3.9.0,<3.12.0"


I think the upper limit should be 4.0. Adding the 3.12 limit can cause a lot of issues for downstream tooling.

efredriksson-modelon · 2026-05-21T12:22:57Z

+    def __del__(self) -> None:
+        if self._modeling_session is not None:
+            self._modeling_session.close_nowait()
+            self._modeling_session = None
+
+    def close(self) -> None:
+        """Close the modeling session WebSocket connection, if one was opened."""
+        if self._modeling_session is not None:
+            self._modeling_session.close()
+            self._modeling_session = None
+
+    def __enter__(self) -> "Workspace":
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()
+
+    def _get_modeling_session(self) -> ModelingSession:
+        if self._modeling_session is None:
+            modeling_service = self._sal.start_modeling_session(workspace_id=self.id)
+            self._modeling_session = ModelingSession(
+                modeling_service.id, self.id, modeling_service, self._sal
+            )
+        return self._modeling_session


This machinery adds a lot of hidden state and makes it easy for a user to setup things so things becomes unstable. I think that we should drop it and accept that the get_model on workspace does not have full functionality. This seems pretty minor given the reduced complexity.

efredriksson-modelon · 2026-05-21T12:29:08Z

        )

+    @Experimental
+    def get_parameters(self) -> List[str]:


Is this returning the parameter names? If we want to add things in the future (start value/nominals/...) it might we worth return list[ModelParameter] where ModelParameter have the attribute name.

efredriksson-modelon · 2026-05-21T12:32:50Z

+        return self._modeling_sal.close_session_nowait()
+
+    @Experimental
+    def get_model_parmeters(self, modelica_path: str) -> List[str]:


Same here on list[str]. But should we even have these methods? I would have expected something like:

model_session.get_model(class_path).get_parameters() model_session.get_model(class_path).get_source()

so we keep the API clean and give the user one way to do this.

efredriksson-modelon · 2026-05-21T12:40:46Z

+        """Returns the libraries the package has dependencies on."""
+        return self._info()["uses"]
+
+    def get_sub_models(self) -> List[Model]:


I don't think sub_models are a thing. I think this should just be called get_models.

efredriksson-modelon · 2026-05-21T12:43:00Z


+    @Experimental
+    @contextmanager
+    def start_modeling_session(self) -> Generator["ModelingSession", None, None]:


start_modeling_session -> new_modeling_session might read a little nicer and match our other naming, but feel free to ignore this.

efredriksson-modelon · 2026-05-21T12:45:16Z

+        _is_local_dev = (
+            os.environ.get("IMPACT_PYTHON_CLIENT_DEV", "false").lower() == "true"
+        )
+        scheme = "ws" if _is_local_dev else "wss"


Do we want to keep this in?

efredriksson-modelon · 2026-05-21T12:50:15Z

+        self._conn = await websockets.connect(
+            self._uri,
+            additional_headers=headers,
+        )  # type: ignore


I might be missing something here but you are creating an async connection and then you want to wrap it in a sync API? I have not tested it, but could we not use websockets.sync.client.connect directly?

efredriksson-modelon · 2026-05-21T12:52:38Z

+                "This Model instance has no modeling session. "
+                "Obtain the model via workspace.get_model() to enable get_parameters()."


Obtain the model via modeling_session.get_model, see workspace.new_model_session is what this would say.

abhilash-kumar-nair added 4 commits May 7, 2026 13:14

fix(deps): relock poetry dependencies

c02de10

fix: python minimum version requirement to 3.9 and relock dependencies

0681965

fix(deps): add websockets as a dependency

b864780

feat: add first cut of modeling server api support

06b6caf

abhilash-kumar-nair force-pushed the akn/feat/modeling-server-support branch from bd92a0e to 06b6caf Compare May 21, 2026 04:48

abhilash-kumar-nair changed the title ~~Akn/feat/modeling server support~~ Support for Introspection API's May 21, 2026

abhilash-kumar-nair requested review from efredriksson-modelon and hernrup-modelon May 21, 2026 04:55

efredriksson-modelon requested changes May 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Introspection API's#339

Support for Introspection API's#339
abhilash-kumar-nair wants to merge 4 commits into
masterfrom
akn/feat/modeling-server-support

abhilash-kumar-nair commented May 20, 2026 •

edited

Loading

Uh oh!

efredriksson-modelon left a comment

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

efredriksson-modelon May 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		"This Model instance has no modeling session. "
		"Obtain the model via workspace.get_model() to enable get_parameters()."

Conversation

abhilash-kumar-nair commented May 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

efredriksson-modelon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abhilash-kumar-nair commented May 20, 2026 •

edited

Loading