Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the error message for unhydrated objects #1778

Merged
merged 6 commits into from
May 1, 2024
Merged

Improve the error message for unhydrated objects #1778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
26f3ab6
WIP
mwaskom Apr 17, 2024
2114fd8
Try to clarify unhydrated object exception
mwaskom Apr 30, 2024
559d6e5
Try to state when object is attached to app that is not running
mwaskom May 1, 2024
68c56b5
Improve hydration error message for parametric functions too
mwaskom May 1, 2024
80977c2
Add more robustness in the parameterized class error message
mwaskom May 1, 2024
5100598
Fix string syntax
mwaskom May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions modal/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,11 +680,18 @@ def from_parametrized(
"""mdmd:hidden"""

async def _load(self: _Function, resolver: Resolver, existing_object_id: Optional[str]):
try:
identity = f"base {self._parent.info.function_name} function"
except Exception:
# Can't always look up the function name that way, so fall back to generic message
identity = "base function for parameterized class"
if not self._parent.is_hydrated:
if self._parent.app._running_app is None:
reason = ", because the App it is defined on is not running."
else:
reason = ""
raise ExecutionError(
"Base function in class has not been hydrated. This might happen if an object is"
" defined on a different stub, or if it's on the same stub but it didn't get"
" created because it wasn't defined in global scope."
f"The {identity} has not been hydrated with the metadata it needs to run on Modal{reason}."
)
assert self._parent._client.stub
serialized_params = serialize((args, kwargs))
Expand Down
12 changes: 8 additions & 4 deletions modal/object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,15 @@ async def resolve(self):
if self._is_hydrated:
return
elif not self._hydrate_lazily:
object_type = self.__class__.__name__.strip("_")
if hasattr(self, "_app") and getattr(self._app, "_running_app", "") is None:
# The most common cause of this error: e.g., user called a Function without using App.run()
reason = ", because the App it is defined on is not running."
else:
# Technically possible, but with an ambiguous cause.
reason = ""
raise ExecutionError(
"Object has not been hydrated and doesn't support lazy hydration."
" This might happen if an object is defined on a different stub,"
" or if it's on the same stub but it didn't get created because it"
" wasn't defined in global scope."
f"{object_type} has not been hydrated with the metadata it needs to run on Modal{reason}."
)
else:
# TODO: this client and/or resolver can't be changed by a caller to X.from_name()
Expand Down
Loading