pyclean.cli.parse_arguments() - Code Metrics - Inspection of "Add `--debris` CLI option for choosing cleanup tar..." - bittner/pyclean - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#50)

by Peter

created 2023-01-14 19:48 UTC

pyclean.cli.parse_arguments() B

↳ Parent: pyclean.cli

Complexity

Conditions

Size

Total Lines	62
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	43
nop	0
dl	0
loc	62
rs	7.9146
c	0
b	0
f	0

How to fix Long Method

"""
Command line interface implementation for pyclean.
"""
import argparse
import logging
import sys

from . import __version__, compat, modern

log = logging.getLogger(__name__)


def parse_arguments():
    """
    Parse and handle CLI arguments
    """
    debris_default_topics = ['build', 'cache', 'coverage', 'pytest']
    debris_optional_topics = ['tox']

    parser = argparse.ArgumentParser(
        description='Remove byte-compiled files for a package or project.',
    )

    if sys.version_info < (3, 8):
        parser.register('action', 'extend', compat.ExtendAction)

    parser.add_argument('--version', action='version', version=__version__)
    parser.add_argument('-V', metavar='VERSION', dest='version',
                        help='specify Python version to clean')
    parser.add_argument('-p', '--package', metavar='PACKAGE',
                        action='append', default=[],
                        help='Debian package to byte-compile '
                             '(may be specified multiple times)')
    parser.add_argument('directory', nargs='*',
                        help='directory tree to traverse for byte-code')
    parser.add_argument('-i', '--ignore', metavar='DIRECTORY', action='extend',
                        nargs='+', default=['.git', '.tox', '.venv'],
                        help='directory that should be ignored '
                             '(may be specified multiple times; '
                             'default: %(default)s)')
    parser.add_argument('-d', '--debris', metavar='TOPIC', action='extend',
                        nargs='*', default=argparse.SUPPRESS,
                        choices=debris_default_topics + debris_optional_topics,
                        help='remove typical leftovers from well-known '
                             'programs (may be specified multiple times; '
                             'default: %s)' % debris_default_topics)
    parser.add_argument('--legacy', action='store_true',
                        help='use legacy Debian implementation (autodetect)')
    parser.add_argument('-n', '--dry-run', action='store_true',
                        help='show what would be done')

    verbosity = parser.add_mutually_exclusive_group()
    verbosity.add_argument('-q', '--quiet', action='store_true',
                           help='be quiet')
    verbosity.add_argument('-v', '--verbose', action='store_true',
                           help='be more verbose')

    args = parser.parse_args()
    init_logging(args)

    if not (args.package or args.directory):
        parser.error('A directory (or files) or a list of packages '
                     'must be specified.')

    if 'debris' in args:
        if args.debris == []:
            args.debris = debris_default_topics
        log.debug("Debris requested to clean up for: %s", ' '.join(args.debris))
    else:
        args.debris = []

    log.debug("Ignored directories: %s", ' '.join(args.ignore))

    return args


def init_logging(args):
    """
    Set the log level according to the -v/-q command line options.
    """
    log_level = logging.FATAL if args.quiet \
        else logging.DEBUG if args.verbose \
        else logging.INFO
    log_format = "%(message)s"
    logging.basicConfig(level=log_level, format=log_format)


def main(override=None):
    """
    Entry point for all scripts
    """
    args = parse_arguments()
    if override or args.legacy:
        impl = compat.get_implementation(override=override)
        impl.main(args)
    else:
        modern.pyclean(args)


def py2clean():
    """
    Forces the use of the implementation for Python 2
    """
    main('CPython2')


def py3clean():
    """
    Forces the use of the implementation for Python 3
    """
    main('CPython3')


def pypyclean():
    """
    Forces the use of the implementation for PyPy (2+3)
    """
    main('PyPy2')


1			"""
2			Command line interface implementation for pyclean.
3			"""
4			import argparse
5			import logging
6			import sys
7
8			from . import __version__, compat, modern
9
10			log = logging.getLogger(__name__)
11
12
13			def parse_arguments():
14			"""
15			Parse and handle CLI arguments
16			"""
17			debris_default_topics = ['build', 'cache', 'coverage', 'pytest']
18			debris_optional_topics = ['tox']
19
20			parser = argparse.ArgumentParser(
21			description='Remove byte-compiled files for a package or project.',
22			)
23
24			if sys.version_info < (3, 8):
25			parser.register('action', 'extend', compat.ExtendAction)
26
27			parser.add_argument('--version', action='version', version=__version__)
28			parser.add_argument('-V', metavar='VERSION', dest='version',
29			help='specify Python version to clean')
30			parser.add_argument('-p', '--package', metavar='PACKAGE',
31			action='append', default=[],
32			help='Debian package to byte-compile '
33			'(may be specified multiple times)')
34			parser.add_argument('directory', nargs='*',
35			help='directory tree to traverse for byte-code')
36			parser.add_argument('-i', '--ignore', metavar='DIRECTORY', action='extend',
37			nargs='+', default=['.git', '.tox', '.venv'],
38			help='directory that should be ignored '
39			'(may be specified multiple times; '
40			'default: %(default)s)')
41			parser.add_argument('-d', '--debris', metavar='TOPIC', action='extend',
42			nargs='*', default=argparse.SUPPRESS,
43			choices=debris_default_topics + debris_optional_topics,
44			help='remove typical leftovers from well-known '
45			'programs (may be specified multiple times; '
46			'default: %s)' % debris_default_topics)
47			parser.add_argument('--legacy', action='store_true',
48			help='use legacy Debian implementation (autodetect)')
49			parser.add_argument('-n', '--dry-run', action='store_true',
50			help='show what would be done')
51
52			verbosity = parser.add_mutually_exclusive_group()
53			verbosity.add_argument('-q', '--quiet', action='store_true',
54			help='be quiet')
55			verbosity.add_argument('-v', '--verbose', action='store_true',
56			help='be more verbose')
57
58			args = parser.parse_args()
59			init_logging(args)
60
61			if not (args.package or args.directory):
62			parser.error('A directory (or files) or a list of packages '
63			'must be specified.')
64
65			if 'debris' in args:
66			if args.debris == []:
67			args.debris = debris_default_topics
68			log.debug("Debris requested to clean up for: %s", ' '.join(args.debris))
69			else:
70			args.debris = []
71
72			log.debug("Ignored directories: %s", ' '.join(args.ignore))
73
74			return args
75
76
77			def init_logging(args):
78			"""
79			Set the log level according to the -v/-q command line options.
80			"""
81			log_level = logging.FATAL if args.quiet \
82			else logging.DEBUG if args.verbose \
83			else logging.INFO
84			log_format = "%(message)s"
85			logging.basicConfig(level=log_level, format=log_format)
86
87
88			def main(override=None):
89			"""
90			Entry point for all scripts
91			"""
92			args = parse_arguments()
93			if override or args.legacy:
94			impl = compat.get_implementation(override=override)
95			impl.main(args)
96			else:
97			modern.pyclean(args)
98
99
100			def py2clean():
101			"""
102			Forces the use of the implementation for Python 2
103			"""
104			main('CPython2')
105
106
107			def py3clean():
108			"""
109			Forces the use of the implementation for Python 3
110			"""
111			main('CPython3')
112
113
114			def pypyclean():
115			"""
116			Forces the use of the implementation for PyPy (2+3)
117			"""
118			main('PyPy2')
119

bittner / pyclean

Pull Request — main (#50)

pyclean.cli.parse_arguments() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like