Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete SubprocessExecutor and ShellExecutor #440

Merged
merged 8 commits into from
Oct 27, 2024
Merged

Delete SubprocessExecutor and ShellExecutor #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
37651e7
Delete SubprocessExecutor and ShellExecutor
jan-janssen Oct 27, 2024
8203a3d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 27, 2024
befe209
fix executable path
jan-janssen Oct 27, 2024
4e2e033
Merge remote-tracking branch 'origin/remove_shell' into remove_shell
jan-janssen Oct 27, 2024
33cc16c
execution is too fast
jan-janssen Oct 27, 2024
6a17373
Update test_shell_executor.py
jan-janssen Oct 27, 2024
a3c8eac
Update test_shell_interactive.py
jan-janssen Oct 27, 2024
905953c
One more
jan-janssen Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions executorlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,11 @@
from executorlib.shared.inputcheck import (
check_refresh_rate as _check_refresh_rate,
)
from executorlib.shell.executor import SubprocessExecutor
from executorlib.shell.interactive import ShellExecutor

from ._version import get_versions

__version__ = get_versions()["version"]
__all__ = [
SubprocessExecutor,
ShellExecutor,
]
__all__ = []
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Based on the search results, I can now generate the final response:

Breaking change in public API requires documentation updates

The empty __all__ list removes SubprocessExecutor and ShellExecutor from the public API. The search results show these classes are extensively documented in docs/development.md with examples and usage patterns, but this documentation is now outdated.

  • Update docs/development.md to reflect the removal of SubprocessExecutor and ShellExecutor
  • Add migration guide explaining how to transition from the removed executors to the new unified Executor class
  • Consider adding a deprecation notice in the documentation
🔗 Analysis chain

Document breaking changes in public API.

The empty __all__ list removes previously exported classes (SubprocessExecutor and ShellExecutor) from the public API. This is a breaking change that could affect existing code.

Let's verify the impact:

Consider:

  1. Adding migration guide in documentation
  2. Providing deprecation warnings in previous version
  3. Updating version number to reflect breaking change (major version bump)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for usage of removed executors in the codebase
echo "Searching for SubprocessExecutor usage..."
rg "SubprocessExecutor"

echo "Searching for ShellExecutor usage..."
rg "ShellExecutor"

Length of output: 2282



try:
Expand Down
7 changes: 0 additions & 7 deletions executorlib/shell/__init__.py
View file
Open in desktop

This file was deleted.

96 changes: 0 additions & 96 deletions executorlib/shell/executor.py
View file
Open in desktop

This file was deleted.

184 changes: 0 additions & 184 deletions executorlib/shell/interactive.py
View file
Open in desktop

This file was deleted.

Loading
Loading