Problem: Error when building Handcrafting Transactions docs #476
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
TypeError: Object of type 'bytes' is not JSON serializable Solution: Use base58.b58encode(key).decode() which is a str, instead of base58.b58encode(key) which is a bytes object
|
@codegeschrei I'm not sure why some tests in Travis are failing. They seem unrelated to the changes I made in this pull request. |
codegeschrei
approved these changes
Sep 11, 2018
Codecov Report
@@ Coverage Diff @@
## master #476 +/- ##
=======================================
Coverage 98.74% 98.74%
=======================================
Files 5 5
Lines 239 239
=======================================
Hits 236 236
Misses 3 3 |
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.
The docs would build, but the generated "Handcrafting Transactions" page was full of valid Python errors of the form:
TypeError: Object of type 'bytes' is not JSON serializableI guess sometimes people want to show the actual error messages in their docs, so such errors don't prevent Sphinx from thinking everything is okay.
Solution: Use
base58.b58encode(key).decode()which is a str, instead ofbase58.b58encode(key)which is a bytes object. I defined a little helper function namedb58()to reduce verbosity.I don't know if this will get ReadTheDocs to start working (as per issue #475), but it does remove all the "Traceback" messages in the "Handcrafting Transactions" page of the docs.