Implement all missing multibase encodings and API features #21
Conversation
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
- Add 10 missing encodings: base16upper, base32upper, base32pad, base32padupper, base32hexupper, base32hexpad, base32hexpadupper, base64pad, base64urlpad, base256emoji - Implement RFC 4648 padding support for base32 and base64 variants - Add structured exception classes (UnsupportedEncodingError, InvalidMultibaseStringError, DecodingError) - Add Encoder and Decoder classes for reusable encoding/decoding - Add decode(return_encoding=True) to return encoding type - Add encoding metadata functions (get_encoding_info, list_encodings, is_encoding_supported) - Add decoder composition support via Decoder.or_() method - Update tests for all new encodings and API features - Update documentation and create news fragment Closes #20 Achieves 100% encoding coverage (24/24 encodings)
acul71
force-pushed
the
feat/new-features
branch
from
2cb4656 to
02ac83c
Compare
…nt, add make targets docs
…prove docs, add test - Simplify redundant padding logic in BaseByteStringConverter - Add return type hints to Base256EmojiConverter methods - Add clarifying comments to exception handling in decode() - Add test for ComposedDecoder error messages when all decoders fail - Improve Base256EmojiConverter documentation with better docstrings
…mentations - Replace dynamic emoji generation with hardcoded alphabet matching js-multiformats and go-multibase - Update decode method to iterate character-by-character (matching reference implementations) - Ensures full compatibility with js-multiformats and go-multibase - All test cases from js-multiformats spec tests now pass exactly This fixes the compatibility issue where our implementation was generating a different emoji set than the reference implementations.
Contributor
Author
Implement all missing multibase encodings and API featuresThis PR implements all missing features identified in the gap analysis to bring py-multibase to 100% compatibility with reference implementations (go-multibase, rust-multibase, js-multiformats). New Encodings (10 total)High Priority (9 encodings)
Low Priority (1 encoding)
API EnhancementsReusable Encoder/Decoder Classes
Return Encoding Type on Decode
Structured Exception Classes
Encoding Metadata Functions
Implementation DetailsPadding Support
Base256Emoji Implementation
Code Quality
Testing
Documentation
Results
Breaking ChangesNone. All changes are backward compatible. RelatedCloses #20 |
|
Amazing work, @acul71! 🎉 This is a huge milestone for py-multibase — taking it from 58% → 100% encoding coverage and bringing full parity with go / rust / js implementations is a massive achievement. The implementation quality, attention to detail, API improvements, and exhaustive test coverage really stand out. Thank you for the thorough gap analysis, clean design of the new Encoder/Decoder abstractions, well-structured exceptions, and for ensuring complete compatibility (including the tricky base256emoji). The documentation, type hints, padding fixes, and newsfragment are all perfectly done. All tests, linting, and docs build cleanly — fantastic contribution. 🚀 Really appreciate the level of polish and care you bring to the project! |
|
@acul71 : Wonderful, Luca :) Appreciate the contribution. |
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.
Summary
This PR implements all missing features identified in the gap analysis to bring py-multibase to 100% compatibility with reference implementations (go-multibase, rust-multibase, js-multiformats).
Changes
New Encodings (10 total)
API Enhancements
EncoderandDecoderclassesdecode(return_encoding=True)parameter to return encoding typeUnsupportedEncodingError,InvalidMultibaseStringError,DecodingErrorget_encoding_info(),list_encodings(),is_encoding_supported()Decoder.or_()methodTesting
Documentation
Results
Closes #20