Make all "constructors" take a client optional arg
#3669
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Copyright Modal Labs 2025 | ||
| from typing import Optional | ||
|
|
||
| from .client import _Client | ||
| from .config import config | ||
|
|
||
|
|
||
| class LoadContext: | ||
| """Encapsulates optional metadata values used during object loading. | ||
|
|
||
| This metadata is set during object construction and propagated through | ||
| parent-child relationships (e.g., App -> Function, Cls -> Obj -> bound methods). | ||
| """ | ||
|
|
||
| _client: Optional[_Client] = None | ||
|
Contributor
There was a problem hiding this comment. At a glance, it looks like @dataclass
class ResolvedContext:
client: _Client
environment_name: str
app_id: Optiona[str]I would even rename
Contributor
Author
There was a problem hiding this comment. Yeah that could be nice! One argument against would be if we think ahead to when the Resolver doesn't exist anymore and all contexts are just propagated from their "parents" explicitly (instead of using Making each property resolve individually would fix the case where we have loaders that may raise exceptions immediately without actually needing a functional context (like calling methods directly on un-instantiated classes). Maybe we should actually already make that change, e.g. having LoadContext have |
||
| _environment_name: Optional[str] = None | ||
| _app_id: Optional[str] = None | ||
|
|
||
| def __init__( | ||
| self, | ||
| *, | ||
| client: Optional[_Client] = None, | ||
| environment_name: Optional[str] = None, | ||
| app_id: Optional[str] = None, | ||
| ): | ||
| self._client = client | ||
| self._environment_name = environment_name | ||
| self._app_id = app_id | ||
|
|
||
| @property | ||
| def client(self) -> _Client: | ||
| assert self._client is not None | ||
| return self._client | ||
|
|
||
| @property | ||
| def environment_name(self) -> str: | ||
| assert self._environment_name is not None | ||
| return self._environment_name | ||
|
|
||
| @property | ||
| def app_id(self) -> Optional[str]: | ||
| return self._app_id | ||
|
|
||
| @classmethod | ||
| def empty(cls) -> "LoadContext": | ||
| """Create an empty LoadContext with all fields set to None. | ||
|
|
||
| Used when loading objects that don't have a parent context. | ||
| """ | ||
| return cls(client=None, environment_name=None, app_id=None) | ||
|
|
||
| def merged_with(self, parent: "LoadContext") -> "LoadContext": | ||
| """Create a new LoadContext with parent values filling in None fields. | ||
|
|
||
| Returns a new LoadContext without mutating self or parent. | ||
| Values from self take precedence over values from parent. | ||
| """ | ||
| return LoadContext( | ||
| client=self._client if self._client is not None else parent._client, | ||
| environment_name=self._environment_name if self._environment_name is not None else parent._environment_name, | ||
| app_id=self._app_id if self._app_id is not None else parent._app_id, | ||
| ) # TODO (elias): apply_defaults? | ||
|
|
||
| async def apply_defaults(self) -> "LoadContext": | ||
| """Infer default client and environment_name if not present | ||
|
|
||
| Returns a new instance (no in place mutation)""" | ||
|
|
||
| return LoadContext( | ||
| client=await _Client.from_env() if self._client is None else self.client, | ||
| environment_name=config.get("environment") if self._environment_name is None else self._environment_name, | ||
| app_id=self._app_id, | ||
| ) | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| def reset(self) -> "LoadContext": | ||
| self._client = None | ||
| self._environment_name = None | ||
| self._app_id = None | ||
| return self | ||
|
|
||
| async def in_place_upgrade( | ||
| self, client: Optional[_Client] = None, environment_name: Optional[str] = None, app_id: Optional[str] = None | ||
| ) -> "LoadContext": | ||
| """In-place set values if they aren't already set, or set default values | ||
|
|
||
| Intended for Function/Cls hydration specifically | ||
|
|
||
| In those cases, it's important to in-place upgrade/apply_defaults since any "sibling" of the function/cls | ||
| would share the load context with its parent, and the initial load context overrides may not be sufficient | ||
| since an `app.deploy()` etc could get arguments that set a new client etc. | ||
|
|
||
| E.g. | ||
| @app.function() | ||
| def f(): | ||
| ... | ||
|
|
||
| f2 = Function.with_options(...) | ||
|
|
||
| with app.run(client=...): # hydrates f and f2 at this point | ||
| ... | ||
| """ | ||
| self._client = self._client or client or await _Client.from_env() | ||
| self._environment_name = self._environment_name or environment_name or config.get("environment") | ||
| self._app_id = self._app_id or app_id | ||
| return self | ||
Uh oh!
There was an error while loading. Please reload this page.