Improve CLI Tables and IDs handling #4241

safoinme · 2025-11-21T22:05:39Z

Describe changes

This PR refactors the ZenML CLI table rendering system to:

Enable pipeable output (JSON/YAML/CSV/TSV) by separating stdout/stderr
Consolidate table rendering logic into centralized functions
Improve table aesthetics with intelligent column sizing
Simplify CLI command implementations across artifact, model, tag, and deployment commands

Key technical changes:

New zenml_cli module for stdout/stderr routing
New rendering functions: render_list_output(), handle_output(), prepare_output()
Enhanced list_options decorator with auto-rendering support
Column width management with protected widths for IDs (36), URLs (40), status (18)

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Add missing parameter documentation and return values for CLI display functions to resolve CI docstring validation errors. This includes fixes for service connectors, table utilities, tags, pipelines, stack components, models, artifacts, authorized devices, secrets, and service accounts. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Complete the docstring fixes for artifact versions and ensure all critical CLI table functions have proper parameter and return documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Add missing Args and Returns sections to functions in model.py - Fix docstring issues in stack_components.py flavor functions - Add parameter documentation to code_repository.py - Fix utils.py print_page_info docstring - Complete user_management.py docstring documentation - Add missing documentation to project.py functions All darglint docstring validation errors are now resolved for CLI files. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Fix Page[T] vs List[Any] type mismatches in prepare_list_data calls - Add type ignore comments for model_dump no-any-return issues - Fix missing type annotations in user_management.py - Handle object vs List[Any] issues with proper type ignore comments - Ensure proper handling of paginated vs non-paginated responses Resolves all remaining mypy errors that were causing CI failures. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Fix line formatting in project.py, service_accounts.py, tag.py, user_management.py - Ensure consistent formatting across all modified CLI files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

znegrin · 2025-11-25T10:03:37Z

If I do zenml artifact version list it shows weird spacing between rows:

I think it is probably related to this column:

Same with model versions:

safoinme · 2025-11-25T10:20:50Z

@znegrin all the issues you pointed have been adressed, the issue behind this is that we needed to specify which default column to pass. the extra spacing is also adressed

znegrin · 2025-11-25T10:23:02Z

After checking a few outputs, I feel we could add some spacing, maybe always having one space before the list header, and showing the pagination between two spaces to make it cleaner. Also having a bit of padding to the left of the list so it is not so tight. Example:

Existing:

Proposal:

Json-Andriopoulos

Added a few comments here and there - some are suggestions/enhancements but we should mainly on the comments regarding rendering consistency.

Good work overall!

src/zenml/cli/stack.py

src/zenml/cli/utils.py

docs/book/reference/global-settings.md

docs/book/reference/environment-variables.md

src/zenml/cli/artifact.py

src/zenml/cli/stack.py

src/zenml/cli/stack_components.py

src/zenml/cli/pipeline.py

src/zenml/cli/secret.py

src/zenml/cli/server.py

src/zenml/cli/service_connectors.py

src/zenml/cli/user_management.py

src/zenml/models/v2/base/page.py

safoinme · 2025-11-25T11:40:47Z

@znegrin @Json-Andriopoulos @schustmi @bcdurak all clear comments are adressed, i have left some unresolved because i didn't understand or we have decided in the spec to follow different approach for

bcdurak

Just found one more small detail. Also unresolved and left a comment regarding the piping.

src/zenml/cli/stack_components.py

…-io/zenml into feature/improve-cli-tables

schustmi · 2025-11-28T06:19:38Z

pyproject.toml

 requires = ["uv_build >= 0.8.17, <0.9.0"]
 build-backend = "uv_build"

+[tool.uv.build-backend]


@safoinme Can you check if this behaves correctly in the following cases:

Fresh install in a virtualenv

Upgrading an existing ZenML installation

yes both works

…-io/zenml into feature/improve-cli-tables

znegrin and others added 30 commits July 30, 2025 11:18

Improving the list outputs and adding new formats

f5d863b

Merge develop into feat/improved-cli-tables

78af737

Fix type annotation for overflow parameter in table_utils

4ecfdfc

Update service connector table to bring back previous data

6403d92

🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Merge branch 'develop' into feat/improved-cli-tables

4514cfc

Apply code formatting to CLI files

ebebd80

- Fix line formatting in project.py, service_accounts.py, tag.py, user_management.py - Ensure consistent formatting across all modified CLI files 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Merge branch 'develop' into feat/improved-cli-tables

038940d

fix one test

7bed4be

removed unused import

bf13b44

new module for the CLI

fbeef0c

merged develop

15d2247

formatting

783304d

Merge branch 'develop' into feat/improved-cli-tables

a0b63dd

new changes

a36632a

removing warning suppresion

ff9acec

Merge branch 'develop' into feat/improved-cli-tables

6fb4e3c

checkpoint

79e75a7

some other fixes

4eea33f

merged

8fa6b5a

docstring changes

c383943

merged develop, resolved conflicts

783f8eb

removed unused stuff

81045c5

new formatting

277e774

docstrings and linting

932d61d

Merge branch 'develop' into feat/improved-cli-tables

6ef6bc7

formatting linting

39a7c43

zuri review

8036df0

Json-Andriopoulos requested changes Nov 25, 2025

View reviewed changes

bcdurak requested changes Nov 25, 2025

View reviewed changes

safoinme added 2 commits November 25, 2025 12:34

reviews

349a7f9

highlight syntax for json and yaml - iason review

503b54f

safoinme requested review from Json-Andriopoulos and bcdurak November 25, 2025 11:39

safoinme requested review from schustmi and znegrin November 25, 2025 11:45

bcdurak requested changes Nov 25, 2025

View reviewed changes

src/zenml/cli/stack_components.py Show resolved Hide resolved

safoinme requested a review from bcdurak November 25, 2025 15:25

safoinme and others added 10 commits November 25, 2025 16:26

last round of review

0179b60

Merge branch 'develop' into feature/improve-cli-tables

5ae3a09

update pyproject to match uv build

e2b5b7f

Merge branch 'feature/improve-cli-tables' of https://github.com/zenml…

1a20b51

…-io/zenml into feature/improve-cli-tables

iason review

6d1ed4f

update dockerfiles

4defc73

fix resource process

a5aaa67

fix details tables

88899c3

Merge branch 'develop' into feature/improve-cli-tables

18fc1f9

Merge branch 'develop' into feature/improve-cli-tables

bf89631

Json-Andriopoulos approved these changes Nov 27, 2025

View reviewed changes

Merge branch 'develop' into feature/improve-cli-tables

cd14186

schustmi reviewed Nov 28, 2025

View reviewed changes

safoinme added 2 commits November 28, 2025 08:48

fix service connector error

9e75e1c

Merge branch 'feature/improve-cli-tables' of https://github.com/zenml…

28d9da0

…-io/zenml into feature/improve-cli-tables

Improve CLI Tables and IDs handling #4241

Are you sure you want to change the base?

Improve CLI Tables and IDs handling #4241

Conversation

safoinme commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe changes

Pre-requisites

Types of changes

Uh oh!

znegrin commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

safoinme commented Nov 25, 2025

Uh oh!

znegrin commented Nov 25, 2025

Uh oh!

Json-Andriopoulos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

safoinme commented Nov 25, 2025

Uh oh!

bcdurak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

schustmi Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

safoinme Nov 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

safoinme commented Nov 21, 2025 •

edited

Loading

znegrin commented Nov 25, 2025 •

edited

Loading