Fix new_window argument typing in Session
#596
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
Reviewer's GuideThis PR fixes the Updated Class Diagram for Session.new_window Method SignatureclassDiagram
class Session {
+new_window(window_name: str | None, start_directory: str | None, attach: bool, window_index: str, window_shell: str | None, environment: dict[str, str] | None) Window
}
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @Data5tream - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| @@ -587,7 +587,7 @@ def new_window( | |||
| self, | |||
| window_name: str | None = None, | |||
| *, | |||
| start_directory: None = None, | |||
There was a problem hiding this comment.
suggestion: Consider accepting PathLike inputs for start_directory
Update the annotation to os.PathLike[str] | str | None (or Path | str | None) and convert to str afterward so callers can pass pathlib.Path or other PathLike objects.
There was a problem hiding this comment.
This sounds good. But it would change the public API. I'll need input on that @tony 😃
| @@ -677,7 +677,7 @@ def new_window( | |||
|
|
|||
| window_args += ("-P",) | |||
|
|
|||
| if start_directory: | |||
There was a problem hiding this comment.
issue (bug_risk): Explicit None check changes behavior for empty strings
An empty string now passes and becomes ./. To skip empty values, revert to if start_directory: or explicitly require non-empty paths.
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.
Corrects the
start_directorytype of thenew_windowmethod on theSessionclass.Fixes #595
Summary by Sourcery
Fix the typing and conditional handling of the
start_directoryargument inSession.new_windowto accept string paths and avoid skipping valid values.Bug Fixes:
start_directoryannotation tostr | NoneinSession.new_windowif start_directory is not Noneso empty strings aren’t misinterpreted as absent paths