Core: typing for `Option.default` and a few other ClassVars #2899

beauxq · 2024-03-05T00:20:24Z

What is this fixing or adding?

typing for Option.default and a few other Option class variables

This is a replacement for #2173

You can read discussion there for issues we found for why we can't have more specific typing on default

instead of setting a default in Option (where we don't know the type), we check in the metaclass to make sure they have a default.

How was this tested?

unit tests
and I went through a bunch of worlds where I thought this mypy bug python/mypy#10506 might appear again, ~~and it looks like this avoids the bug~~
~~This mypy bug is still there, but I don't think it's worth it to make a mess of our core annotations trying to work around it.~~
Removing the NumericOption annotation makes it go away.

…ables This is a replacement for ArchipelagoMW#2173 You can read discussion there for issues we found for why we can't have more specific typing on `default` instead of setting a default in `Option` (where we don't know the type), we check in the metaclass to make sure they have a default.

…py bug

Jouramie

Just nitpicking, code LGTM!

Jouramie · 2024-03-06T03:02:45Z

Options.py

@@ -96,7 +101,7 @@ def meta__init__(self, *args, **kwargs):

 class Option(typing.Generic[T], metaclass=AssembleOptions):
    value: T
-    default = 0
+    default: typing.ClassVar[typing.Any]  # something that __init__ will be able to convert to the correct type


It feels counterintuitive to a different type for the default than T, but since most default values are immutable or literal "random" whereas T is not, I think it makes sense. 👍

Jouramie · 2024-03-06T03:05:38Z

Options.py

@@ -803,7 +811,7 @@ def verify(self, world: typing.Type[World], player_name: str, plando_options: "P


 class OptionDict(Option[typing.Dict[str, typing.Any]], VerifyKeys, typing.Mapping[str, typing.Any]):
-    default: typing.Dict[str, typing.Any] = {}
+    default = {}


I get that the default value was not changed, only the type removed, but shouldn't that default default value be something immutable? For safety measure.

It has been considered and discussed in the past. If it were as simple and straightforward as OptionList and OptionSet, I think it would have been done before.
But yeah, that's out of scope for this PR.

Jouramie · 2024-03-06T03:09:24Z

Options.py

@@ -844,7 +852,7 @@ class OptionList(Option[typing.List[typing.Any]], VerifyKeys):
    # If only unique entries are needed and input order of elements does not matter, OptionSet should be used instead.
    # Not a docstring so it doesn't get grabbed by the options system.

-    default: typing.Union[typing.List[typing.Any], typing.Tuple[typing.Any, ...]] = ()
+    default = ()


Why not keep the more precises types? This could be typing.ClassVar[typing.Iterable[str]] for instance?

Nvm, I should have read #2173 before commenting. All good 👍

black-sliver

Changed types lgtm (did not compare mypy error count yet), but see below for one suggestion.

Options.py

black-sliver · 2024-03-12T20:09:04Z

Hm, this fixes 3 errors in Options.py, but running mypy on worlds/soe/options.py shows 2 new errors. Do you have any idea why? I don't get it.

beauxq · 2024-03-12T20:47:53Z

Hm, this fixes 3 errors in Options.py, but running mypy on worlds/soe/options.py shows 2 new errors. Do you have any idea why? I don't get it.

dd2774f

The ClassVar in Option was conflicting with the instance var in the protocols.

black-sliver · 2024-03-12T20:58:02Z

Ah, makes sense. Somehow I didn't think about that at all.

black-sliver

Thanks!

There are still a bunch of (other) typing errors, but I think for default this is probably as good as it gets until we get mypy/typing updates (or switch to something else). It being a ClassVar now makes me happy, even if i forgot about the protocol being "wrong".

…agoMW#2899) * Core: typing for `Option.default` and a few other `Option` class variables This is a replacement for ArchipelagoMW#2173 You can read discussion there for issues we found for why we can't have more specific typing on `default` instead of setting a default in `Option` (where we don't know the type), we check in the metaclass to make sure they have a default. * NumericOption doesn't need the type annotation that brings out the mypy bug * SoE default ClassVar

@TheLX5

…pelagoMW#2922) * remove component checking * fix missing deathlink messages * move reads under deathlink check Core: Fix OptionList and OptionSet to allow Iterable of Iterable (ArchipelagoMW#2911) * fix, maybe * typegard for iterable of any * wow I'm so tired I just changed the method name without changing what it actually does... * also exclude bytes in is_iterable_but_str * apply pr comments * Update Utils.py Co-authored-by: Doug Hoskisson <[email protected]> * Revert "also exclude bytes in is_iterable_but_str" This reverts commit cf087d2. --------- Co-authored-by: Doug Hoskisson <[email protected]> Docs: Added snes9x-nwa as recommended emulator to the setup guides for SNES games (ArchipelagoMW#1778) * Added snes9x-nwa as recommended emulator to the setup guides * Removed snes9x-nwa from the setup guides of DKC3 and SMW * Update worlds/alttp/docs/multiworld_en.md Co-authored-by: Aaron Wagener <[email protected]> * Removed duplicate text Minor grammar and spelling fixes * Unified required software for SM, SMZ3 and SoE with ALTTP * Added instructions for usage of BSNES-Plus for ALTTP, SM and SMZ3 --------- Co-authored-by: Aaron Wagener <[email protected]> KH2: Update all instances of multiworld.option_name to option.option_name (ArchipelagoMW#2634) * update the multiworld to options * Update worlds/kh2/Rules.py Co-authored-by: Exempt-Medic <[email protected]> * does this work * namine sketches * wrong branch :) --------- Co-authored-by: Exempt-Medic <[email protected]> The Messenger: fix items accessibility reachability bug due to new rules (ArchipelagoMW#2937) CI: Don't auto-remove content based labels (ArchipelagoMW#2941) Docs: improve AutoWorld method docstrings (ArchipelagoMW#2509) * clarify some autoworld docstrings * revert accidental change The Witness: Don't unnecessarily break people's 0.4.4 yamls (ArchipelagoMW#2940) kvui: allow sorting hints in the hint tab (ArchipelagoMW#2684) MultiServer: send new read_hints datastore values on change (ArchipelagoMW#2558) The Witness: Obelisk Keys (ArchipelagoMW#2805) Core: String comparison with FreeText class (ArchipelagoMW#2942) CommonClient: use rich text for /received (ArchipelagoMW#2715) CommonClient: Fix item link group name when member slot name contains brackets (ArchipelagoMW#2794) SMW: v2.0 Content Update (ArchipelagoMW#2762) Changelog: Features: - New optional Location Checks - 3-Up Moons - Hidden 1-Ups - Bonus Blocks - Blocksanity - All blocks that contain coins or items are included, with the exception of: - Blocks in Top Secret Area & Front Door/Bowser Castle - Blocks that are unreachable without glitches/unreasonable movement - New Items - Special Zone Clear - New Filler Items - 1 Coin - 5 Coins - 10 Coins - 50 Coins - New Trap Items - Reverse Trap - Thwimp Trap - SFX Shuffle - Palette Shuffle Overhaul - New Curated Palette can now be used for the Overworld and Level Palette Shuffle options - Foreground and Background Shuffle options have been merged into a single setting - Max possible Yoshi Egg value is 255 - UI in-game is updated to handle 3-digits - New `Display Received Item Popups` option: `progression_minus_yoshi_eggs` Quality of Life: - In-Game Indicators are now displayed on the map screen for location checks and received items - In-level sprites are displayed upon receiving certain items - The Camera Scroll unlocking is now only enabled on levels where it needs to be - SMW can now handle receiving more than 255 items - Significant World Code cleanup - New Options API - Removal of `world: MultiWorld` across the world - The PopTracker pack now has tabs for every level/sublevel, and can automatically swap tabs while playing if connected to the server Bug Fixes: - Several logic tweaks/fixes "Major credit to @TheLX5 for being the driving force for almost all of this update. We've been collaborating on design and polish of the features for the last few months, but all of the heavy lifting was all @TheLX5." Core: typing for `Option.default` and a few other ClassVars (ArchipelagoMW#2899) * Core: typing for `Option.default` and a few other `Option` class variables This is a replacement for ArchipelagoMW#2173 You can read discussion there for issues we found for why we can't have more specific typing on `default` instead of setting a default in `Option` (where we don't know the type), we check in the metaclass to make sure they have a default. * NumericOption doesn't need the type annotation that brings out the mypy bug * SoE default ClassVar Core: add list/dict merging feature to triggers (ArchipelagoMW#2793) * proof of concept * add dict support, block top/game level merge * prevent key error when option being merged is new * update triggers guide * Add documentation about add/remove/replace * move to trailing name instead of proper tag * update docs * confirm types * Update Utils.py * Update Generate.py * pep8 * move to + syntax * forgot to support sets * specify received type of type error * Update Generate.py Co-authored-by: Fabian Dill <[email protected]> * Apply suggestion from review * add test for update weights * move test to new test case * Apply suggestions from code review Co-authored-by: black-sliver <[email protected]> --------- Co-authored-by: Fabian Dill <[email protected]> Co-authored-by: black-sliver <[email protected]> CI: build: create setup (ArchipelagoMW#2936) * CI: build: create setup also add /DNO_SIGNTOOL to inno_setup.iss * CI: build: trigger when changing setup-related files Shivers: Renaming for clarity and consistency (ArchipelagoMW#2869) * Moves plaque location to front for better tracker referencing. * Tiki should be Shaman. * Hanging should be Gallows. * Merrick spelling. * Clarity change. FFMQ: Update Map Shuffle Seed description (ArchipelagoMW#2658) * Update Map Shuffle Seed description * Update worlds/ffmq/Options.py Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]> Core: fix incorrect ordering on the always_allow static method (ArchipelagoMW#2938) CI: update actions (ArchipelagoMW#2943) HK: Removes Vanilla Items from ItemPool and Uses Grimmchild1 when relevant (ArchipelagoMW#2898) KDL3: Ensure all abilities accessible on non-minimal (ArchipelagoMW#2929) Pokemon Emerald: v2 Update (ArchipelagoMW#2918) Core: add layer for patches that don't use `Patch.py` (ArchipelagoMW#2889) * Core: add layer for patches that don't use `Patch.py` * bump container version * APAutoPatchInterface name * mystic quest change * OoT and Adventure changes * missed name in docstring * container version compatibility Lingo: Pre-compile datafile to improve loading time (ArchipelagoMW#2829) CommonClient: Don't retry connection when connection details are invalid (ArchipelagoMW#2831) Stardew Valley: 5.x.x - The Allsanity Update (ArchipelagoMW#2764) Major Content update for Stardew Valley, including the following features - Major performance improvements all across the Stardew Valley apworld, including a significant reduction in the test time - Randomized Farm Type - Bundles rework (Remixed Bundles and Missing Bundle!) - New Settings: * Shipsanity - Shipping individual items * Monstersanity - Slaying monsters * Cooksanity - Cooking individual recipes * Chefsanity - Learning individual recipes * Craftsanity - Crafting individual items - New Goals: * Protector of the Valley - Complete every monster slayer goal * Full Shipment - Ship every item * Craftmaster - Craft every item * Gourmet Chef - Cook every recipe * Legend - Earn 10 000 000g * Mystery of the Stardrops - Find every stardrop (Maguffin Hunt) * Allsanity - Complete every check in your slot - Building Shuffle: Cheaper options - Tool Shuffle: Cheaper options - Money rework - New traps - New isolated checks and items, including the farm cave, the movie theater, etc - Mod Support: SVE [Albrekka] - Mod Support: Distant Lands [Albrekka] - Mod Support: Hat Mouse Lacey [Albrekka] - Mod Support: Boarding House [Albrekka] Co-authored-by: Witchybun <[email protected]> Co-authored-by: Witchybun <[email protected]> Co-authored-by: Jouramie <[email protected]> Co-authored-by: Alchav <[email protected]> Launcher: make scrollbar more prominent (ArchipelagoMW#2955) TUNIC: Updated display name for a few options (ArchipelagoMW#2953) SMW: Add CHANGELOG.md (ArchipelagoMW#2947) Celeste 64: Add CHANGELOG.md (ArchipelagoMW#2948) DKC3: Add CHANGELOG.md (ArchipelagoMW#2946) Core: increment version (ArchipelagoMW#2958) SA2B: Add CHANGELOG.md (ArchipelagoMW#2945) The Witness: Add newly submitted junk hints (ArchipelagoMW#2949) OoT: Entrance Spoiler Fixes (ArchipelagoMW#2500) Stardew Valley: Added a Great Combat requirement to an entrance that could block its own key (ArchipelagoMW#2959) SC2: Multi-campaign (ArchipelagoMW#2954) Adds HotS, LotV and NCO campaigns to SC2 game. The world's name has changed to reflect that (it's not only Wings of Liberty now) The client was patched in a way that can still join to games generated prior this change --------- Co-authored-by: Magnemania <[email protected]> Co-authored-by: EnvyDragon <[email protected]> Co-authored-by: Matthew <[email protected]> Co-authored-by: hopop201 <[email protected]> Co-authored-by: Salzkorn <[email protected]> Co-authored-by: genderdruid <[email protected]> Co-authored-by: MadiMadsen <[email protected]> Co-authored-by: neocerber <[email protected]> Co-authored-by: Exempt-Medic <[email protected]> Co-authored-by: Fabian Dill <[email protected]> Zork Grand Inquisitor: Implement New Game (ArchipelagoMW#2539) Adds Archipelago support for Zork Grand Inquisitor, the 1997 point-and-click PC adventure game. The client (based on `CommonClient`), on top of its regular Archipelago duties, fully handles the randomization of the game and the monitoring / modification of the game state. No game modding needed at all; the player is ready to play an Archipelago seed if they can play the vanilla game through ScummVM. The "reverse engineering" (there's likely a better term for this...) of the game is my own original work and I included an MIT license at the root of my world directory. A PopTracker pack was also created to help people learn the game: https://github.com/SerpentAI/ZorkGrandInquisitorAPTracker TUNIC: Implement support for connection plando (ArchipelagoMW#2864) The Witness: Add junk hint for Zork: Grand Inquisitor (ArchipelagoMW#2961) SMW: Increment Required Client Version (ArchipelagoMW#2962) Core: implement APProcedurePatch and APTokenMixin (ArchipelagoMW#2536) * initial work on procedure patch * more flexibility load default procedure for version 5 patches add args for procedure add default extension for tokens and bsdiff allow specifying additional required extensions for generation * pushing current changes to go fix tloz bug * move tokens into a separate inheritable class * forgot the commit to remove token from ProcedurePatch * further cleaning from bad commit * start on docstrings * further work on docstrings and typing * improve docstrings * fix incorrect docstring * cleanup * clean defaults and docstring * define interface that has only the bare minimum required for `Patch.create_rom_file` * change to dictionary.get * remove unnecessary if statement * update to explicitly check for procedure, restore compatible version and manual override * Update Files.py * remove struct uses * ensure returning bytes, add token type checking * Apply suggestions from code review Co-authored-by: Doug Hoskisson <[email protected]> * pep8 --------- Co-authored-by: beauxq <[email protected]> Co-authored-by: Doug Hoskisson <[email protected]> Pokemon Emerald: Bump required client version (ArchipelagoMW#2963)

github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Mar 5, 2024

Merge branch 'main' into new-option-default-typing

f906354

github-actions bot added the affects: core Issues/PRs that touch core and may need additional validation. label Mar 5, 2024

beauxq changed the title ~~Core: typing for Option.default and a few other Option class vari…~~ Core: typing for Option.default and a few other ClassVars Mar 5, 2024

NumericOption doesn't need the type annotation that brings out the my…

3bedb87

…py bug

beauxq mentioned this pull request Mar 5, 2024

fix some issues Silvris/Archipelago#4

Merged

Merge branch 'main' into new-option-default-typing

065790d

Jouramie approved these changes Mar 6, 2024

View reviewed changes

black-sliver reviewed Mar 12, 2024

View reviewed changes

Options.py Show resolved Hide resolved

Merge branch 'main' into new-option-default-typing

e6bd551

SoE default ClassVar

dd2774f

Merge branch 'main' into new-option-default-typing

b346463

black-sliver approved these changes Mar 12, 2024

View reviewed changes

black-sliver merged commit 03d403f into ArchipelagoMW:main Mar 12, 2024

beauxq deleted the new-option-default-typing branch March 12, 2024 22:08

beauxq mentioned this pull request Apr 17, 2024

CI: add mypy to strict type check #3165

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Core: typing for `Option.default` and a few other ClassVars #2899

Core: typing for `Option.default` and a few other ClassVars #2899

Uh oh!

beauxq commented Mar 5, 2024 •

edited

Loading

Uh oh!

Jouramie left a comment •

edited

Loading

Uh oh!

Jouramie Mar 6, 2024 •

edited

Loading

Uh oh!

Jouramie Mar 6, 2024

Uh oh!

beauxq Mar 6, 2024

Uh oh!

Jouramie Mar 6, 2024

Uh oh!

Jouramie Mar 6, 2024

Uh oh!

black-sliver left a comment

Uh oh!

Uh oh!

black-sliver commented Mar 12, 2024

Uh oh!

beauxq commented Mar 12, 2024

Uh oh!

black-sliver commented Mar 12, 2024

Uh oh!

black-sliver left a comment •

edited

Loading

Uh oh!

Uh oh!

Core: typing for Option.default and a few other ClassVars #2899

Core: typing for Option.default and a few other ClassVars #2899

Uh oh!

Conversation

beauxq commented Mar 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is this fixing or adding?

How was this tested?

Uh oh!

Jouramie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jouramie Mar 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jouramie Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

beauxq Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

Jouramie Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

Jouramie Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

black-sliver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

black-sliver commented Mar 12, 2024

Uh oh!

beauxq commented Mar 12, 2024

Uh oh!

black-sliver commented Mar 12, 2024

Uh oh!

black-sliver left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Core: typing for `Option.default` and a few other ClassVars #2899

Core: typing for `Option.default` and a few other ClassVars #2899

beauxq commented Mar 5, 2024 •

edited

Loading

Jouramie left a comment •

edited

Loading

Jouramie Mar 6, 2024 •

edited

Loading

black-sliver left a comment •

edited

Loading