refactor: extract _console.py from __init__.py (PR-1/8) by darion-yaphet · Pull Request #2474 · github/spec-kit

darion-yaphet · 2026-05-07T05:10:41Z

Summary

Part 1 of 8 in the __init__.py module split refactor (design spec).

Extracts all Rich UI primitives from the 5880-line __init__.py into a focused _console.py base-layer module.

Moved symbols:

BANNER, TAGLINE — ASCII art constants
StepTracker — live progress tree renderer
get_key, select_with_arrows — interactive keyboard input
BannerGroup, show_banner — Typer banner integration
console — Rich Console singleton

Backward compatibility: All symbols remain importable from specify_cli via re-exports in __init__.py.

Dependency rule: _console.py has zero internal imports (base layer).

Test plan

New regression test tests/test_console_imports.py guards all 8 re-exported symbols
Full suite: 2788 passed, 34 skipped (baseline was 2786)
from specify_cli import console, StepTracker, ... works
specify --help renders banner correctly

Copilot

Pull request overview

This PR is part 1/8 of the specify_cli/__init__.py split refactor, extracting Rich/Typer console UI primitives into a new base-layer module while keeping backward-compatible imports via re-exports from specify_cli.

Changes:

Added src/specify_cli/_console.py containing the Rich console singleton, banner rendering, keyboard input helpers, and StepTracker.
Updated src/specify_cli/__init__.py to import/re-export the extracted console symbols and removed their inlined implementations.
Added a regression test ensuring the extracted symbols remain importable from specify_cli.

Show a summary per file

File	Description
`src/specify_cli/_console.py`	New module housing the extracted Rich UI primitives and Typer banner group.
`src/specify_cli/__init__.py`	Re-exports moved console symbols and removes the inlined implementations.
`tests/test_console_imports.py`	Regression test to guard import compatibility for the re-exported console symbols.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 3/3 changed files
Comments generated: 3

Copilot

Copilot's findings

Files reviewed: 3/3 changed files
Comments generated: 5

mnriem · 2026-05-07T17:32:17Z

Please address Copilot feedback

mnriem

See comment above

darion-yaphet · 2026-05-08T02:36:50Z

See comment above

Don't worry. Don't rush. I will fix these problems.

Copilot

Copilot's findings

Comments suppressed due to low confidence (1)

src/specify_cli/init.py:80

get_key is imported from ._console but not used anywhere in this file; Ruff will flag this as an unused import (F401) during ruff check src/. If it’s meant to be re-exported, mark it as such (e.g., add to __all__ or use a targeted noqa: F401).

    console,
    get_key,
    select_with_arrows,

Files reviewed: 3/3 changed files
Comments generated: 1

Move Rich UI primitives (BANNER, TAGLINE, StepTracker, get_key, select_with_arrows, console, BannerGroup, show_banner) into a new src/specify_cli/_console.py module. Re-export all symbols from __init__.py to preserve the public API. Add regression guard tests.

…ptions - Add module-level docstring documenting the console layer's purpose and the dependency-layering rule (no imports from other specify_cli modules) - Tighten select_with_arrows() signature: options typed as dict[str, str] and default_key as str | None to align with repo typing style - Add early ValueError guard when options is empty, preventing downstream ZeroDivisionError / IndexError inside the Live loop

- Add Callable import from collections.abc for precise callback typing - Annotate StepTracker._refresh_cb as Callable[[], None] | None - Add parameter/return types to attach_refresh() - Use explicit keyword form typer.Exit(code=1) across all error exits - Add blank line between StepTracker class and get_key() (PEP 8) - Add regression test for select_with_arrows() raising ValueError on empty options dict

- Add explicit __all__ for intentional re-exports (BANNER, TAGLINE, get_key) - Prevent F401 unused import errors in CI lint checks - Maintain backward compatibility for external imports

Copilot

Copilot's findings

Files reviewed: 3/3 changed files
Comments generated: 1

mnriem

Please address Copilot feedback

The CLI package intentionally re-exports console helpers for compatibility, so __all__ must track that public surface instead of narrowing star imports to a partial set. Constraint: Existing tests import console helpers directly from specify_cli Rejected: Remove __all__ entirely | keeping an explicit export list documents the intended compatibility surface Confidence: high Scope-risk: narrow Directive: Keep __all__ synchronized when adding or removing specify_cli public re-exports Tested: uv run pytest tests/test_console_imports.py -q

Copilot

Copilot's findings

Files reviewed: 3/3 changed files
Comments generated: 1

mnriem · 2026-05-12T16:11:22Z

Please address Copilot feedback

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

darion-yaphet · 2026-05-12T16:25:06Z

Please address Copilot feedback

Perhaps I need a testing method. The current approach is just too inefficient

mnriem · 2026-05-12T17:05:04Z

The reviews are not always that efficient, but they are necessary so we do not regress and also cover the corner cases. Unfortunately it does NOT show it all in one go so we have to go through these review cycles. Note we also go through the same cycles so we feel the same pain!

Copilot

Copilot's findings

Files reviewed: 3/3 changed files
Comments generated: 0 new

mnriem · 2026-05-12T17:31:12Z

Please address Test & Lint errors

Use `X as X` form for BANNER, TAGLINE, and get_key imports to mark them as intentional public re-exports and silence ruff F401 lint errors.

Copilot

Copilot's findings

Files reviewed: 3/3 changed files
Comments generated: 0 new

mnriem · 2026-05-13T13:57:22Z

Thank you!

darion-yaphet requested a review from mnriem as a code owner May 7, 2026 05:10

darion-yaphet force-pushed the refactor/split-init-pr1 branch from 7051a67 to 17111c5 Compare May 7, 2026 05:11

darion-yaphet mentioned this pull request May 7, 2026

refactor: modularize monolithic __init__.py into command-specific submodules #2461

Closed

5 tasks

mnriem requested a review from Copilot May 7, 2026 16:03

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread src/specify_cli/_console.py

Comment thread src/specify_cli/_console.py Outdated

Comment thread src/specify_cli/_console.py

darion-yaphet force-pushed the refactor/split-init-pr1 branch from 7da5416 to 0fd5a0c Compare May 7, 2026 16:35

mnriem requested a review from Copilot May 7, 2026 17:27

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread src/specify_cli/_console.py

Comment thread src/specify_cli/_console.py

Comment thread src/specify_cli/_console.py

Comment thread src/specify_cli/_console.py Outdated

Comment thread src/specify_cli/_console.py Outdated

mnriem requested changes May 7, 2026

View reviewed changes

darion-yaphet requested a review from mnriem May 8, 2026 02:54

darion-yaphet force-pushed the refactor/split-init-pr1 branch from 56356dd to 9d6df93 Compare May 8, 2026 03:31

mnriem requested a review from Copilot May 8, 2026 22:53

Copilot started reviewing on behalf of mnriem May 8, 2026 22:54 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Comment thread src/specify_cli/__init__.py

darion-yaphet added 4 commits May 12, 2026 01:08

style(cli): add __all__ declaration to fix Ruff F401 lint warnings

f01fdfa

- Add explicit __all__ for intentional re-exports (BANNER, TAGLINE, get_key) - Prevent F401 unused import errors in CI lint checks - Maintain backward compatibility for external imports

darion-yaphet force-pushed the refactor/split-init-pr1 branch from 9b942c9 to f01fdfa Compare May 11, 2026 17:09

mnriem requested a review from Copilot May 12, 2026 01:04

Copilot started reviewing on behalf of mnriem May 12, 2026 01:05 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

Comment thread src/specify_cli/__init__.py Outdated

mnriem requested changes May 12, 2026

View reviewed changes

mnriem requested a review from Copilot May 12, 2026 13:42

Copilot started reviewing on behalf of mnriem May 12, 2026 13:43 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

Comment thread src/specify_cli/__init__.py Outdated

Potential fix for pull request finding

64222f5

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

mnriem requested a review from Copilot May 12, 2026 17:03

Copilot started reviewing on behalf of mnriem May 12, 2026 17:04 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

style(cli): use explicit re-export syntax to fix ruff F401 warnings

aeb09a2

Use `X as X` form for BANNER, TAGLINE, and get_key imports to mark them as intentional public re-exports and silence ruff F401 lint errors.

mnriem requested a review from Copilot May 13, 2026 12:43

Copilot AI reviewed May 13, 2026

View reviewed changes

mnriem self-requested a review May 13, 2026 13:56

mnriem approved these changes May 13, 2026

View reviewed changes

mnriem merged commit 4f51e06 into github:main May 13, 2026
15 checks passed

Conversation

darion-yaphet commented May 7, 2026

Summary

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnriem commented May 7, 2026

Uh oh!

mnriem left a comment

Choose a reason for hiding this comment

Uh oh!

darion-yaphet commented May 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

mnriem left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

mnriem commented May 12, 2026

Uh oh!

darion-yaphet commented May 12, 2026

Uh oh!

mnriem commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

mnriem commented May 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

mnriem commented May 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mnriem commented May 12, 2026 •

edited

Loading