fix(coordinate_compression): raise exceptions instead of returning -1#14555
Open
AshrafHosam wants to merge 2 commits intoTheAlgorithms:masterfrom
Open
fix(coordinate_compression): raise exceptions instead of returning -1#14555AshrafHosam wants to merge 2 commits intoTheAlgorithms:masterfrom
AshrafHosam wants to merge 2 commits intoTheAlgorithms:masterfrom
Conversation
Previously `compress()` and `decompress()` returned -1 on invalid input while `coordinate_map[...]` raised KeyError, giving inconsistent error semantics. This change makes error handling uniform: `compress` raises KeyError and `decompress` raises IndexError, matching Python conventions and the underlying dict/list. Docstrings and doctests updated. Fixes TheAlgorithms#13509
This file contains hidden or 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
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.
Describe your change:
Fixes inconsistent error handling in
data_compression/coordinate_compression.pyreported in #13509.Previously:
compress(x)returned-1on missing input (silent failure)decompress(n)returned-1on out-of-range input (silent failure)coordinate_map[x]raisedKeyError(exception)This mix of sentinels and exceptions made errors easy to miss and hard to debug.
This PR unifies the behavior to raise exceptions consistently:
compress(x)now raisesKeyError(same as the underlyingcoordinate_mapdict)decompress(n)now raisesIndexErrorwith a descriptive messageRaises:contractFixes #13509
Checklist: