fix: Refactor command and model modules for readability and maintainability (#231) by sergio-sisternes-epam · Pull Request #232 · microsoft/apm

Sergio Sisternes (sergio-sisternes-epam) · 2026-03-10T18:31:31Z

Description

Phased refactoring of command and model modules to bring all files under code quality thresholds (400-line file limit, 30-statement function limit).

Fixes#231

Type of change

Bug fix
New feature
Documentation
Maintenance / refactor

Testing

Tested locally
All existing tests pass
Added tests for new functionality (if applicable)

Copilot

Pull request overview

This PR continues the phased refactor of APM command/model code by extracting shared constants and typed result containers, reorganizing dependency/uninstall/compile/deps modules into smaller submodules, and tightening some overly-broad exception handling.

Changes:

Introduces src/apm_cli/constants.py and replaces hard-coded filenames/dirs across commands/models.
Extracts typed result containers (InstallResult, PrimitiveCounts) and updates install tests/mocks accordingly.
Splits large modules into packages/submodules (dependency models, uninstall command, deps helpers, compile watcher) and narrows some except Exception clauses.

Reviewed changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/unit/test_install_command.py	Updates mocks to use `InstallResult` instead of a tuple.
src/apm_cli/models/validation.py	Uses shared constants for filenames/dirs; narrows exception types.
src/apm_cli/models/results.py	Adds typed dataclass result containers.
src/apm_cli/models/dependency/types.py	Extracts enums/dataclasses and `parse_git_reference`.
src/apm_cli/models/dependency/reference.py	Moves `DependencyReference` parsing logic into a dedicated module.
src/apm_cli/models/dependency/mcp.py	Moves `MCPDependency` into its own module.
src/apm_cli/models/dependency/init.py	Re-exports dependency types/models from the new package.
src/apm_cli/models/dependency.py	Removes the former 1000+ line dependency “god file”.
src/apm_cli/models/init.py	Exposes `InstallResult`/`PrimitiveCounts` at the models package level.
src/apm_cli/constants.py	Adds shared constants (filenames/dirs) and `InstallMode` enum.
src/apm_cli/commands/update.py	Narrows exception handling in update flow.
src/apm_cli/commands/uninstall/engine.py	Introduces uninstall engine helpers (validation/removal/cleanup/reintegration).
src/apm_cli/commands/uninstall/cli.py	Introduces a new uninstall CLI wiring that delegates to the engine.
src/apm_cli/commands/uninstall/init.py	Exposes uninstall command and helper functions from the new package.
src/apm_cli/commands/uninstall.py	Removes the former monolithic uninstall implementation.
src/apm_cli/commands/runtime.py	Narrows broad exception handling.
src/apm_cli/commands/run.py	Narrows broad exception handling in script listing/execution.
src/apm_cli/commands/prune.py	Uses shared constants; narrows exceptions; restructures deployed-file cleanup loop.
src/apm_cli/commands/mcp.py	Narrows broad exception handling around registry calls.
src/apm_cli/commands/list_cmd.py	Narrows broad exception handling in Rich fallback.
src/apm_cli/commands/install.py	Uses shared constants; adds `InstallMode`; returns `InstallResult`; extracts integration helper.
src/apm_cli/commands/init.py	Uses shared constants; narrows prompt exception handling.
src/apm_cli/commands/deps/cli.py	Fixes imports, uses constants, and moves helper logic to `deps/_utils.py`.
src/apm_cli/commands/deps/_utils.py	New helper module for deps commands (counts, nested detection, updates).
src/apm_cli/commands/deps/init.py	Exposes deps CLI and helpers via package exports.
src/apm_cli/commands/config.py	Uses shared constants for `apm.yml` checks.
src/apm_cli/commands/compile/watcher.py	Extracts watch-mode logic into a dedicated module.
src/apm_cli/commands/compile/cli.py	Uses shared constants; factors out summary/next-step display; imports watcher module.
src/apm_cli/commands/compile/init.py	Exposes compile command and helper functions via package exports.
src/apm_cli/commands/_helpers.py	Uses shared constants; narrows exceptions; updates gitignore handling.
.vscode/tasks.json	Adds local VS Code tasks (currently machine-path specific).

You can also share your feedback on Copilot code review. Take the survey.

Phases 1-5 of command/model refactoring: - Extract constants and narrow exception handlers - Decompose god functions into focused helpers - Add InstallMode and VirtualPackageType enums - Split god files into focused sub-modules - Flatten nesting and add typed result dataclasses - Address Copilot review feedback - Clean-up support tasks

Copilot

Pull request overview

Copilot reviewed 26 out of 26 changed files in this pull request and generated 7 comments.

…d dead code - Remove unused APM_MODULES_DIR import from compile/watcher.py - Remove trailing whitespace in models/dependency/types.py - Remove dead APM_DEPS_AVAILABLE conditional import pattern from uninstall/cli.py and engine.py - Remove unused shutil import from uninstall/engine.py - Remove unused yaml import from prune.py - Remove apm.code-workspace from tracking and add *.code-workspace to .gitignore Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Sergio Sisternes (sergio-sisternes-epam) · 2026-03-19T20:24:18Z

Addressing Copilot Review Feedback — `6940765`

All 7 new review comments resolved:

Comment	File	Resolution
Unused `APM_MODULES_DIR` import	`compile/watcher.py`	✅ Removed
Hardcoded `apm.code-workspace`	repo root	✅ Removed from tracking, added `*.code-workspace` to `.gitignore`
Trailing whitespace	`dependency/types.py`	✅ Removed
`@alias` parsing in `reference.py`	`dependency/reference.py`	ℹ️ Pre-existing by design — shorthand `@alias` was intentionally removed (see `test_package_identity.py` tests). Alias is only set via YAML `alias:` field.
Dead `APM_DEPS_AVAILABLE` guard	`uninstall/cli.py`	✅ Removed — switched to direct imports
Unused `shutil` + dead guard	`uninstall/engine.py`	✅ Removed both
Unused `yaml` import	`prune.py`	✅ Removed

All 2104 unit tests passing.

…bility (#231) (#232) * refactor: split god files into focused sub-modules (#231) Phases 1-5 of command/model refactoring: - Extract constants and narrow exception handlers - Decompose god functions into focused helpers - Add InstallMode and VirtualPackageType enums - Split god files into focused sub-modules - Flatten nesting and add typed result dataclasses - Address Copilot review feedback - Clean-up support tasks * refactor: address Copilot review feedback — cleanup unused imports and dead code - Remove unused APM_MODULES_DIR import from compile/watcher.py - Remove trailing whitespace in models/dependency/types.py - Remove dead APM_DEPS_AVAILABLE conditional import pattern from uninstall/cli.py and engine.py - Remove unused shutil import from uninstall/engine.py - Remove unused yaml import from prune.py - Remove apm.code-workspace from tracking and add *.code-workspace to .gitignore Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Sergio Sisternes <sergio.sisternes@epam.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Daniel Meppiel <51440732+danielmeppiel@users.noreply.github.com>

Sergio Sisternes (sergio-sisternes-epam) marked this pull request as ready for review March 10, 2026 21:37

Sergio Sisternes (sergio-sisternes-epam) requested a review from Daniel Meppiel (danielmeppiel) as a code owner March 10, 2026 21:37

CopilotAI review requested due to automatic review settings March 10, 2026 21:37

Copilotstarted reviewing on behalf of Sergio Sisternes (sergio-sisternes-epam)March 10, 2026 21:38 View session

CopilotAI reviewed Mar 10, 2026
View reviewed changes

Comment threadsrc/apm_cli/commands/install.py Outdated
Comment threadsrc/apm_cli/models/dependency/reference.py Outdated
Comment threadsrc/apm_cli/commands/uninstall/cli.py Outdated
Comment threadsrc/apm_cli/commands/uninstall/engine.py Outdated
Comment threadsrc/apm_cli/commands/install.py Outdated

Sergio Sisternes (sergio-sisternes-epam)force-pushed the fix/231-refactor-command-model-modules branch from f0285cd to 425f12eCompare March 11, 2026 19:05

Sergio Sisternes (sergio-sisternes-epam)force-pushed the fix/231-refactor-command-model-modules branch from c9c2e66 to 2437fd1Compare March 19, 2026 19:45

Sergio Sisternes (sergio-sisternes-epam) requested a review from Copilot March 19, 2026 20:10

Copilotstarted reviewing on behalf of Sergio Sisternes (sergio-sisternes-epam)March 19, 2026 20:12 View session

CopilotAI reviewed Mar 19, 2026
View reviewed changes

Daniel Meppiel (danielmeppiel) approved these changes Mar 19, 2026
View reviewed changes

Merge branch 'main' into fix/231-refactor-command-model-modules
beaa4ab

Daniel Meppiel (danielmeppiel) merged commit cc4cc28 into microsoft:mainMar 19, 2026
7 checks passed

This was referenced Mar 20, 2026
[docs] Update compilation guide — add opencode target, fix vscode alias #381
Closed
chore: release v0.8.3 #386
Merged

This was referenced Mar 21, 2026
[ca] Update APM (Agent Package Manager) to v0.8.3 github/gh-aw#22118
Closed
[ca] CLI Version Update: MCP Gateway v0.1.20→v0.1.22, APM v0.8.2→v0.8.3 github/gh-aw#22258
Closed

CopilotAI mentioned this pull request Mar 22, 2026
chore: bump MCP Gateway v0.1.20→v0.1.22, APM v0.8.2→v0.8.3 github/gh-aw#22299
Merged

Navigation Menu

Uh oh!

fix: Refactor command and model modules for readability and maintainability (#231) - #232

fix: Refactor command and model modules for readability and maintainability (#231)#232
Daniel Meppiel (danielmeppiel) merged 3 commits into
microsoft:mainfrom
sergio-sisternes-epam:fix/231-refactor-command-model-modules

Sergio Sisternes (sergio-sisternes-epam) commented Mar 10, 2026

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sergio Sisternes (sergio-sisternes-epam) commented Mar 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Sergio Sisternes (sergio-sisternes-epam) commented Mar 10, 2026

Description

Type of change

Testing

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sergio Sisternes (sergio-sisternes-epam) commented Mar 19, 2026

Addressing Copilot Review Feedback — 6940765

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Addressing Copilot Review Feedback — `6940765`