Repository navigation
fix: start fix of issue 694 with more pythonic __all__ array. - #723
Open
karel-rehor wants to merge 5 commits into
Open
karel-rehor wants to merge 5 commits into
karel-rehor wants to merge 5 commits into
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #723 +/- ##
==========================================
+ Coverage 90.49% 90.53% +0.03%
==========================================
Files 40 41 +1
Lines 3568 3581 +13
==========================================
+ Hits 3229 3242 +13
Misses 339 339 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
🟡 Changes recommended
The new export-list formatting violates the repository’s enforced flake8 rules and would fail the code-style CI check.
1 open issue
What changed in this PR
This PR addresses #694 by explicitly exporting the package’s public API through __all__, replacing the alias-based approach in #722 to support strict type checkers.
Changes:
- Add an explicit public export list and a changelog entry.
- Add runtime and mypy regression checks, with mypy included in test dependencies.
- Update the asynchronous batching example’s timeout and error propagation.
| File | Description |
|---|---|
tests/typing/public_exports.py |
Exercise representative public imports and runtime behavior. |
tests/test_PublicExports.py |
Run the import fixture directly and through mypy. |
setup.py |
Add mypy to test dependencies. |
influxdb_client/__init__.py |
Declare public exports using __all__. |
examples/asynchronous_batching.py |
Increase the timeout and propagate write errors to the completion future. |
CHANGELOG.md |
Document the public export fix. |
Review effort: Balanced
karel-rehor
marked this pull request as ready for review
October 22, 2026 15:35
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.


Closes #694
Proposed Changes
Add the
__all__array to__init__.pyThis replaces #722, which is good. But no-op aliases might be confusing for future maintainers and the more "pythonic" approach is to use the documented
__all__variable.Note that ac1982's tests from that PR are gratefully being reused here.
Checklist
pytest testscompletes successfully