Repository navigation
[Feature] path and python version values for version message formatting #1756
Description
Activity
Adding these seems reasonable, but I'm a bit worried about adding too many values to satisfy everyone. Should the path be to the executable entry point, or to the Python module? Should the Python version be the verbose string, or the basic version? If basic like mkdocs, should it only be X.Y? Note that you can already add exactly the information you need by customizing
version_option(message="...").Reacted by Salar Nosrati-Ershad- changed the title
[-]pre-Pull Request: path and python version values for version message formatting.[/-][+]path and python version values for version message formatting[/+]on Jan 15, 2021 Adding these seems reasonable, but I'm a bit worried about adding too many values to satisfy everyone. Should the path be to the executable entry point, or to the Python module? Should the Python version be the verbose string, or the basic version? If basic like mkdocs, should it only be X.Y? Note that you can already add exactly the information you need by customizing
version_option(message="...").Hi.
It's a understandable problem, but I think it's can be handled.
About the path, it's just like prog_name and package_name. so we can add prog_path and package_dir, and Click will try to find them from built-in__file__variable.
But about Python version, we can add a parameter about env_version. And if it's not provided, for example Click can use the standard verbose version_info.Thanks for reviewing, and please give me information about what should we do.
Salar.After 7 days again, What can I do? :)
Feel free to open a PR, it's easier to discuss that way! Just be aware it may not make it into Click.
- added a commit that references this issue
on Sep 4, 2023 For the record, I addressed this issue in Click Extra 4.7.0.
Now you can:
from click_extra import command, extra_version_option @command @extra_version_option( message="{prog_name} {version}, from {module_file} (Python {env_info[python][version]})" ) def custom_env_info(): pass
And get the custom version string you are looking for:
$ custom-env-info --version custom-env-info 4.7.0, from /home/user/click-extra/click_extra/testing.py (Python 3.11.5)More info at: https://kdeldycke.github.io/click-extra/version.html
Reacted by Salar Nosrati-ErshadI'll follow-up this issue with a PR, as @jcrotts suggested. Sorry for my irresponsibility on this issue.
- changed the title
[-]path and python version values for version message formatting[/-][+][Feature] path and python version values for version message formatting[/+]on Jan 5, 2025 Based on #3527, I am going to close this.
Not planned.
As discussed in #3527 , we will not extend the
@version_optiondecorator.If you need something different than the default, you have to produce your own message. Or use the full-featured
@click_extra.version_optiondecorator from the Click Extra project.- locked as resolved and limited conversation to collaborators
on Jul 24, 2026
A lot of programs are using the path of package and/or the Python version in the text message formatting of the version option.
For example virtualenv:
mkdocs:
pylint:
I think it will be good, to add python version and path values in message formatting.
I tried it, and before pull request, I should to create an issue as Feature request.
Thanks for any reviews, Salar.