Skip to content

fix: correct and standardize tabcmd 2 output messages to match tabcmd 1 - #432

Open
jacalata wants to merge 7 commits into
developmentfrom
jac/fix-output-messages
Open

fix: correct and standardize tabcmd 2 output messages to match tabcmd 1#432
jacalata wants to merge 7 commits into
developmentfrom
jac/fix-output-messages

Conversation

@jacalata

@jacalata jacalata commented Jul 22, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Closes items 1-9 in #429 (item #10, logout redirect, is not applicable with PAT auth).

Motivation

#429 catalogued a set of output-message bugs where tabcmd 2 diverged
from tabcmd 1. Fixing them one at a time would fan out into nine small
PRs; the changes all touch the same formatter or locale-key wiring, so
bundling into one PR made the review path shorter than the divergence
path.

Behavior change

For users:

  • INFO log lines now render with tabcmd 1's ===== prefix by default
    (item Creategroup command  #8 in the issue). Users who prefer the plainer tabcmd 2 style can
    opt out with TABCMD_CLASSIC_OUTPUT=false.
  • listsites output shows human-readable SITEID instead of the site UUID.
  • deletegroup status message uses the group name, not a UUID.
  • createsiteusers error list shows human-readable messages, not the
    raw exception class name.
  • removeusers uses the correct locale key (removeusers.group).
  • Export save message and delete status message no longer render a
    double-space when content type is empty.
  • Login prints a Signing in... status line, matching tabcmd 1.
  • Saved X to 'Y' renders X = content name, Y = destination path
    (previously both slots rendered the destination).
  • Debug detail lines (Fetched user details, error-message detail)
    demoted from INFO to DEBUG.
  • The spurious logging: INFO line no longer appears before every
    command (type mismatch: namespace.logging_level is the string
    "INFO" but was compared against logging.INFO, integer 20; always
    truthy).

The ===== prefix is implemented via a single logger_config.py
formatter change so we don't have to edit every locale string.

Test plan

  • All 339 existing unit tests pass, plus 2 new save_to_file tests
    covering the content_name parameter
  • Manual: tabcmd login / tabcmd logout with default settings
    produce =====-prefixed output
  • Manual: TABCMD_CLASSIC_OUTPUT=false tabcmd login produces plain
    output without the prefix
  • tabcmd listsites shows human-readable SITEID
  • No logging: INFO line appears before command output

🤖 Generated with Claude Code

jacalata and others added 6 commits July 21, 2026 18:44
@jacalata @claude
fix: correct output messages in listsites, deletegroup, export, creat…
32d3857 
…esiteusers, removeusers

- listsites: show site content_url instead of internal UUID for SITEID
- deletegroup: log group name instead of UUID in delete status message
- export/save_to_file: pass filename as content name to fix double-space in "Saved  to '...'" message
- createsiteusers: append str(e) to error_list instead of e.__class__.__name__ so error details show readable messages
- removeusers: use new tabcmd.removeusers.group string key that includes the group name in the status message

Fixes #429

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jacalata @claude
fix: add ===== prefix to all INFO output, fix delete path, suppress d…
1899806 
…ebug noise

- logger_config.py: add ===== prefix to INFO format so all action lines match tabcmd 1 style in one place
- session.py: remove hardcoded ===== from _print_server_info lines (now added by formatter); demote "Fetched user details from server" to debug
- constants.py: demote tabcmd.debug.error_message log call from info to debug so it no longer appears in normal output
- delete_command.py: default content_type to "workbook" in status message to fix double-space when type is undetected
- tabcmd_messages_en.properties: remove hardcoded ===== from tabcmd.listing.header (would double-prefix with formatter)

Closes remaining items from #429

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jacalata @claude
fix: print version/help output directly instead of via logger.info
494c015 
Avoids the ===== prefix being applied to the version/help display.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jacalata @claude
feat: add TABCMD_CLASSIC_OUTPUT env var to enable ===== prefix on output
6d5ff6c 
Plain output is the default. Set TABCMD_CLASSIC_OUTPUT=true (or 1/yes) to
restore the ===== prefix on all INFO-level messages for backward compatibility
with tabcmd 1 output style.

Also moves the version banner in tabcmd_controller to print() so it is never
prefixed regardless of mode.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jacalata @claude
fix: remove spurious 'logging: INFO' printed on every command
0d6dc0a 
The condition compared logging_level string 'INFO' to the integer
logging.INFO (20), which was always True, causing the print to fire
on every invocation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jacalata @claude
fix: add 'Signing in...' message to match tabcmd 1 login output
ee42aa9 
session.login string already existed; add logger.info call at the
start of _sign_in() to surface it as a distinct step after connecting.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 22, 2026 •
edited
Loading

Copy link
Copy Markdown

Coverage

Coverage Report
FileStmtsMissCoverMissing
tabcmd
   __main__.py121212 0%
   _version.py111111 0%
   tabcmd.py151515 0%
   version.py955 44%
tabcmd/commands
   commands.py101010 0%
   constants.py771818 77%
   server.py1351818 87%
tabcmd/commands/auth
   session.py3955050 87%
tabcmd/commands/datasources_and_workbooks
   datasources_and_workbooks_command.py1571818 89%
   datasources_workbooks_views_url_parser.py14255 96%
   delete_command.py601616 73%
   export_command.py1222525 80%
   get_url_command.py1274747 63%
   publish_command.py1232828 77%
   runschedule_command.py2177 67%
tabcmd/commands/extracts
   create_extracts_command.py4288 81%
   decrypt_extracts_command.py2722 93%
   delete_extracts_command.py3766 84%
   encrypt_extracts_command.py2722 93%
   extracts.py2022 90%
   reencrypt_extracts_command.py2722 93%
   refresh_extracts_command.py481010 79%
tabcmd/commands/group
   create_group_command.py2955 83%
   delete_group_command.py2722 93%
tabcmd/commands/project
   create_project_command.py4688 83%
   delete_project_command.py3544 89%
   publish_samples_command.py3044 87%
tabcmd/commands/site
   create_site_command.py3455 85%
   delete_site_command.py2722 93%
   edit_site_command.py3822 95%
   list_command.py771212 84%
   list_sites_command.py2922 93%
tabcmd/commands/user
   add_users_command.py2955 83%
   create_site_users.py581111 81%
   create_users_command.py5999 85%
   delete_site_users_command.py4355 88%
   user_data.py2223131 86%
tabcmd/execution
   _version.py222 0%
   global_options.py12588 94%
   localize.py661111 83%
   logger_config.py6266 90%
   tabcmd_controller.py4077 82%
TOTAL287645884% 

@bcantoni

bcantoni commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

@jacalata looks good - my only question, do we need tabcmd.removeusers.group added to the other language files too?

@jacalata

jacalata commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

@jacalata looks good - my only question, do we need tabcmd.removeusers.group added to the other language files too?

good question. I thought we had a fallback, but we don't. I've implemented that now in #440

@jacalata @claude
Thread content name through save_to_file, default ===== prefix on
1da5af2 
Two follow-up fixes for parity with tabcmd Classic output:

- save_to_file/save_to_data_file previously passed filename twice into
  the "Saved {0} to '{1}'" template, so both slots rendered the same
  path. Classic output was "Saved <content-name> to '<destination>'"
  where the two are distinct. Add a content_name parameter and thread
  export_item.name / get_url_item.name from all four callers.

- TABCMD_CLASSIC_OUTPUT default flipped to true. The stated goal of
  this PR is parity with tabcmd 1 output, and issue #429 item 8 lists
  the missing "=====" prefix as a bug. Users who prefer the plainer
  tabcmd 2 style can opt out with TABCMD_CLASSIC_OUTPUT=false.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jacalata @bcantoni