some worlds: some typing in LocalRom
#3090
Merged
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
### `read_bytes` It's not safe to return `bytearray` when we think it's `bytes` ```python a = rom.read_bytes(8, 3) hash(a) # This won't crash, right? ``` ### `write_bytes` `Iterable[SupportsIndex]` is what's required for `bytearray.__setitem__(slice, values)` We need to add `__len__` for the `len(values)` in this function.
github-actions
bot
added
the
waiting-on: peer-review
|
world owners: |
|
Seems fine. |
Exempt-Medic
added
waiting-on: world-maintainer
|
I approve |
Berserker66
approved these changes
May 17, 2024
ScipioWright
added
waiting-on: core-review
|
If you are worried about people copying this. Should we maybe remove the inheritance of Otherwise this looks good to me and should be safe since it only touches typing. I've never seen |
|
removed the In practice, we'll probably never see any difference between |
black-sliver
approved these changes
May 17, 2024
jnschurig
pushed a commit
to Tranquilite0/Archipelago-SoulBlazer
that referenced
this pull request
Jun 13, 2024
* some worlds: some typing in `LocalRom` ### `read_bytes` It's not safe to return `bytearray` when we think it's `bytes` ```python a = rom.read_bytes(8, 3) hash(a) # This won't crash, right? ``` ### `write_bytes` `Iterable[SupportsIndex]` is what's required for `bytearray.__setitem__(slice, values)` We need to add `__len__` for the `len(values)` in this function. * remove `object` inheritance
qwint
pushed a commit
to qwint/Archipelago
that referenced
this pull request
Jun 24, 2024
* some worlds: some typing in `LocalRom` ### `read_bytes` It's not safe to return `bytearray` when we think it's `bytes` ```python a = rom.read_bytes(8, 3) hash(a) # This won't crash, right? ``` ### `write_bytes` `Iterable[SupportsIndex]` is what's required for `bytearray.__setitem__(slice, values)` We need to add `__len__` for the `len(values)` in this function. * remove `object` inheritance
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?
A few people have copied this code.
Maybe we can improve it before more people copy it.
I thought about putting it in
Utils.py, but it has some SNES specific stuff, and other variations.Also, I'm not sure how this landscape will change as people move towards not requiring roms for generation.
read_bytesIt's not safe to return
bytearraywhen we think it'sbytesI considered converting to
bytesbeforereturn, but I think that would be a slow-down for no benefit.It's already a slice, so there's no danger of mutating the source.
And some are likely to want
bytearray, so they would make 2 conversions just to get back to where it started.write_bytesSome have found that they can pass a
list[int], and it works.Iterable[SupportsIndex]is what's required forbytearray.__setitem__(slice, values)We need to add
__len__for thelen(values)in this function.The reason I didn't add the
write_bytestyping to dkc3 and smw, is that they both didn't have anytypingimports in this file, so I thought it would be a little more invasive to add them.How was this tested?
unit tests and type checking