Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Control the logging level in the CLI

Open
  • Is something wrong?
#68 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start at main.py and the root atldld CLI command, then trace how commands currently configure or emit logging. Add the proposed verbosity control and verify the documented default, -v, -vv, and excessive-verbosity behaviors using the example CLI commands.

Written by the indexing model from the issue text.

Description

Regarding tracebacks / debugging, there are for sure different options.

First of all, we already have a way because we added the __main__.py file. So now to debug some atldld <command> command one just needs to write python -m pdb -m atldld <command>. (I think one needs at least py37...)

And yes I've seen people using CLI flags to control the debug output. One could add something like --debug, --log-level, -v/-vv/-vvv directly to the root atldld command. For logging it would then configure the logging accordingly:

import logging


logger = logging.getLogger(__name__)

@click.group()
@click.option('-v', '--verbose', count=True)
def root(verbose):
    """Run the command line interface for Atlas-Download-Tools."""
    if verbose == 0:
        log_level = logging.WARNING
    elif verbose == 1:
        log_level = logging.INFO
    else:  # verbose >= 2:
        log_level = logging.DEBUG
    logging.basicConfig(level=log_level)

    if verbose > 2:
        logger.warning("The maximal verbosity is -vv")


@root.command("test")
def test():
    logger.critical("Critical")
    logger.error("Error")
    logger.warning("Warning")
    logger.info("Info")
    logger.debug("Debug")

$ atldld test
CRITICAL:atldld.cli:Critical
ERROR:atldld.cli:Error
WARNING:atldld.cli:Warning

$ atldld -v test
CRITICAL:atldld.cli:Critical
ERROR:atldld.cli:Error
WARNING:atldld.cli:Warning
INFO:atldld.cli:Info

$ atldld -vv test
CRITICAL:atldld.cli:Critical
ERROR:atldld.cli:Error
WARNING:atldld.cli:Warning
INFO:atldld.cli:Info
DEBUG:atldld.cli:Debug

$ atldld -vvv test
WARNING:atldld.cli:The maximal verbosity is -vv
CRITICAL:atldld.cli:Critical
ERROR:atldld.cli:Error
WARNING:atldld.cli:Warning
INFO:atldld.cli:Info
DEBUG:atldld.cli:Debug

Originally posted by @Stannislav in https://github.com/BlueBrain/Atlas-Download-Tools/pull/66#discussion_r698353401

Dominant language
Python
Stars
17
Forks
8
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from BlueBrain/Atlas-Download-Tools

All issues in BlueBrain/Atlas-Download-Tools

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.