pyclean.cli.parse_arguments() - Code Metrics - Inspection of "Explain free-form `--erase` option in README" - bittner/pyclean - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 002c08...62641e )

by Peter

created 2023-01-27 09:28 UTC

pyclean.cli.parse_arguments() C

↳ Parent: pyclean.cli

Complexity

Conditions

Size

Total Lines	76
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	54
nop	0
dl	0
loc	76
rs	6.1721
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 = ['jupyter', 'tox']
    debris_choices = ['all'] + debris_default_topics + debris_optional_topics
    ignore_default_items = ['.git', '.hg', '.svn', '.tox', '.venv', 'node_modules']

    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=ignore_default_items,
                        help='directory that should be ignored '
                             '(may be specified multiple times; '
                             'default: %s)' % ' '.join(ignore_default_items))
    parser.add_argument('-d', '--debris', metavar='TOPIC', action='extend',
                        nargs='*', default=argparse.SUPPRESS, choices=debris_choices,
                        help='remove leftovers from popular Python development '
                             'tools (may be specified multiple times; '
                             'default: %s)' % ' '.join(debris_default_topics))
    parser.add_argument('-e', '--erase', metavar='PATTERN', action='extend',
                        nargs='+', default=[],
                        help='delete files or folders matching a globbing '
                             'pattern (may be specified multiple times); '
                             'this will be interactive unless --yes is used.')
    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')

    parser.add_argument('-y', '--yes', action='store_true',
                        help='assume yes as answer for interactive questions')

    args = parser.parse_args()
    init_logging(args)

    if args.yes and not args.erase:
        parser.error('Specifying --yes only makes sense with --erase.')

    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 'all' in args.debris:
            args.debris = debris_default_topics + debris_optional_topics
        elif not args.debris:
            args.debris = debris_default_topics
        log.debug("Debris topics to scan 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 = ['jupyter', 'tox']
19			debris_choices = ['all'] + debris_default_topics + debris_optional_topics
20			ignore_default_items = ['.git', '.hg', '.svn', '.tox', '.venv', 'node_modules']
21
22			parser = argparse.ArgumentParser(
23			description='Remove byte-compiled files for a package or project.',
24			)
25
26			if sys.version_info < (3, 8):
27			parser.register('action', 'extend', compat.ExtendAction)
28
29			parser.add_argument('--version', action='version', version=__version__)
30			parser.add_argument('-V', metavar='VERSION', dest='version',
31			help='specify Python version to clean')
32			parser.add_argument('-p', '--package', metavar='PACKAGE',
33			action='append', default=[],
34			help='Debian package to byte-compile '
35			'(may be specified multiple times)')
36			parser.add_argument('directory', nargs='*',
37			help='directory tree to traverse for byte-code')
38			parser.add_argument('-i', '--ignore', metavar='DIRECTORY', action='extend',
39			nargs='+', default=ignore_default_items,
40			help='directory that should be ignored '
41			'(may be specified multiple times; '
42			'default: %s)' % ' '.join(ignore_default_items))
43			parser.add_argument('-d', '--debris', metavar='TOPIC', action='extend',
44			nargs='*', default=argparse.SUPPRESS, choices=debris_choices,
45			help='remove leftovers from popular Python development '
46			'tools (may be specified multiple times; '
47			'default: %s)' % ' '.join(debris_default_topics))
48			parser.add_argument('-e', '--erase', metavar='PATTERN', action='extend',
49			nargs='+', default=[],
50			help='delete files or folders matching a globbing '
51			'pattern (may be specified multiple times); '
52			'this will be interactive unless --yes is used.')
53			parser.add_argument('--legacy', action='store_true',
54			help='use legacy Debian implementation (autodetect)')
55			parser.add_argument('-n', '--dry-run', action='store_true',
56			help='show what would be done')
57
58			verbosity = parser.add_mutually_exclusive_group()
59			verbosity.add_argument('-q', '--quiet', action='store_true',
60			help='be quiet')
61			verbosity.add_argument('-v', '--verbose', action='store_true',
62			help='be more verbose')
63
64			parser.add_argument('-y', '--yes', action='store_true',
65			help='assume yes as answer for interactive questions')
66
67			args = parser.parse_args()
68			init_logging(args)
69
70			if args.yes and not args.erase:
71			parser.error('Specifying --yes only makes sense with --erase.')
72
73			if not (args.package or args.directory):
74			parser.error('A directory (or files) or a list of packages '
75			'must be specified.')
76
77			if 'debris' in args:
78			if 'all' in args.debris:
79			args.debris = debris_default_topics + debris_optional_topics
80			elif not args.debris:
81			args.debris = debris_default_topics
82			log.debug("Debris topics to scan for: %s", ' '.join(args.debris))
83			else:
84			args.debris = []
85
86			log.debug("Ignored directories: %s", ' '.join(args.ignore))
87
88			return args
89
90
91			def init_logging(args):
92			"""
93			Set the log level according to the -v/-q command line options.
94			"""
95			log_level = logging.FATAL if args.quiet \
96			else logging.DEBUG if args.verbose \
97			else logging.INFO
98			log_format = "%(message)s"
99			logging.basicConfig(level=log_level, format=log_format)
100
101
102			def main(override=None):
103			"""
104			Entry point for all scripts
105			"""
106			args = parse_arguments()
107			if override or args.legacy:
108			impl = compat.get_implementation(override=override)
109			impl.main(args)
110			else:
111			modern.pyclean(args)
112
113
114			def py2clean():
115			"""
116			Forces the use of the implementation for Python 2
117			"""
118			main('CPython2')
119
120
121			def py3clean():
122			"""
123			Forces the use of the implementation for Python 3
124			"""
125			main('CPython3')
126
127
128			def pypyclean():
129			"""
130			Forces the use of the implementation for PyPy (2+3)
131			"""
132			main('PyPy2')
133

bittner / pyclean

Push — main ( 002c08...62641e )

pyclean.cli.parse_arguments() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like