Skip to content

Expose Run.is_default in facade #153

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

Merged
glatterf42 merged 3 commits into from
Apr 29, 2025
Merged

Expose Run.is_default in facade #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54ff37c
Introduce run.clone()
glatterf42 Nov 29, 2024
91143dd
✨ feat: Expose run.is_default in facade layer
glatterf42 Jan 24, 2025
64b32ca
♻️ refactor: Make run.is_default a property
glatterf42 Apr 29, 2025
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
2 changes: 1 addition & 1 deletion doc/source/openapi-v1.json
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions ixmp4/core/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,20 @@ def meta(self) -> "RunMetaFacade":
def meta(self, meta: dict[str, PrimitiveTypes | np.generic | None]) -> None:
self._meta._set(meta)

@property
def is_default(self) -> bool:

@meksor meksor Apr 16, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
def is_default(self) -> bool:
@property
def is_default(self) -> bool:

@glatterf42 glatterf42 Apr 29, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, we can do that :)
Would we want this to be a read-only property or should this get a setter and deleter (that would then presumably call Run.set_as_default() and Run.unset_as_default())?

@glatterf42 glatterf42 Apr 29, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've not written setter and deleter for now since they are not required for the message_ix tutorials. If we want them at a later point, I propose a follow-up issue/PR.

We would likely want something of this sort:

@is_default.setter
def is_default(self, value: bool) -> None:
    if value:
        self.set_as_default()
    else:
        self.unset_as_default()

If it bothers us that mypy deems one test case as unreachable, we might want to set up an attribute _is_default and use is_default.setter to set that directly. Though even if is_default.getter simply returns the state of _is_default, mypy might not recognize this properly because it's hidden behind this extra layer.

@meksor meksor Apr 29, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I agree lets leave that for another time...

@glatterf42 glatterf42 Apr 29, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe @danielhuppmann can clarify whether we actually want that :)

@danielhuppmann danielhuppmann Apr 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think doing is_default as a property is a good idea, but I would stick with the more "functional" set_as_default() to change the status, to avoid confusion or making changes by accident.

return self._model.is_default

def set_as_default(self) -> None:
"""Sets this run as the default version for its `model` + `scenario`
combination."""
self.backend.runs.set_as_default_version(self._model.id)
self._model = self.backend.runs.get_by_id(self._model.id)

def unset_as_default(self) -> None:
"""Unsets this run as the default version."""
self.backend.runs.unset_as_default_version(self._model.id)
self._model = self.backend.runs.get_by_id(self._model.id)

def require_lock(self) -> None:
if not self.owns_lock:
Expand Down
11 changes: 11 additions & 0 deletions tests/core/test_run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,3 +319,14 @@ def test_run_clone(self, platform: ixmp4.Platform) -> None:
run = platform.runs.create("Model", "Scenario")
clone_without_iamc = run.clone()
assert clone_without_iamc.iamc.tabulate().empty

def test_run_is_default(self, platform: ixmp4.Platform) -> None:
run = platform.runs.create("Model", "Scenario")
assert run.is_default is False

run.set_as_default()
assert run.is_default

# Mypy doesn't know that set_as_default() reloads the underlying run._model
run.unset_as_default() # type: ignore[unreachable]
assert not run.is_default