search

frequenz-floss / frequenz-dispatch-python

High-level interface to dispatch API
https://frequenz-floss.github.io/frequenz-dispatch-python/
MIT License
0 stars 3 forks source link

Initial structure #9

Closed Marenz closed 6 months ago

Marenz commented 7 months ago
shsms commented 6 months ago

Could you describe the motivation for this change? There's from frequenz import dispatch now? Aren't we only having namespace packages under frequenz like frequenz.{actor, client, api, etc} and putting code under that?

Or is this going to be a completely independent thing like frequenz.channels?

Marenz commented 6 months ago

The structure is a kind of experiment that luca suggested to me to try. Basically, as the user shouldn't interact directly with the actor, the high-level interface should just directly offer the dispatch arrived/is ready channels like shown in https://github.com/frequenz-io/frequenz-apps-draft/blob/main/dispatch_exec/dispatch.py

shsms commented 6 months ago

The structure is a kind of experiment that luca suggested to me to try. Basically, as the user shouldn't interact directly with the actor, the high-level interface should just directly offer the dispatch arrived/is ready channels like shown in https://github.com/frequenz-io/frequenz-apps-draft/blob/main/dispatch_exec/dispatch.py

Then maybe we keep frequenz.actor.dispatch as it is, and add frequenz.dispatch separately, such that frequenz.dispatch can eventually go into the SDK?

Either way, the reason for the change is not obvious at all, so it would be worth the effort to explain it in the commit message and in the PR description.

Marenz commented 6 months ago

I don't see it much as "change of structure", given that previously there was basically nothing except empty or dummy files ;)

Anyway, I found what I was missing. The structure change is an attempt to test the rewrite of the structure according to https://github.com/frequenz-floss/frequenz-sdk-python/wiki/APIs-stack-and-repositories-structure#completely-rewrite-of-the-structure

Marenz commented 6 months ago
shsms commented 6 months ago

Looks good to me.