Skip to content

Backport 0.5.1's run_gui function #99

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
merged 1 commit into from
Nov 2, 2024
Merged

Backport 0.5.1's run_gui function #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions src/ManualClient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,18 @@ def on_tracker_events(self, events: list[str]):
if events:
self.ui.update_tracker_and_locations_table(update_highlights=True)

def run_gui(self):
"""Import kivy UI system from make_gui() and start running it as self.ui_task."""
if hasattr(SuperContext, "make_gui"):
Copy link
Contributor

Choose a reason for hiding this comment

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

How did we all miss that this if statement is backwards. We're checking if the context has make_gui then running the opposite

Copy link
Collaborator

Choose a reason for hiding this comment

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

I read this as: If the SuperContext has make_gui (i.e., we detected that we're in 0.5.1 RC or beyond), just call the parent's run_gui instead of doing our custom run_gui stuff. Since our custom run_gui is only needed for prior to RC. RC will call our make_gui instead of run_gui and expect a UI in response, so we don't want to override the parent run_gui anymore in that case.

Then, since we initially moved our old run_gui code into make_gui, anything prior to RC will -- via this backported run_gui method -- just call our stuff in make_gui (which was previously our run_gui code) to get a UI object, then run the old run_gui async.

I haven't tested the code, though, so can't attest whether it fixes the issue or not. Just appears to.

Copy link
Collaborator Author

@silasary silasary Nov 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Fuzzy Is correct.
If CommonContext has a make_gui, it's 0.5.1+, and we run it's run_gui.
If it doesn't have it, we run the below code, which is a copy of 0.5.1RC1's run_gui.

The reason I did it this way is so it doesn't override potential bugfixes or upgrades to the function in the future.

Copy link
Contributor

@axxroytovu axxroytovu Nov 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Attempting to actually run this on 0.5.0 gives this error

Traceback (most recent call last):
  File "multiprocessing\process.py", line 314, in _bootstrap
  File "multiprocessing\process.py", line 108, in run
  File "C:\ProgramData\Archipelago\custom_worlds\src.apworld\src\ManualClient.py", line 758, in launch
    asyncio.run(main(args))
  File "asyncio\runners.py", line 190, in run
  File "asyncio\runners.py", line 118, in run
  File "asyncio\base_events.py", line 653, in run_until_complete
  File "C:\ProgramData\Archipelago\custom_worlds\src.apworld\src\ManualClient.py", line 734, in main
    ctx.run_gui()
  File "C:\ProgramData\Archipelago\custom_worlds\src.apworld\src\ManualClient.py", line 224, in run_gui
    ui_class = self.make_gui()
               ^^^^^^^^^^^^^^^
  File "C:\ProgramData\Archipelago\custom_worlds\src.apworld\src\ManualClient.py", line 229, in make_gui
    ui = super().make_gui()  # before the kivy imports so kvui gets loaded first
         ^^^^^^^^^^^^^^^^
AttributeError: 'super' object has no attribute 'make_gui'

Copy link
Contributor

Choose a reason for hiding this comment

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

Manual build was on source as of today
Universal Tracker is v0.1.11 - the latest build that is functional on 0.5.0

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah. yep. That's on me for not testing well enough.

# Call the real one if it exists
return super().run_gui()

# This is a copy of 0.5.1's run_gui, because backporting is easier than the alternative.
# This entire function can be removed once 0.5.1 is the old enough.
ui_class = self.make_gui()
self.ui = ui_class(self)
self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")

def make_gui(self) -> typing.Type["kvui.GameManager"]:
ui = super().make_gui() # before the kivy imports so kvui gets loaded first

Expand Down