[CLIENT-4702] Convert docstring code examples to doctest format and validate them#1047
Draft
juliannguyen4 wants to merge 95 commits into
Draft
[CLIENT-4702] Convert docstring code examples to doctest format and validate them#1047juliannguyen4 wants to merge 95 commits into
juliannguyen4 wants to merge 95 commits into
Conversation
…- this may make cicd check redundant in doc tests.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #1047 +/- ##
=======================================
Coverage 84.44% 84.44%
=======================================
Files 99 99
Lines 14062 14062
=======================================
Hits 11874 11874
Misses 2188 2188 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…rs in sphinx preview
…port it in the code examples
…e examples easier
…the TLS test which needs to be run with a different job
…uple that contains the line number where it happened which isn't important
… run boilerplate code before each example in client.rst
…y code example. It doesn't seem possible with doctest + unittest
…s to this format (takes less work)
…ening so try moving imports to the top
…te-code-examples-using-doctest
…turned by the client
…plicate code block that shows the testblock code.
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
2 participants
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.
Extra Changes
Trade-offs
Code examples are harder to run because the Python REPL gives a syntax error when it encounters>>>. As a workaround, developers have to use IPython REPL with their specific desired version of Python to copy and run the code examplesManual testing
https://aerospike-python-client--1047.org.readthedocs.build/en/1047/aerospike.html
https://aerospike-python-client--1047.org.readthedocs.build/en/1047/aerospike_helpers.batch.html
https://aerospike-python-client--1047.org.readthedocs.build/en/1047/aerospike_helpers.expressions.html
TODO
aerospike needs to be compiled before running doctestCopying doctest formatted code into Python REPL causes syntax errors related toMoved to a different format than doctest>>>