cli: Add possibility to specify aliases for CLI option by matejmatuska · Pull Request #910 · oamg/leapp

matejmatuska · 2025-09-19T10:28:39Z

The existing 'name' and 'short_name' parameters are kept as is for backwards compatibility.

Also a dest parameter is added for specifying the name of the attribute to be added to the parsed args object.

The change is backwards compatible, bump the framework-version to 6.2.

Jira: RHEL-110563 (related)

Example help text:

[root@localhost ~]# leapp upgrade --help
usage: leapp upgrade [-h] [--nogpgcheck] [--report-schema {1.0.0,1.1.0,1.2.0}] [--target-os {rhel,centos,almalinux}]
                     [--target TARGET_VERSION] [--iso ISO] [--channel {ga,e4s,eus,aus}] [--enablerepo <repoid>]
                     [--no-rhsm-facts] [--no-insights-register] [--no-rhsm] [--verbose] [--debug]
                     [--enable-experimental-feature Feature] [--whitelist-experimental ActorName] [--reboot]
                     [--resume]

Description:

Upgrade the current system to the next available major version.

Optional arguments:
  -h, --help            show this help message and exit
  --nogpgcheck          Disable RPM GPG checks. Same as yum/dnf --nogpgcheck option.
  --report-schema {1.0.0,1.1.0,1.2.0}
                        Specify report schema version for leapp-report.json
  --target TARGET_VERSION, --target-version TARGET_VERSION                                        <------
                        Specify RHEL version to upgrade to for default detected upgrade flavour

The alias is listed after the name and the argument "hint" (TARGET_VERSION) is created from dest which is target_version.
The option is defined like this:

@command_opt(
    'target',
    help='Specify RHEL version to upgrade to for {} detected upgrade flavour'.format(
        command_utils.get_upgrade_flavour()
    ),
    aliases=['target-version'],
    dest='target_version',
)

github-actions · 2025-09-19T10:28:47Z

Thank you for contributing to the Leapp project!

Please note that every PR needs to comply with the Leapp Guidelines and must pass all tests in order to be mergeable.
If you want to request a review or rebuild a package in copr, you can use following commands as a comment:

review please @oamg/developers to notify leapp developers of the review request
/packit copr-build to submit a public copr build using packit

To launch regression testing public members of oamg organization can leave the following comment:

/rerun to schedule basic regression tests using this pr build and leapp-repository*main* as artifacts
/rerun 42 to schedule basic regression tests using this pr build and leapp-repository*PR42* as artifacts
/rerun-sst to schedule sst tests using this pr build and leapp-repository*main* as artifacts
/rerun-sst 42 to schedule sst tests using this pr build and leapp-repository*PR42* as artifacts

Please open ticket in case you experience technical problem with the CI. (RH internal only)

Note: In case there are problems with tests not being triggered automatically on new PR/commit or pending for a long time, please consider rerunning the CI by commenting leapp-ci build (might require several comments). If the problem persists, contact leapp-infra.

matejmatuska · 2025-09-19T10:35:41Z

-    def add_option(self, name, short_name='', help='',  # noqa; pylint: disable=redefined-builtin
-                   is_flag=False, inherit=False, value_type=str, wrapped=None, action=None, metavar=None,
-                   choices=None, default=None):
+    def add_option( # noqa; pylint: disable=redefined-builtin, too-many-arguments


The argument list is definitely long, maybe we should consider replacing the optional args with **kwargs at this point. I left it as it is for now.

karolinku · 2025-09-22T11:44:33Z

is there a ticket behind this change?

pirat89

missing bump of leapp-framework

matejmatuska · 2025-09-22T12:54:10Z

is there a ticket behind this change?

@karolinku No dedicated one, it's a prerequisite for this https://issues.redhat.com/browse/RHEL-110563. That's why I didn't add it in the descriptions.

matejmatuska · 2025-09-22T12:54:31Z

missing bump of leapp-framework

Right, completely missed that, thanks.

pirat89 · 2025-09-22T14:55:44Z

is there a ticket behind this change?

@karolinku No dedicated one, it's a prerequisite for this https://issues.redhat.com/browse/RHEL-110563. That's why I didn't add it in the descriptions.

well, still it would be nice to have a note about it. e.g. related jira: .....

karolinku · 2025-09-23T09:58:36Z

            if len(short_name) != 1:
                raise CommandDefinitionError("Short name should be one letter only")
            names.insert(0, '-' + short_name)
+        if aliases:


maybe it would be good to add validation if aliases is a list and alias a string?

Well it's not a bad idea, but we don't validate any other types. E.g. if you pass 1 to name it fails too.

matejmatuska · 2025-09-30T09:52:19Z

/rerun

matejmatuska · 2025-09-30T10:05:51Z

/packit copr-build

matejmatuska · 2025-10-01T14:14:28Z

Squashed commits, from my side it's ready to merge :).

matejmatuska · 2025-10-02T09:17:09Z

Added the bump of framework version to the commit message.

The existing 'name' and 'short_name' parameters are kept as is for backwards compatibility. Also a dest parameter is added for specifying the name of the attribute to be added to the parsed args object. The change is backwards compatible, bump framework-version from 6.1 to 6.2. Jira: RHEL-110563 (related)

matejmatuska · 2025-10-02T10:40:30Z

/rerun

matejmatuska · 2025-10-02T11:14:44Z

/rerun

matejmatuska · 2025-10-02T11:48:36Z

/packit retest-failed

karolinku · 2025-10-03T07:51:42Z

/rerun

## Packaging - Bump leapp-framework to 6.2 (oamg#910) ## Leapp (tool) ### Enhancements - Add possibility to specify aliases for CLI option (oamg#910)

## Packaging - Bump leapp-framework to 6.2 (#910) ## Leapp (tool) ### Enhancements - Add possibility to specify aliases for CLI option (#910)

matejmatuska force-pushed the commands-options-alias branch from fab60aa to 65676c2 Compare September 19, 2025 10:33

matejmatuska commented Sep 19, 2025

View reviewed changes

pirat89 requested changes Sep 22, 2025

View reviewed changes

karolinku reviewed Sep 23, 2025

View reviewed changes

matejmatuska force-pushed the commands-options-alias branch from 65676c2 to f3522f9 Compare September 23, 2025 10:29

karolinku reviewed Sep 30, 2025

View reviewed changes

Comment thread leapp/utils/clicmd.py Outdated

karolinku approved these changes Oct 1, 2025

View reviewed changes

matejmatuska force-pushed the commands-options-alias branch from 2951ffa to 4dd038d Compare October 1, 2025 14:13

matejmatuska added the enhancement label Oct 1, 2025

matejmatuska added this to the 8.10/9.8 milestone Oct 1, 2025

karolinku approved these changes Oct 2, 2025

View reviewed changes

pirat89 approved these changes Oct 2, 2025

View reviewed changes

matejmatuska force-pushed the commands-options-alias branch from 4dd038d to fb1e9c3 Compare October 2, 2025 09:16

matejmatuska force-pushed the commands-options-alias branch from fb1e9c3 to 05f5acd Compare October 2, 2025 09:33

karolinku added the changelog-checked The merger/reviewer checked the changelog draft document and updated it when relevant label Oct 2, 2025

karolinku merged commit e62e4e1 into oamg:main Oct 8, 2025
17 of 20 checks passed

matejmatuska deleted the commands-options-alias branch October 9, 2025 08:29

karolinku added a commit to karolinku/leapp that referenced this pull request Feb 10, 2026

Release 0.21.0

94ee0fc

## Packaging - Bump leapp-framework to 6.2 (oamg#910) ## Leapp (tool) ### Enhancements - Add possibility to specify aliases for CLI option (oamg#910)

karolinku mentioned this pull request Feb 10, 2026

New release 0.21.0 #916

Merged

pirat89 pushed a commit to karolinku/leapp that referenced this pull request Feb 10, 2026

Release 0.21.0

72ee5a8

## Packaging - Bump leapp-framework to 6.2 (oamg#910) ## Leapp (tool) ### Enhancements - Add possibility to specify aliases for CLI option (oamg#910)

pirat89 pushed a commit that referenced this pull request Feb 10, 2026

Release 0.21.0

6f7b5b3

## Packaging - Bump leapp-framework to 6.2 (#910) ## Leapp (tool) ### Enhancements - Add possibility to specify aliases for CLI option (#910)

Uh oh!

Conversation

matejmatuska commented Sep 19, 2025 • edited by pirat89 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example help text:

Uh oh!

github-actions Bot commented Sep 19, 2025

Thank you for contributing to the Leapp project!

Uh oh!

matejmatuska Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

karolinku commented Sep 22, 2025

Uh oh!

pirat89 left a comment

Choose a reason for hiding this comment

Uh oh!

matejmatuska commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matejmatuska commented Sep 22, 2025

Uh oh!

pirat89 commented Sep 22, 2025

Uh oh!

Uh oh!

Uh oh!

karolinku Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

matejmatuska Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

matejmatuska commented Sep 30, 2025

Uh oh!

Uh oh!

matejmatuska commented Sep 30, 2025

Uh oh!

matejmatuska commented Oct 1, 2025

Uh oh!

matejmatuska commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

matejmatuska commented Oct 2, 2025

Uh oh!

matejmatuska commented Oct 2, 2025

Uh oh!

matejmatuska commented Oct 2, 2025

Uh oh!

karolinku commented Oct 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

matejmatuska commented Sep 19, 2025 •

edited by pirat89

Loading

matejmatuska commented Sep 22, 2025 •

edited

Loading

matejmatuska commented Oct 2, 2025 •

edited

Loading