[DEV-3152] Add EAS Python SDK methods for running opendss export by clydeu · Pull Request #30 · zepben/eas-client-python

clydeu · 2025-06-04T04:05:28Z

Description

Add client methods for running opendss export, listing the runs and getting a download url.

Associated tasks

https://github.com/zepben/evolve-app-server/pull/214

Test Steps

Explain in detail how your reviewer can test the changes proposed in this PR. If it cannot be tested, leave an explanation on why.

Checklist

If any of these are not applicable, strikethrough the line ~like this~. Do not delete it!. Let the reviewer decide if you should have done it.

Code

I have performed a self review of my own code (including checking issues raised when creating the PR).
I have added/updated unit tests for these changes, and if not I have explained why they are not necessary.
I have commented my code in any hard-to-understand or hacky areas.
I have handled all new warnings generated by the compiler or IDE.
I have rebased onto the target branch (usually main).

Documentation

I have updated the changelog.
I have updated any documentation required for these changes.

Breaking Changes

I have considered if this is a breaking change and will communicate it with other team members by posting it on the Slack breaking-changes channel.

No breaking change.

ryanjcoleman · 2025-06-04T04:05:33Z

Task linked: DEV-3152 Add EAS python sdk methods

charlta

Very quick once over, so just adding as comments. Will leave to others that can test it to give approval etc.

src/zepben/eas/client/eas_client.py

test/test_eas_client.py

chestm007 · 2025-06-19T03:06:20Z

src/zepben/eas/client/eas_client.py

+                    response = await response.text()
+                return response
+
+    def get_paged_opendss_models(self,


this is very much a nipick, feel free to ignore:

the format of this signature doesnt match init
ie: init has self on a newline, and all the args are indented only one spacing.

fixed in 62c36bc

chestm007 · 2025-06-19T03:06:37Z

src/zepben/eas/client/eas_client.py

+        """
+        return get_event_loop().run_until_complete(self.async_get_paged_opendss_models(limit, offset, query_filter, query_sort))
+
+    async def async_get_paged_opendss_models(self,


nit: as above

fixed in 62c36bc

chestm007 · 2025-06-19T03:09:11Z

src/zepben/eas/client/eas_client.py

+                    response = await response.text()
+                return response
+
+    def get_opendss_model_download_url(self, id: int):


nit: id is shadowing a built-in, perhaps run_id?

fixed in 62c36bc

chestm007 · 2025-06-19T03:09:28Z

src/zepben/eas/client/eas_client.py

+        """
+        return get_event_loop().run_until_complete(self.async_get_opendss_model_download_url(id))
+
+    async def async_get_opendss_model_download_url(self, id: int):


nit: id is shadowing a built-in, perhaps run_id?

fixed in 62c36bc

chestm007 · 2025-06-19T03:10:34Z

src/zepben/eas/client/opendss.py

@@ -0,0 +1,55 @@
+#  Copyright 2020 Zeppelin Bend Pty Ltd


copyright date, 2025?

oops. fixed in 2dfab29

chestm007 · 2025-06-19T03:15:18Z

test/test_eas_client.py

+            }
+        }
+    """
+


nit: missing blank line

fixed in 62c36bc

chestm007 · 2025-06-19T03:15:48Z

test/test_eas_client.py

+    assert actual_body['variables'] == { }
+
+    return Response(json.dumps({"result": "success"}), status=200, content_type="application/json")
+


nit: missing blank line

fixed in 62c36bc

chestm007 · 2025-06-19T03:15:53Z

test/test_eas_client.py

+        res = eas_client.get_paged_opendss_models()
+        httpserver.check_assertions()
+        assert res == {"result": "success"}
+


nit: missing blank line

fixed in 62c36bc

chestm007 · 2025-06-19T03:15:57Z

test/test_eas_client.py

+    res = eas_client.get_opendss_model_download_url(1)
+    httpserver.check_assertions()
+    assert res == "https://example.com/download/1"
+


nit: missing blank line

fixed in 62c36bc

chestm007 · 2025-06-19T03:19:29Z

src/zepben/eas/client/eas_client.py

                    response = await response.text()
                return response
+
+    def run_opendss_export(self, config: OpenDssConfig):


not a job for now and more of an observation then anything, but it almost feels like this file needs to be broken up. at >1000 lines its a little unwieldy - and has, in my opinion, alot of logic related to different components.

yeah would be nice if this was a client where you could see what it can do 😄

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

Signed-off-by: Roberto Marquez <roberto.marquez@zepben.com>

roberto-marquez

We need this for a deployment so it will get merged now. If anyone cares about the additional changes to this PR they can open a ticket in Clickup

clydeu force-pushed the DEV-3152-Add-EAS-python-sdk-methods-for-opendss-export branch from 493146a to 3fcfba2 Compare June 4, 2025 04:06

clydeu marked this pull request as ready for review June 4, 2025 04:53

clydeu requested review from a team and zarakay June 4, 2025 04:54

charlta reviewed Jun 5, 2025

View reviewed changes

src/zepben/eas/client/eas_client.py Show resolved Hide resolved

src/zepben/eas/client/eas_client.py Outdated Show resolved Hide resolved

test/test_eas_client.py Outdated Show resolved Hide resolved

test/test_eas_client.py Outdated Show resolved Hide resolved

clydeu requested a review from chestm007 June 19, 2025 02:04

chestm007 requested changes Jun 19, 2025

View reviewed changes

clydeu requested a review from chestm007 June 19, 2025 05:44

clydeu and others added 13 commits June 24, 2025 12:05

createOpendssModel

6070734

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

pagedOpenDssModels

20170ac

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

download url

808d5e4

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

use get method for download url route.

698309e

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

changelog.

111a69c

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

fix wordings.

f023810

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

change http status check to enum code for compatibility.

4537985

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

add timezone to OpenDssConfig.

bf0fb36

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

addressed Ant's comments.

ce2b415

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

addressed Max's comments.

4f37080

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

addressed Max's comments.

3eb86cc

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

addressed Max's comments.

ee068fd

Signed-off-by: clydeu <clyde.uyenghua@zepben.com>

Fixes after rebase.

2b14e65

Signed-off-by: Roberto Marquez <roberto.marquez@zepben.com>

roberto-marquez force-pushed the DEV-3152-Add-EAS-python-sdk-methods-for-opendss-export branch from f1f4c14 to 2b14e65 Compare June 24, 2025 02:08

roberto-marquez self-requested a review June 24, 2025 02:08

roberto-marquez approved these changes Jun 24, 2025

View reviewed changes

roberto-marquez merged commit 06c5947 into main Jun 24, 2025
5 checks passed

roberto-marquez deleted the DEV-3152-Add-EAS-python-sdk-methods-for-opendss-export branch June 24, 2025 02:12

clydeu mentioned this pull request Jun 26, 2025

[PROJ-6325] remove timezone info from python EAS client and add load overrides to run open-dss export #32

Merged

6 tasks

		assert actual_body['variables'] == { }

		return Response(json.dumps({"result": "success"}), status=200, content_type="application/json")

Conversation

clydeu commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Associated tasks

Test Steps

Checklist

Code

Documentation

Breaking Changes

Uh oh!

ryanjcoleman commented Jun 4, 2025

Uh oh!

charlta left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

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!

roberto-marquez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

clydeu commented Jun 4, 2025 •

edited

Loading