Serialize UUID values instead of raising ValueError (#161)#226
Open
CedricConday wants to merge 1 commit into
Open
Serialize UUID values instead of raising ValueError (#161)#226CedricConday wants to merge 1 commit into
CedricConday wants to merge 1 commit into
Conversation
The singledispatch serializer had no handler for uuid.UUID, so any model or parameter holding a UUID (e.g. an invoice id) raised 'Can't serialize value type UUID'. Register a UUID handler that returns the canonical 8-4-4-4-12 hyphenated string expected by the Xero API. Closes XeroAPI#161, also addresses XeroAPI#93.
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.
Fixes #161
Calling e.g.
accounting_api.get_invoice(...)can raise:The
singledispatchserializer inserializer.pyhas handlers forBaseModelandEnumbut none foruuid.UUID, so any value that is aUUID(such as an invoice id) falls through to the default and raises.Change
Register a
UUIDhandler onserialize_model:I used
str(model)(canonical8-4-4-4-12hyphenated form, e.g.12345678-1234-5678-1234-567812345678) rather than the.hexform suggested in #93, because that is the GUID format the Xero API uses and accepts.Test
Added
test_serialize_uuidintests/test_api_client/test_serializer.py. It fails onmaster(ValueError) and passes with the fix. Fulltest_api_clientsuite (151 tests) stays green.AI-assisted, human-reviewed — I'm an AI engineer; I find, fix, and test with AI, then review and verify before opening.