[CLI] migrate `hf jobs` to `out` singleton by hanouticelina · Pull Request #4254 · huggingface/huggingface_hub

hanouticelina · 2026-05-22T17:17:50Z

Last piece of #3979.
This PR migrates hf jobs to the out framework.

breaking changes introduced in hf jobs ps and hf jobs scheduled ps (I think it's fine, the alternative would be special casing _output.py justfor these two list commands) :

1. --format table is removed. Use --format auto|human|agent|quiet|json.
2. json output shape changed for hf jobs ps:
- command is now a string (e.g. "python script.py"), was a list (e.g.
["python", "script.py"]).
- status is now a string (e.g. "RUNNING"), was a dict (e.g. {"stage": "RUNNING").

Note

Medium Risk
User-visible CLI breaking changes on hf jobs ps and hf jobs scheduled ps (format flags and JSON field shapes); behavior is otherwise presentation-layer only for jobs commands.

Overview
Migrates the hf jobs command group to the shared out CLI output layer (out.result, out.table, out.dict, out.text, out.warning, out.hint) instead of ad-hoc print / json.dumps / print_list_output.

hf jobs ps and hf jobs scheduled ps now use --format auto|human|agent|json|quiet (default auto) with optional Go-style templates ({{.id}}). --format table and -q / --quiet are removed; quiet IDs come from --format quiet. For hf jobs ps, JSON output flattens command to a string and status to a stage string (not a list or nested object). Inspect/labels and lifecycle commands get consistent structured output; docs for the list commands are regenerated to match.

_output.Output.set_mode accepts string mode names (e.g. 'agent') in addition to the enum.

^{Reviewed by Cursor Bugbot for commit 63b352d. Bugbot is set up for automated code reviews on this repo. Configure here.}

bot-ci-comment · 2026-05-22T17:27:46Z

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Wauplin

Thanks for migrating this! Most comments are related to templating, which I think we should drop for the sake of simplicity

Wauplin · 2026-05-26T13:14:36Z

-
+    out.result("Job started", id=job.id, url=job.url)
    if detach:
+        out.hint(f"Use `hf jobs logs {job.id}` to fetch the logs.")


cursor

Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 56dfd66. Configure here.}

@Wauplin

* Update src/huggingface_hub/cli/jobs.py * Update src/huggingface_hub/cli/jobs.py * Apply suggestion from @Wauplin * Apply suggestion from @Wauplin * Update src/huggingface_hub/cli/jobs.py * Update src/huggingface_hub/cli/jobs.py --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

Wauplin · 2026-05-26T14:12:51Z

Merged #4265 to use out singleton in labels commands as well (related to #4252 (review))

…ce/huggingface_hub into cli-migrate-jobs-out-singleton

hanouticelina · 2026-05-26T14:29:17Z

@Wauplin thanks for the review! addressed your comments in c12a350

github-actions

Pinact found unpinned actions in this repo.

Auto-fixable, but outside this PR's diff (run pinact run locally and commit):

.github/workflows/model_card_consistency_reminder.yml:15 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-prerelease.yml:34 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-quality.yml:23 — - actions/checkout@v6 → - actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-quality.yml:25 — actions/setup-python@v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:22 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:57 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:174 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:293 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:348 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:435 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:555 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:690 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:1018 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/style-bot-action.yml:184 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/sync-hf-cli-skill.yml:17 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/sync-hf-cli-skill.yml:20 — actions/setup-python@v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/sync-hf-cli-skill.yml:46 — actions/create-github-app-token@v3 → actions/create-github-app-token@bcd2ba4921… # v3.2.0
.github/workflows/sync-hf-cli-skill.yml:53 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/sync-hf-cli-skill.yml:60 — astral-sh/setup-uv@v7 → astral-sh/setup-uv@37802adc94… # v7.6.0
.github/workflows/sync-hf-cli-skill.yml:86 — peter-evans/create-pull-request@v8 → peter-evans/create-pull-request@5f6978faf0… # v8.1.1
.github/workflows/build_repocard_examples.yaml:18 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/update-inference-types.yaml:22 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/update-inference-types.yaml:37 — - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 → - actions/setup-node@48b55a011b… # v6.4.0
.github/workflows/update-inference-types.yaml:71 — peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8 → peter-evans/create-pull-request@5f6978faf0… # v8.1.1

github-actions

Pinact found unpinned actions in this repo.

Auto-fixable, but outside this PR's diff (run pinact run locally and commit):

.github/workflows/model_card_consistency_reminder.yml:15 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-prerelease.yml:34 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-quality.yml:23 — - actions/checkout@v6 → - actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-quality.yml:25 — actions/setup-python@v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:22 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:57 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:174 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:293 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:348 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:435 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:555 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:690 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:1018 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/style-bot-action.yml:184 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/sync-hf-cli-skill.yml:17 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/sync-hf-cli-skill.yml:20 — actions/setup-python@v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/sync-hf-cli-skill.yml:46 — actions/create-github-app-token@v3 → actions/create-github-app-token@bcd2ba4921… # v3.2.0
.github/workflows/sync-hf-cli-skill.yml:53 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/sync-hf-cli-skill.yml:60 — astral-sh/setup-uv@v7 → astral-sh/setup-uv@37802adc94… # v7.6.0
.github/workflows/sync-hf-cli-skill.yml:86 — peter-evans/create-pull-request@v8 → peter-evans/create-pull-request@5f6978faf0… # v8.1.1
.github/workflows/build_repocard_examples.yaml:18 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/update-inference-types.yaml:22 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/update-inference-types.yaml:37 — - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 → - actions/setup-node@48b55a011b… # v6.4.0
.github/workflows/update-inference-types.yaml:71 — peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8 → peter-evans/create-pull-request@5f6978faf0… # v8.1.1

github-actions

Pinact found unpinned actions in this repo.

Auto-fixable, but outside this PR's diff (run pinact run locally and commit):

.github/workflows/model_card_consistency_reminder.yml:15 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-prerelease.yml:34 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-quality.yml:23 — - actions/checkout@v6 → - actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/python-quality.yml:25 — actions/setup-python@v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:22 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:57 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/python-tests.yml:174 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:293 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:348 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:435 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:555 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:690 — - actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → - actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/release.yml:1018 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/style-bot-action.yml:184 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/sync-hf-cli-skill.yml:17 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/sync-hf-cli-skill.yml:20 — actions/setup-python@v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/sync-hf-cli-skill.yml:46 — actions/create-github-app-token@v3 → actions/create-github-app-token@bcd2ba4921… # v3.2.0
.github/workflows/sync-hf-cli-skill.yml:53 — actions/checkout@v6 → actions/checkout@de0fac2e45… # v6.0.2
.github/workflows/sync-hf-cli-skill.yml:60 — astral-sh/setup-uv@v7 → astral-sh/setup-uv@37802adc94… # v7.6.0
.github/workflows/sync-hf-cli-skill.yml:86 — peter-evans/create-pull-request@v8 → peter-evans/create-pull-request@5f6978faf0… # v8.1.1
.github/workflows/build_repocard_examples.yaml:18 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/update-inference-types.yaml:22 — actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6 → actions/setup-python@a309ff8b42… # v6.2.0
.github/workflows/update-inference-types.yaml:37 — - actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6 → - actions/setup-node@48b55a011b… # v6.4.0
.github/workflows/update-inference-types.yaml:71 — peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8 → peter-evans/create-pull-request@5f6978faf0… # v8.1.1

Wauplin

Thank you!

huggingface-hub-bot · 2026-05-28T15:12:42Z

This PR has been shipped as part of the v1.17.0 release.

hanouticelina added 4 commits May 22, 2026 18:02

migrate jobs

1417d6a

revert unnecessary changes

4ceb1ab

migrate jobs ps

26e9194

headers

194b7d8

hanouticelina commented May 22, 2026

View reviewed changes

Comment thread src/huggingface_hub/cli/_output.py Outdated

Comment thread src/huggingface_hub/cli/jobs.py Outdated

Merge branch 'main' into cli-migrate-jobs-out-singleton

02d6782

hanouticelina marked this pull request as ready for review May 22, 2026 17:21

hanouticelina requested a review from Wauplin May 22, 2026 17:21

hanouticelina changed the title ~~[CLI] migrate hf jobs to `out singleton~~ [CLI] migrate hf jobs to out singleton May 22, 2026

hanouticelina mentioned this pull request May 26, 2026

[Jobs] Add update_job_labels and update_scheduled_job_labels #4252

Merged

Wauplin reviewed May 26, 2026

View reviewed changes

Merge branch 'main' into cli-migrate-jobs-out-singleton

56dfd66

cursor Bot reviewed May 26, 2026

View reviewed changes

Comment thread src/huggingface_hub/cli/jobs.py Outdated

Comment thread src/huggingface_hub/cli/jobs.py

Wauplin and others added 2 commits May 26, 2026 16:10

fix

63b352d

hanouticelina added 2 commits May 26, 2026 16:26

review suggestion

c12a350

Merge branch 'cli-migrate-jobs-out-singleton' of github.com:huggingfa…

c9d7d1e

…ce/huggingface_hub into cli-migrate-jobs-out-singleton

hanouticelina requested a review from Wauplin May 26, 2026 14:28

Wauplin reviewed May 26, 2026

View reviewed changes

hanouticelina added 2 commits May 26, 2026 18:02

fixes

99c3559

Merge branch 'main' into cli-migrate-jobs-out-singleton

080bc84

github-actions Bot reviewed May 26, 2026

View reviewed changes

Merge branch 'main' into cli-migrate-jobs-out-singleton

4474477

github-actions Bot reviewed May 26, 2026

View reviewed changes

hanouticelina requested a review from Wauplin May 26, 2026 17:35

Wauplin approved these changes May 27, 2026

View reviewed changes

Wauplin mentioned this pull request May 27, 2026

[Internal] Run pinact (lock versions in workflow files) #4275

Merged

hanouticelina merged commit c67501c into main May 27, 2026
24 of 25 checks passed

hanouticelina deleted the cli-migrate-jobs-out-singleton branch May 27, 2026 08:54

Conversation

hanouticelina commented May 22, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bot-ci-comment Bot commented May 22, 2026

Uh oh!

Wauplin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Wauplin May 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Wauplin commented May 26, 2026

Uh oh!

hanouticelina commented May 26, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Wauplin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

huggingface-hub-bot Bot commented May 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hanouticelina commented May 22, 2026 •

edited by cursor Bot

Loading