Help option

[sergey-yaroslavtsev]

Closes #1141
By switching to argparse.

[woutdenolf]

Nice! It seems that getopt is used everywhere. Perhaps in another PR we could use it everywhere? Or this PR, as you want.

[woutdenolf]

Do we need getLoggingLevel here?

[woutdenolf]

Essentially we have one log level

log_level = "debug" if args.debug else args.logging

Something like

import argparse
import logging

parser = argparse.ArgumentParser(description="Example script with logging.")
parser.add_argument(
    "--logging",
    default="warning",
    choices=["debug", "info", "warning", "error", "critical"],
    help="Set logging level (default: warning)"
)
parser.add_argument(
    "--debug",
    action="store_true",
    help="Force logging level to DEBUG"
)

args = parser.parse_args()

if args.debug:
    log_level = logging.DEBUG
else:
    log_level = getattr(logging, args.logging.upper(), logging.WARNING)

logging.basicConfig(level=log_level)

[woutdenolf]

Maybe this logic can be implemented in a re-usable way.

[sergey-yaroslavtsev]

Do we need backward compatibility? if yes then to forbid numerical values will be an issue.
If not this is a good looking approach.

[vasole]

Yes, we need it.

[sergey-yaroslavtsev]

Nice! It seems that getopt is used everywhere. Perhaps in another PR we could use it everywhere? Or this PR, as you want.

Sry i am a bit confused with "use it". You mean substitute getopt with argparse everywhere?

Yea I can search and change it everywhere if it is better, should not be a big problem.

[woutdenolf]

You mean substitute getopt with argparse everywhere?

Yes

[woutdenolf]

May I also suggest to use

from argparse import ArgumentDefaultsHelpFormatter

parser = ArgumentParser(
        ..., formatter_class=ArgumentDefaultsHelpFormatter
    )

This shows the default values in --help.

Again you may want to implement common logic in PyMca5.PyMcaCore.LoggingLevel so we can re-use it in all the CLI's (there are many).