Enforce working examples in docstrings and documentation #1588
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
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
strawgate
changed the title
strawgate
changed the title
strawgate
changed the title
strawgate
changed the title
strawgate
force-pushed
the
add-pytest-examples
branch
from
1a46a09 to
5fe8ece
Compare
strawgate
force-pushed
the
add-pytest-examples
branch
from
5fe8ece to
a23907e
Compare
alexmojaki
reviewed
Jan 7, 2026
| counter = logfire.metric_counter( | ||
| 'exceptions', | ||
| unit='1', # (1)! | ||
| description='Number of exceptions caught' |
Contributor
There was a problem hiding this comment.
Add a comma at the end here to keep the args on separate lines, especially so that # (1)! stays on the unit arg. same for others below.
Comment on lines
+211
to
+213
| #> Failed to execute query. Status code: 401 | ||
| print(response.text) | ||
| #> {"detail":"Invalid token"} |
Contributor
There was a problem hiding this comment.
Suggested change
| #> Failed to execute query. Status code: 401 | |
| print(response.text) | |
| #> {"detail":"Invalid token"} | |
| print(response.text) |
this is being skipped, right?
|
|
||
|
|
||
| def capture_response_headers(span: Span, response: Union[TraceRequestEndParams, TraceRequestExceptionParams]): | ||
| def capture_response_headers(span: Span, response: TraceRequestEndParams | TraceRequestExceptionParams): |
Contributor
There was a problem hiding this comment.
Suggested change
| def capture_response_headers(span: Span, response: TraceRequestEndParams | TraceRequestExceptionParams): | |
| def capture_response_headers(span: Span, response: 'TraceRequestEndParams | TraceRequestExceptionParams'): |
then skip the future import?
| #> 019b38289f5dfbf64cd7de68d37c6a04 | ||
| ``` | ||
|
|
||
| will print something like: |
Contributor
There was a problem hiding this comment.
Let's not have both this and the comments above
Comment on lines
+36
to
+37
| print('Serving on port 8000...') | ||
| #> Serving on port 8000... |
Contributor
There was a problem hiding this comment.
Suggested change
| print('Serving on port 8000...') | |
| #> Serving on port 8000... |
|
|
||
| # Override the autouse fixtures from conftest.py to prevent them from | ||
| # interfering with doc examples. Doc examples call their own logfire.configure() | ||
| # and we don't want them to pollute the test exporter state. |
Contributor
There was a problem hiding this comment.
I don't see how the test exporter state would get polluted. are you sure this fixture is needed?
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.
Require formatted and runnable examples in docstrings and documentation, and bring the documentation and code up to compliance with these new requirements. Closes #1587
Uses
pytest-examplesto ensure that examples in docstrings and documentation are properly formatted and runnable with assertions on anyprintstatements in the example. Addspytest-timeoutto the dev dependencies which is used to prevent example tests from running forever if they hit blocking code.There are zero lines of actual code changed outside the
test_docs.py. The majority of the PR is imports organization, linting, formatting, and ensuring that examples are runnable or ensuring we skip examples that should not be linted or that should not be run (either because they are incomplete examples, require internet access or an external connection, or are blocking).There are ~300 newly passing tests and ~140 skipped tests (examples that are not checked for formatting or if they are runnable).