Core: prepare worlds.Files for APWorldContainer #4331
+43
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
affects: core
beauxq
reviewed
Dec 7, 2024
beauxq
approved these changes
Dec 7, 2024
Co-authored-by: Doug Hoskisson <[email protected]>
Silvris
approved these changes
Dec 11, 2024
silasary
approved these changes
Dec 16, 2024
Jouramie
approved these changes
Dec 17, 2024
ScipioWright
added
is: enhancement
Exempt-Medic
added
the
waiting-on: author
Exempt-Medic
removed
the
waiting-on: author
beauxq
suggested changes
Jan 19, 2025
| @@ -135,31 +126,58 @@ def read(self, file: Optional[Union[str, BinaryIO]] = None) -> None: | |||
| message = f"{arg0} - " | |||
| raise InvalidDataError(f"{message}This might be the incorrect world version for this file") from e | |||
|
|
|||
| def read_contents(self, opened_zipfile: zipfile.ZipFile) -> None: | |||
| def read_contents(self, opened_zipfile: zipfile.ZipFile) -> Dict[str, Any]: | |||
There was a problem hiding this comment.
This is something I didn't notice before.
related to #4516 (comment)
Not only is this ambiguous to both mutate and return something, this is also a breaking change.
If this base class returns something in this method, every subclass that overrides it also needs to return the same type.
That could include apworlds that are not in this repo, as well as some in this repo.
If this changes here, it needs to change in every subclass, and we need to think about the deprecation for external apworlds.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this fixing or adding?
Not much on its own.
APContainer is now just any AP related zip file containing an archipelago.json
APPlayerContainer is the old one, aimed at files for a particular slot/player
Follow up PR(s) can then cleanly introduce APWorldContainer(APContainer) with the meta data we desire inside the archipelago.json.
How was this tested?
I ran Factorio gen once and it didn't break