Core: `Option.default` typing and definition checking by beauxq · Pull Request #2173 · ArchipelagoMW/Archipelago

beauxq · 2023-09-12T18:31:32Z

What is this fixing or adding?

The typing of Option.default has been making trouble for type-checkers,
and it doesn't make sense to set a default (0) that is the wrong type for some subclasses (FreeText)

I consulted the python typing discussion board about this
python/typing#1460
and it seems there is no perfect solution.

This is the best solution offered there.

Also, 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 breaking some options to make sure the assertion in the metaclass would fail unit tests if an option doesn't set a default

el-u · 2023-09-13T20:32:30Z

Getting a lot of mypy errors with this. The reason seems to be that, e.g., NumericOption has default = 0 without a type annotation, which causes it to implicitly narrow typing of the generic, but explicitly annotated default from the superclass down to literally just 0 for every further subclass; but the world-specific subclasses often want to put a default other than 0 there.

I think a solution to this problem might be to specify explicit typing for default in subclasses of Option that have default set, i.e.:

Accessibility:
default: typing.ClassVar[typing.Union[int, typing.Literal["random"]]] = 1
FreeText:
default: typing.ClassVar[str] = ""
NumericOption:
default: typing.ClassVar[typing.Union[int, typing.Literal["random"]]] = 0
OptionDict:
default: typing.ClassVar[typing.Dict[str, typing.Any]] = {}
OptionList and ItemLinks:
default: typing.ClassVar[typing.List[typing.Any]] = []
OptionSet:
default: typing.ClassVar[typing.AbstractSet[str]] = frozenset() and change the superclass to Option[typing.AbstractSet[str]]
ProgressionBalancing:
default: typing.ClassVar[typing.Union[int, typing.Literal["random"]]] = 50
Toggle and DefaultOnToggle:
default: typing.ClassVar[typing.Literal[0, 1, "random"]] = 0

(I assume a bunch of subclasses in the worlds would have to be changed, too, to avoid the same error, but I did only check the classes defined in core.)

beauxq · 2023-09-13T20:52:01Z

Can I see what errors you're getting? and how?
mypy already reported lots of errors in this file before this change, and I don't see any new ones.

el-u · 2023-09-13T21:02:50Z

The errors happen when you subclass the options, not in the core Options.py

> mypy --strict --follow-imports=silent -p worlds.lufia2ac

...
worlds\lufia2ac\Options.py:94: error: Incompatible types in assignment (expression has type "Literal[25]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:119: error: Incompatible types in assignment (expression has type "Literal[25]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:175: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:263: error: Incompatible types in assignment (expression has type "Literal[1]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:289: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:313: error: Incompatible types in assignment (expression has type "Literal[16]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:360: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
...
worlds\lufia2ac\Options.py:379: error: Cannot override class variable (previously declared on base class "NumericOption") with instance variable  [misc]
worlds\lufia2ac\Options.py:379: error: Incompatible types in assignment (expression has type "Union[str, int]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:437: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:466: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:489: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:502: error: Incompatible types in assignment (expression has type "Literal[100]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:521: error: Incompatible types in assignment (expression has type "Literal[99]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:557: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:571: error: Incompatible types in assignment (expression has type "Literal[16]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:585: error: Incompatible types in assignment (expression has type "Literal[1]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:601: error: Incompatible types in assignment (expression has type "Literal[5]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:615: error: Incompatible types in assignment (expression has type "Literal[9]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:629: error: Incompatible types in assignment (expression has type "Literal[9980]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:642: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
worlds\lufia2ac\Options.py:661: error: Incompatible types in assignment (expression has type "int", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
...

el-u · 2023-09-13T21:10:47Z

Well, most of the errors are in world-specific subclasses, but some are actually also in core, e.g.:

Options.py:384: error: Incompatible types in assignment (expression has type "Literal[1]", base class "Toggle" defined the type as "Literal[0]")  [assignment]
Options.py:782: error: Cannot override class variable (previously declared on base class "Option") with instance variable  [misc]
Options.py:823: error: Cannot override class variable (previously declared on base class "Option") with instance variable  [misc]
Options.py:849: error: Cannot override class variable (previously declared on base class "Option") with instance variable  [misc]
Options.py:849: error: Incompatible types in assignment (expression has type "Union[Set[str], FrozenSet[str]]", base class "Option" defined the type as "Union[Set[str], Literal['random']]")  [assignment]
Options.py:889: error: Incompatible types in assignment (expression has type "Literal[1]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
Options.py:895: error: Incompatible types in assignment (expression has type "Literal[50]", base class "NumericOption" defined the type as "Literal[0]")  [assignment]
Options.py:968: error: Cannot override instance variable (previously declared on base class "OptionList") with class variable  [misc]

beauxq · 2023-09-13T21:21:54Z

I can't reproduce that.

python -m mypy --strict --follow-imports=silent -p worlds.lufia2ac
worlds/lufia2ac/basepatch/__init__.py:3: error: Skipping analyzing "bsdiff4": module is installed, but missing library stubs or py.typed marker  [import]
worlds/lufia2ac/basepatch/__init__.py:11: error: Returning Any from function declared to return "bytes"  [no-any-return]
worlds/lufia2ac/basepatch/__init__.py:15: error: Cannot find implementation or library stub for module named "worlds.lufia2ac.basepatch.asar"  [import]
worlds/lufia2ac/basepatch/__init__.py:15: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
worlds/lufia2ac/basepatch/__init__.py:18: error: Module has no attribute "add_dll_directory"  [attr-defined]
worlds/lufia2ac/Options.py:18: error: Call to untyped function "__new__" in typed context  [no-untyped-call]
worlds/lufia2ac/Options.py:21: error: "AssembleOptions" has no attribute "name_lookup"  [attr-defined]
worlds/lufia2ac/Options.py:363: error: Definition of "get_option_name" in base class "RandomGroupsChoice" is incompatible with definition in base class "TextChoice"  [misc]
worlds/lufia2ac/Options.py:363: error: Definition of "from_text" in base class "RandomGroupsChoice" is incompatible with definition in base class "TextChoice"  [misc]
worlds/lufia2ac/Options.py:379: error: Incompatible types in assignment (expression has type "str | int", base class "NumericOption" defined the type as "int")  [assignment]
worlds/lufia2ac/Client.py:60: error: Statement is unreachable  [unreachable]
worlds/lufia2ac/__init__.py:158: error: Cannot infer type of lambda  [misc]
worlds/lufia2ac/__init__.py:160: error: Cannot infer type of lambda  [misc]
worlds/lufia2ac/__init__.py:163: error: Cannot infer type of lambda  [misc]
Found 13 errors in 4 files (checked 14 source files)

Do you have some hidden mypy settings? or what version of mypy?

beauxq · 2023-09-13T21:26:12Z

nevermind, I found how to reproduce it

beauxq · 2023-09-13T21:37:21Z

(I assume a bunch of subclasses in the worlds would have to be changed, too, to avoid the same error, but I did only check the classes defined in core.)

As long as they inherit from one of these with a concrete type, they shouldn't need it any further down the subclass chain.

beauxq · 2023-09-13T21:43:36Z

Now anything that inherits directly from Option has the annotation to unconfuse mypy.

Anything further down the inheritance chain will take that concrete annotation.

el-u · 2023-09-13T23:07:08Z

Anything further down the inheritance chain will take that concrete annotation.

I don't think this is true. As soon a class anywhere in the chain sets an explicit value for default without also specifying an appropriate type hint, all lower subclasses will have mypy errors if they want to set a different default.
Therefore, the only way to avoid this seems to be that if a class might potentially be subclassed further (which I assume to be true for all core option classes) and that class also sets a default, a type annotation of default would have to be provided to prevent the overly narrow type inference.

For example, The Messenger's MessengerAccessibility and Secret of Evermore's SoEProgressionBalancing still trigger mypy errors that should be resolvable by changing their corresponding superclasses in core.
And even the core class DefaultOnToggle has a problem because Toggle already sets default. (And since we don't want to prevent anyone from defining a RandomToggle further down the line, I proposed the Literal[0, 1, "random"] for this case above.)

beauxq · 2023-09-14T00:33:34Z

Ok, I think this is a bug in mypy that has nothing to do with the Generic

https://mypy-play.net/?mypy=latest&python=3.11&gist=1f83185d54fbb490447484a5a2fd7677&flags=strict

beauxq · 2023-09-14T00:37:51Z

Yeah, here's an already existing issue: python/mypy#10506

black-sliver · 2023-10-10T21:09:08Z

is it worth merging this while there is still an upstream bug surrounding this?

beauxq · 2023-10-10T21:42:14Z

I've been focusing on #2287 and #993 recently, I'll implement el-u's workaround for the bug.

alwaysintreble · 2023-10-10T21:45:31Z

We definitely need to make FreeText a more proper class at some point. Not sure if this is the right place for it, since I think no matter how you approach it with the goal of this PR it'll still be a bit of a mess.

…nto option-default-typing

beauxq · 2023-10-11T06:51:24Z

I found a few more issues when applying el-u's suggestion:

pyright correctly tells us that it's not type-safe to narrow the type of default in each subclass. It would be type safe if we could indicate that default is read-only, but the python type system currently doesn't support that. python/typing#1486
So I've kept the whole type for all the additional default annotations to work around the mypy bug.

OptionSet should not have the AbstractSet generic type because its value property should always be set and not frozenset.
Lots of code relies on this, calling .value.add(...) when frozenset doesn't have add.
The reason for frozenset in the default value is a safety (crash instead of difficult to find and understand bug) in case someone makes a subclass, overrides __init__, and forgets to call super().__init__, and add to the default (a problem similar to what we've seen in the past).
(__init__ is what turns the frozenset into a set)
So I think the best solution to that specific situation is just # type: ignore the frozenset.

black-sliver · 2024-01-14T14:34:31Z

Sorry, I didn't find the time to look at this again after your last changes. We didn't break this in the meantime and should be able to merge, right?

beauxq · 2024-01-14T15:10:45Z

We didn't break this in the meantime and should be able to merge, right?

I just looked over it again, and can't think of any new problems from it.

(and `default` isn't needed in `FlagsProtocol`)

beauxq · 2024-01-14T17:11:22Z

I found something in SoE affected by this: beauxq#2
@black-sliver

beauxq · 2024-01-15T06:11:25Z

I think Options.py here is the best it the best it can be on this issue with the mypy bug. I'm not sure what to do with the SoE protocol. It might just need a # type: ignore somewhere.

black-sliver · 2024-01-15T08:19:00Z

Merged the other PR. So we get proper mypy output when updating this branch.

soe: change `FlagProtocol` to match `default` typing

black-sliver · 2024-01-15T12:33:23Z

Hm, I still see a couple of errors in Options.py and soe/options.py that we can maybe partially fix, I'll give it a look when I have the time - maybe tonight.

You said something about ReadOnly not being available to use yet. When does this become available and what would it fix? I'd maybe leave a comment since we will definitely drop 3.8 at latest when it becomes EoL in a year and at that point there is also no reason for 3.9 anymore.

beauxq · 2024-01-15T15:24:52Z

You said something about ReadOnly not being available to use yet.

When does this become available

PEP 705 doesn't give us what we need to fix this. It has this line:

This PEP proposes making ReadOnly valid only in a TypedDict. A possible future extension would be to support it in additional contexts, such as in protocols.

So there isn't even a PEP written yet to give us what might fix this.

and what would it fix?

I'm not confident that it would fix everything here. This issue python/typing#1486 is separate from the mypy bug. And that's the issue that ReadOnly is needed to solve. (edit: previously linked to the wrong issue here)

If a protocol has a property (like value and default in this case), if we can't specify that they are read-only, the types of those properties must be invariant.

I just thought there's a chance that ReadOnly could work around the mypy bug as a side-effect.

beauxq · 2024-01-15T15:31:46Z

I still see a couple of errors in Options.py

I'm not sure what you're thinking of. I'm aware there are lots more issues in Options.py, but I was trying to keep the scope of this PR limited to Option.default and things closely related to it.

There are different levels of complexity with other things that could be fixed.

black-sliver · 2024-01-15T18:57:59Z

Mainly the prog balancing override

black-sliver · 2024-01-15T21:59:44Z

Oh I see. That's the same problem. We'd have to put typing.ClassVar[typing.Union[int, typing.Literal["random"]]] everywhere (and then cast to get the actual int out). At this point I am not sure how I feel about this. We get proper typing in some places, but introduce "bogus" type errors in others :/

What do we do? Wait for mypy to fix it? Is pyright any better? (Never used it, but I guess we could switch if it's as good or better)

black-sliver · 2024-01-15T22:08:09Z

I feel like a protocol with default: ClassVar[Any] not accepting default: ClassVar[Union[int, Literal["random"]]] is also a bug, but that we could maybe work around through proper inheritance since they are all some kind of Toggle.

beauxq · 2024-01-16T01:33:38Z

I think pyright is generally a little better. I use both mypy and pyright because there are a few things pyright won't detect that mypy will.

PoryGone · 2024-03-04T21:55:55Z

Waiting on Author for merge conflicts.

beauxq · 2024-03-04T22:36:13Z

The lack of a ReadOnly specifier to avoid invariance, and other issues, I think make this not worth it.
Maybe I'll try a different approach later.

…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.

* Core: 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. * NumericOption doesn't need the type annotation that brings out the mypy bug * SoE default ClassVar

…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)

beauxq added 2 commits September 12, 2023 11:18

Option typing and definition checking

fc4f71f

add default to FreeText option

c817dbe

annotation on anything that inherits directly from Option

a899e92

beauxq marked this pull request as draft October 10, 2023 21:42

beauxq added 2 commits October 10, 2023 20:25

Merge branch 'main' of https://github.com/ArchipelagoMW/Archipelago i…

81e4916

…nto option-default-typing

work around mypy bug for complex ClassVar

e1ad19f

beauxq marked this pull request as ready for review October 11, 2023 06:51

ThePhar added is: refactor/cleanup Improvements to code/output readability or organizization. affects: core Issues/PRs that touch core and may need additional validation. labels Oct 16, 2023

Merge branch 'main' into option-default-typing

9b38daa

beauxq added 2 commits January 14, 2024 08:46

soe: change FlagProtocol to match default typing

a5b26e0

(and `default` isn't needed in `FlagsProtocol`)

fix for python 3.8

8697ba7

beauxq mentioned this pull request Jan 14, 2024

soe: change FlagProtocol to match default typing beauxq/Archipelago#2

Merged

Merge pull request #2 from beauxq/soe-default-protocol-typing

ae7604d

soe: change `FlagProtocol` to match `default` typing

beauxq requested a review from black-sliver as a code owner January 15, 2024 09:52

Merge branch 'main' into option-default-typing

07264bf

agilbert1412 added the waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. label Feb 12, 2024

PoryGone added waiting-on: author Issue/PR is waiting for feedback or changes from its author. and removed waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. labels Mar 4, 2024

beauxq closed this Mar 4, 2024

github-actions bot removed the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Mar 4, 2024

This was referenced Mar 5, 2024

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

Merged

fix some issues Silvris/Archipelago#4

Merged

beauxq mentioned this pull request Apr 17, 2024

CI: add mypy to strict type check #3165

Draft

Conversation

beauxq commented Sep 12, 2023

What is this fixing or adding?

How was this tested?

Uh oh!

el-u commented Sep 13, 2023

Uh oh!

beauxq commented Sep 13, 2023

Uh oh!

el-u commented Sep 13, 2023

Uh oh!

el-u commented Sep 13, 2023

Uh oh!

beauxq commented Sep 13, 2023

Uh oh!

beauxq commented Sep 13, 2023

Uh oh!

beauxq commented Sep 13, 2023

Uh oh!

beauxq commented Sep 13, 2023

Uh oh!

el-u commented Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beauxq commented Sep 14, 2023

Uh oh!

beauxq commented Sep 14, 2023

Uh oh!

black-sliver commented Oct 10, 2023

Uh oh!

beauxq commented Oct 10, 2023

Uh oh!

alwaysintreble commented Oct 10, 2023

Uh oh!

beauxq commented Oct 11, 2023

Uh oh!

black-sliver commented Jan 14, 2024

Uh oh!

beauxq commented Jan 14, 2024

Uh oh!

beauxq commented Jan 14, 2024

Uh oh!

beauxq commented Jan 15, 2024

Uh oh!

black-sliver commented Jan 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

black-sliver commented Jan 15, 2024

Uh oh!

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

Uh oh!

Uh oh!

beauxq commented Jan 15, 2024

Uh oh!

black-sliver commented Jan 15, 2024

Uh oh!

black-sliver commented Jan 15, 2024

Uh oh!

black-sliver commented Jan 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beauxq commented Jan 16, 2024

Uh oh!

PoryGone commented Mar 4, 2024

Uh oh!

beauxq commented Mar 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

el-u commented Sep 13, 2023 •

edited

Loading

black-sliver commented Jan 15, 2024 •

edited

Loading

beauxq commented Jan 15, 2024 •

edited

Loading

black-sliver commented Jan 15, 2024 •

edited

Loading