Separate private and public API in the package structure#645
Draft
TheMrSheldon wants to merge 2 commits intodevelopmentfrom
Draft
Separate private and public API in the package structure#645TheMrSheldon wants to merge 2 commits intodevelopmentfrom
TheMrSheldon wants to merge 2 commits intodevelopmentfrom
Conversation
TheMrSheldon
added
enhancement
TheMrSheldon
changed the title
…t -- but kept them in LocalClient
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
1 participant
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.
This PR aims to better distinguish between the private and public API and properly hide implementation details.
Previously, the TiraClient abstract base class was only used for type hinting. With this change, the user only sees the methods
RestClient(...) -> TiraClientandLocalClient(...) -> TiraClientinstead of the concrete implementations to reduce cognitive load. This is a breaking API change since the imports must be updated to:instead of
The new "private" submodule
tira._internalcan also be used for further implementation-details that should not be part of the public API (e.g., some of the utilities @mam10eks?).