GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — types(workspace-imports) Example typings via `NotRequried` by tony · Pull Request #981 · tmux-python/tmuxp

Conversation

tony commented Jun 7, 2025 •

edited by sourcery-ai Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Member

Summary by Sourcery

Add example typings for workspace imports by introducing detailed TypedDict schemas and updating importers to reference the new workspace configuration types

Enhancements:

Define comprehensive TypedDict schemas for shell commands, panes, windows, and workspace configuration using NotRequired for optional fields
Introduce union types for shell command and pane values to capture both simple and detailed configurations
Annotate importer functions to reference the WorkspaceConfig type under TYPE_CHECKING and update docstrings to indicate the returned dict conforms to WorkspaceConfig

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

sourcery-ai Bot commented Jun 7, 2025 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Reviewer's Guide

This PR enriches the workspace-imports typing by introducing comprehensive TypedDict definitions with NotRequired for optional fields and updates importer functions to reference the new WorkspaceConfig via TYPE_CHECKING, inline comments, and enhanced docstrings.

Class Diagram of New Tmuxp Configuration Types

classDiagram
    class ShellCommandConfig {
        +cmd: str
        +enter: bool (optional)
        +suppress_history: bool (optional)
    }
    class PaneConfig {
        +shell_command: ShellCommandValue (optional)
        +shell_command_before: ShellCommandValue (optional)
        +start_directory: str (optional)
        +environment: dict[str, str] (optional)
        +focus: str | bool (optional)
        +suppress_history: bool (optional)
    }
    class WindowConfig {
        +window_name: str
        +start_directory: str (optional)
        +shell_command_before: ShellCommandValue (optional)
        +layout: str (optional)
        +options: dict[str, Any] (optional)
        +options_after: dict[str, Any] (optional)
        +environment: dict[str, str] (optional)
        +focus: str | bool (optional)
        +suppress_history: bool (optional)
        +panes: list[PaneValue] (optional)
    }
    class WorkspaceConfig {
        +session_name: str | None
        +start_directory: str (optional)
        +before_script: str (optional)
        +shell_command_before: ShellCommandValue (optional)
        +shell_command: ShellCommandValue (optional)
        +environment: dict[str, str] (optional)
        +global_options: dict[str, Any] (optional)
        +options: dict[str, Any] (optional)
        +config: str (optional)
        +socket_name: str (optional)
        +plugins: list[str | PluginConfigSchema] (optional)
        +suppress_history: bool (optional)
        +windows: list[WindowConfig]
    }
    class PluginConfigSchema {
        +plugin_name: str
        +tmux_min_version: str (optional)
        +tmux_max_version: str (optional)
        +tmux_version_incompatible: list[str] (optional)
        +tmuxp_min_version: str (optional)
        +tmuxp_max_version: str (optional)
        +tmuxp_version_incompatible: list[str] (optional)
    }

    WorkspaceConfig "1" *-- "0..*" WindowConfig : windows
    WorkspaceConfig "1" o-- "0..*" PluginConfigSchema : plugins
    WindowConfig "1" *-- "0..*" PaneConfig : panes (via PaneValue)
    PaneConfig ..> ShellCommandConfig : uses (via ShellCommandValue)
    WindowConfig ..> ShellCommandConfig : uses (via ShellCommandValue)
    WorkspaceConfig ..> ShellCommandConfig : uses (via ShellCommandValue)

File-Level Changes

Change	Details	Files
Define detailed configuration types using TypedDict and NotRequired	Added ShellCommandConfig TypedDict with NotRequired flags Introduced PaneConfig and WindowConfig TypedDicts marked total=False Created WorkspaceConfig TypedDict for complete workspace structure Defined union aliases ShellCommandValue and PaneValue for flexible typing	`src/tmuxp/_internal/types.py`
Enhance importer modules with type hints and documentation	Wrapped WorkspaceConfig import in a TYPE_CHECKING guard Augmented function docstrings with Returns section referencing WorkspaceConfig Annotated tmuxp_workspace dict with inline comment noting WorkspaceConfig conformance	`src/tmuxp/workspace/importers.py`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

sourcery-ai Bot reviewed

Jun 7, 2025

View reviewed changes

sourcery-ai Bot left a comment

Copy link

Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @tony - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

sourcery-ai[bot] reacted with thumbs up emoji

sourcery-ai[bot] reacted with thumbs down emoji

All reactions

👍 1 reaction
👎 1 reaction

Comment thread

src/tmuxp/workspace/importers.py Outdated

Comment on lines +18 to +26

		Returns
		-------
		dict
		A dictionary conforming to WorkspaceConfig structure.
		"""
		tmuxp_workspace: dict[str, t.Any] = {}
		tmuxp_workspace: dict[str, t.Any] = {} # Will conform to WorkspaceConfig at the end

sourcery-ai Bot Jun 7, 2025

Copy link

Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Annotate tmuxp_workspace with WorkspaceConfig type

Since WorkspaceConfig is already imported under TYPE_CHECKING, use it to annotate tmuxp_workspace and update the function's return type for better type safety.

Suggested change

	Returns
	-------
	dict
	A dictionary conforming to WorkspaceConfig structure.
	"""
	tmuxp_workspace: dict[str, t.Any] = {}
	tmuxp_workspace: dict[str, t.Any] = {} # Will conform to WorkspaceConfig at the end
	from tmuxp.types import WorkspaceConfig

	def import_tmuxinator(workspace_dict: dict[str, t.Any]) -> WorkspaceConfig:
	"""Return tmuxp workspace from a `tmuxinator`_ yaml workspace.
	Returns
	-------
	WorkspaceConfig
	A dictionary conforming to WorkspaceConfig structure.
	"""
	tmuxp_workspace: WorkspaceConfig = {} # Will conform to WorkspaceConfig at the end

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

sourcery-ai[bot] reacted with thumbs up emoji

sourcery-ai[bot] reacted with thumbs down emoji

All reactions

👍 1 reaction
👎 1 reaction

tony force-pushed the workspace-typings branch 2 times, most recently from 7466b20 to ea9a61f Compare

June 7, 2025 12:44

tony force-pushed the workspace-typings branch from ea9a61f to a4a6010 Compare

June 14, 2025 15:42

tony force-pushed the workspace-typings branch from a4a6010 to 17ca212 Compare

April 26, 2026 10:32

codecov Bot commented Apr 26, 2026 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Codecov Report

❌ Patch coverage is 96.96970% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.73%. Comparing base (98af6d1) to head (650928d).
⚠️ Report is 12 commits behind head on master.

Files with missing lines	Patch %	Lines
src/tmuxp/workspace/importers.py	91.30%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #981      +/-   ##
==========================================
+ Coverage   82.55%   82.73%   +0.18%     
==========================================
  Files          31       31              
  Lines        2768     2809      +41     
  Branches      518      517       -1     
==========================================
+ Hits         2285     2324      +39     
- Misses        346      347       +1     
- Partials      137      138       +1

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

tony force-pushed the workspace-typings branch from 17ca212 to 24a9c33 Compare

June 6, 2026 12:51

tony force-pushed the workspace-typings branch from 24a9c33 to febcb35 Compare

July 4, 2026 14:13

tony force-pushed the master branch from 63172d2 to eeb6912 Compare

July 25, 2026 17:00


          types(workspace-imports) Example typings via NotRequried

650928d

tony force-pushed the workspace-typings branch from febcb35 to 650928d Compare

October 24, 2026 09:57

This branch has not been deployed

No deployments

Reviewers

1 more reviewer

sourcery-ai[bot]

sourcery-ai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

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.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.

GeezerVison

Conversation

tony commented Jun 7, 2025 • edited by sourcery-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai Bot commented Jun 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Class Diagram of New Tmuxp Configuration Types

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai Bot Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Apr 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tony commented Jun 7, 2025 •

edited by sourcery-ai Bot

Loading

Uh oh!

There was an error while loading. Please reload this page.

sourcery-ai Bot commented Jun 7, 2025 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

codecov Bot commented Apr 26, 2026 •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.