Repository navigation
Open
Labels
part:actorAffects an actor ot the actors utilities (decorator, etc.)Affects an actor ot the actors utilities (decorator, etc.)priority:highAddress this as soon as possibleAddress this as soon as possiblescope:breaking-changeBreaking change, users will need to update their codeBreaking change, users will need to update their codetype:enhancementNew feature or enhancement visitble to usersNew feature or enhancement visitble to users
Milestone
Description
What's needed?
We need to allow cloud applications to be able to write actors without depending on the microgrid.
Proposed solution
Split the frequenz.sdk.actor package to its own repository:
- We can use the
frequenz.actorpackage.See which namespace would be possible to use for the new python package:frequenz.actorwould be the natural choice, but it is still a namespace for the many actor packages.frequenz.actor.coreorfrequenz.actor.basemight be some options, although not that clear. Keepingfrequenz.sdk.actorcould be another option, but we need to see if it doesn't conflict withfrequenz.sdkliving in another package too. Another alternative could befrequenz.actors(in plural, as we already have withchannels), but that might be a bit confusing that we have bothfrequenz.actorandfrequenz.actorspackages. - Create the new repository
frequenz-actor-python - Move the code there
- Release a v1.0.0 version (we want to ensure stability from day one, as we are stabilizing all the base repos).
- Remove the code from the SDK and depend on the new repo
Use cases
All the cloud apps.
Alternatives and workarounds
For now we've been copying protobuf files from the common API repo to the API repos that should depend on common to break the dependency, but this is clearly not sustainable.
Additional context
This is a very complicated, multi-dimensional, problem, involving many parts. Is part (and one way) to solve the dependency conflict of the SDK depending on the microgrid API v0.15 (and common v0.4) and the new API clients depending on common v0.5.
Metadata
Metadata
Assignees
Labels
part:actorAffects an actor ot the actors utilities (decorator, etc.)Affects an actor ot the actors utilities (decorator, etc.)priority:highAddress this as soon as possibleAddress this as soon as possiblescope:breaking-changeBreaking change, users will need to update their codeBreaking change, users will need to update their codetype:enhancementNew feature or enhancement visitble to usersNew feature or enhancement visitble to users
Type
Fields
Priority
None yet
Projects
- StatusShow more project fieldsIn progress
Activity
shsms commentedon Jan 30, 2024
I like
frequenz.actor.base, because it is the base class for all actors. but works badly for namespaced importsfrom frequenz.actor import base.Maybe
frequenz.actor.actor_base?llucax commentedon Jan 30, 2024
Maybe, what about
frequenz.actor.actor? It is a bit redundant but it should work more naturally with the imports.I will try if there is any way to still use the
frequenz.actormodule, that is definitely the ideal, but I don´t have very high expectations to succeed.shsms commentedon Jan 30, 2024
it would be actor inception 3 levels deep:
llucax commentedon Feb 1, 2024
llucax commentedon Feb 1, 2024
I just did a test and we can use
frequenz.actor🎉As long as only one wheel is defining
frequenz/actor/__init__.pyit seems to be fine.18 remaining items
llucax commentedon Feb 13, 2025
This will probably not be possible, as actor = task + channels (even when the base class doesn't use channels, I guess eventually we'll want to tie them more explicitly), and we want to use
coreinchannels, it will introduce a circular dependency. So I see 2 solutions:Actorclass and just useServiceinstead until we really need to make an Actor anything else than a background task, and only create a new repo (and class) after that happens.