cli_client: Narrow api_client type in TimesketchCli.__init__ to satisfy Pytype - #3897
Open
jaegeral wants to merge 5 commits into
Open
cli_client: Narrow api_client type in TimesketchCli.__init__ to satisfy Pytype#3897jaegeral wants to merge 5 commits into
jaegeral wants to merge 5 commits into
Conversation
Added error handling for uninitialized API client.
jaegeral
changed the title
Added an error message to the assertion for better debugging.
Collaborator
Author
|
/gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds an assertion to ensure the Timesketch API client is initialized before retrieving a sketch. The review feedback correctly points out that using assert for runtime validation is discouraged in Python because assertions can be optimized out in production. It is recommended to replace the assertion with an explicit conditional check that raises a RuntimeError.
jkppr
requested changes
Aug 20, 2026
| Returns: | ||
| Sketch object. | ||
| """ | ||
| assert self.api is not None, "Timesketch API client is not initialized" |
Collaborator
There was a problem hiding this comment.
Rather than asserting inside the sketch property getter, would it make more sense to establish this at the end of TimesketchCli.__init__ instead?
This would also cover other places where self.api is used.
Refactor API client initialization and type annotation.
jaegeral
changed the title
jkppr
approved these changes
Aug 20, 2026
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.
Restructure TimesketchCli.init assignment with an if/else guard to narrow
api_client from Optional[TimesketchApi] to TimesketchApi