René's URL Explorer Experiment

Title: Add Tool.default_command() to eliminate duplication in CI steps and help messages by Copilot · Pull Request #1088 · usethis-python/usethis-python · GitHub

Open Graph Title: Add Tool.default_command() to eliminate duplication in CI steps and help messages by Copilot · Pull Request #1088 · usethis-python/usethis-python

X Title: Add Tool.default_command() to eliminate duplication in CI steps and help messages by Copilot · Pull Request #1088 · usethis-python/usethis-python

Description: The get_bitbucket_steps() methods across tool implementations contained significant duplication, repeating the same command strings used in help messages. This PR introduces Tool.default_command() to define commands once and enables a default get_bitbucket_steps() implementation. Changes Core Protocol Method Added default_command() -> str to Tool protocol that returns backend-dependent command strings Returns "uv run [args]" when uv backend is active with uv.lock present Returns " [args]" for none backend or uv without lock file Raises NoDefaultToolCommand exception by default for tools without commands (instead of returning None) Custom Exception Added NoDefaultToolCommand exception in src/usethis/errors.py for tools that don't have associated commands Base get_bitbucket_steps() implementation uses try-except to handle tools without commands Default Implementation Added default get_bitbucket_steps() implementation in base Tool class that uses default_command() Automatically generates appropriate Bitbucket pipeline steps with correct caching and anchors Can be overridden for complex cases (e.g., pytest with multiple Python versions, Ruff with separate linter/formatter) Tool Updates Implemented default_command() in 5 tools: CodespellTool: "codespell" PyprojectFmtTool: "pyproject-fmt pyproject.toml" DeptryTool: "deptry {src_dir}" (dynamic) ImportLinterTool: "lint-imports" PytestTool: "pytest" Note: RuffTool was intentionally excluded as it doesn't have a single default command (has separate linter and formatter commands). Refactored print_how_to_use() methods to use default_command() instead of duplicating command strings. Code Reduction Removed ~160 lines of duplicated get_bitbucket_steps() implementations from simple tools (CodespellTool, PyprojectFmtTool, DeptryTool, ImportLinterTool) that now inherit the default implementation. Example Before: def print_how_to_use(self): if backend is BackendEnum.uv and is_uv_used(): how_print("Run 'uv run codespell' to run the Codespell spellchecker.") else: how_print("Run 'codespell' to run the Codespell spellchecker.") def get_bitbucket_steps(self): if backend is BackendEnum.uv: return [BitbucketStep(script=["uv run codespell"])] # ... duplicated command logic After: def default_command(self) -> str: backend = get_backend() if backend is BackendEnum.uv and is_uv_used(): return "uv run codespell" return "codespell" def print_how_to_use(self): cmd = self.default_command() how_print(f"Run '{cmd}' to run the Codespell spellchecker.") # get_bitbucket_steps() now inherited from base class Fixes #1077 Original prompt This section details on the original issue you should resolve Create a Tool.default_command method To avoid duplication between (and within) get_bitbucket_steps methods for CI, and probably help messages, etc. This would be backend dependent. By default, it should return None, since not all tools have commands. Otherwise, return a string. The individual tool implementations (Tool subclassses), for tools which associated with commands, should provide an implementation. We should use the method anywhere where the default command is used, e.g. help messages, but certainly get_bitbucket_steps methods. Comments on the Issue (you are @copilot in this section) @nathanjmcdougall This will also enable default implementations for `get_bitbucket_steps` methods Fixes #1077 ✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Open Graph Description: The get_bitbucket_steps() methods across tool implementations contained significant duplication, repeating the same command strings used in help messages. This PR introduces Tool.default_command() ...

X Description: The get_bitbucket_steps() methods across tool implementations contained significant duplication, repeating the same command strings used in help messages. This PR introduces Tool.default_command() ...

Opengraph URL: https://github.com/usethis-python/usethis-python/pull/1088

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width