The great refactor [EWB-4557] #43

chestm007 · 2025-08-20T00:53:38Z

Description

Attempt at de-duping, tidying, and a slight restructure. Alot of the query body is now self generated by the objects themselves, I think its easily extendable, but im probably biased.

Associated tasks

None.

Test Steps

any code that worked before, should work exactly the same aside from needing the eas_client constructor to be changed to include auth

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).

Security

When developing applications, use following guidelines for information security considerations:

Access to applications should be protected with security keys/tokens or usernames and passwords;
All sessions are encrypted if possible;
All application input is sanitised before being acted on (ie SQL statements, etc);
Log messages, and especially client-facing ones, must be handled securely and must not leak credentials information (internal URLs, passwords, tokens).

I have considered if this change impacts information security and made sure those impacts are handled.

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.

Please leave a summary of the breaking changes here and then post it on the Slack breaking-changes channel to notify the team about it.

EasClient will now need auth= passed with an auth object. either BaseAuthMethod or TokenAuth, this allows cleaner documenting of accepted constructor arguments.

kgreav · 2025-08-20T01:16:56Z

~~i think your changes were meant to be on ewb-network-routes?~~
haha bad troll... just saw your other PR

vincewhite

Not full review. Just random comments.

vincewhite · 2025-08-20T05:55:07Z

changelog.md

 ## [0.23.0] - UNRELEASED
 ### Breaking Changes
-* None.
+* EasClient will now need `auth=` passed with an auth object. either `BaseAuthMethod` or `TokenAuth`, this allows


This task should probably include the PR to update to this happy little repo: https://github.com/zepben/hosting-capacity-runner , maybe https://github.com/zepben/ewb-sdk-examples-python as well?

vincewhite · 2025-08-20T06:07:58Z

src/zepben/eas/client/eas_client.py


-    def get_hosting_capacity_calibration_run(self, id: str):
+    def get_hosting_capacity_calibration_run(self, id_: str) -> dict:


Probably has to be mentioned as a breaking change?

src/zepben/eas/client/auth_method.py

kgreav · 2025-08-20T12:59:54Z

src/zepben/eas/client/auth_method.py

+        :param client_id: The Auth0 client ID used to specify to the auth server which application to request a token for.
+        :param client_secret: The Auth0 client secret used for M2M authentication.
+        """
+        ...


what is this magic

allows you to define multiple combinations of var/types to pass to the non @overloaded init.
Makes type hinting pick up when people have put a bad combination of auth params that would throw an error anyway.

ryanjcoleman · 2025-08-25T01:53:49Z

Task linked: EWB-4557 Refactor eas-client-python so its not so repetitive/boilerplate

Signed-off-by: Max Chesterfield <[email protected]> tests pass Signed-off-by: Max Chesterfield <[email protected]>

Signed-off-by: Max Chesterfield <[email protected]>

vincewhite

half review, run out of time.

vincewhite · 2025-10-17T02:18:08Z

README.md

+from zepben.eas.client.auth_method import TokenAuth
+


Suggested change

from zepben.eas.client.auth_method import TokenAuth

vincewhite · 2025-10-17T02:56:25Z

src/zepben/eas/client/auth_method.py

+    json_serialiser=None
+
+
+class BaseAuthMethod:


Seems like this is actually the connection that an authenticated connection is an extension on top of? To connect to an EAS without authentication I'm still required to pass a auth = BaseAuthMethod(host = ...) since it holds the connection/EAS host details.

This also makes it less optional than is suggested in the eas_client.py

vincewhite · 2025-10-17T03:19:52Z

src/zepben/eas/client/eas_client.py

                elif not response.ok:
                    response.raise_for_status()

+    def _do_request(self):  # TODO: can this just be called once per run?


vincewhite · 2025-10-17T03:25:19Z

src/zepben/eas/client/eas_client.py

+                response.raise_for_status()
+
+    @catch_warnings
+    async def _do_get_request(self, *, run_id: int):  # TODO: Terrible name probably


At least there is a matching _do_post_request(), for _get_request_headers() you just have to hope _get doesn't refer to HTTP GET.

...but also this seems hardcoded to retrieve opendss-models so yeh...

vincewhite · 2025-10-17T03:31:42Z

src/zepben/eas/client/eas_client.py

        return get_event_loop().run_until_complete(self.async_get_opendss_model(model_id))

-    async def async_get_opendss_model(self, model_id: int):
+    async def async_get_opendss_model(self, model_id: int) -> dict:  # TODO: this logic should be hidden behind a generator


someone should update the backend to provide this functionality...

vincewhite · 2025-10-17T03:41:34Z

src/zepben/eas/client/util.py

+
+@dataclass
+class HostingCapacityDataclass(ABC):  # TODO: Another terrible name
+    _snake_to_camel_overrides = dict(


Is there anyway these can be tested to confirm someone didn't forget to add an override when they were adding new fields.

vincewhite · 2025-10-17T03:52:48Z

src/zepben/eas/client/eas_client.py

+    def __del__(self):
+        self.close()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+


I assume these call close when this the object is deleted/unneeded etc/used by other things. Should we be closing the session if it was passed into the eas client/would this be the least unexpected behaviour?

chestm007 requested review from Esaotuelr and vincewhite August 20, 2025 00:53

vincewhite requested changes Aug 20, 2025

View reviewed changes

kgreav reviewed Aug 20, 2025

View reviewed changes

chestm007 force-pushed the the-great-refactor branch from f720255 to b792cba Compare August 22, 2025 03:26

chestm007 changed the title ~~The great refactor~~ The great refactor [EWB-4557] Aug 25, 2025

chestm007 force-pushed the the-great-refactor branch 2 times, most recently from b3c5406 to 7fd17c8 Compare August 27, 2025 07:39

chestm007 force-pushed the the-great-refactor branch from 7fd17c8 to cc34b79 Compare September 18, 2025 04:33

chestm007 added 3 commits October 16, 2025 17:48

do the things

15e70bf

Signed-off-by: Max Chesterfield <[email protected]> tests pass Signed-off-by: Max Chesterfield <[email protected]>

Rebase after Jimmys changes.

38263eb

Signed-off-by: Max Chesterfield <[email protected]>

rebased, again, for the last time.

e0222db

Signed-off-by: Max Chesterfield <[email protected]>

chestm007 force-pushed the the-great-refactor branch from cc34b79 to e0222db Compare October 16, 2025 07:06

vincewhite requested changes Oct 17, 2025

View reviewed changes


		def get_hosting_capacity_calibration_run(self, id: str):
		def get_hosting_capacity_calibration_run(self, id_: str) -> dict:

The great refactor [EWB-4557] #43

Are you sure you want to change the base?

The great refactor [EWB-4557] #43

Uh oh!

Conversation

chestm007 commented Aug 20, 2025 • edited by vincewhite Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Associated tasks

Test Steps

Checklist

Code

Security

Documentation

Breaking Changes

Uh oh!

kgreav commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vincewhite 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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryanjcoleman commented Aug 25, 2025

Uh oh!

vincewhite 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chestm007 commented Aug 20, 2025 •

edited by vincewhite

Loading

kgreav commented Aug 20, 2025 •

edited

Loading