things3.things3_cli.get_parser() - Code Metrics - Inspection of "make GUI more verbose" - AlexanderWillner/KanbanView - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 33fcc4...1be489 )

by Alexander

created 2020-04-11 01:15 UTC

things3.things3_cli.get_parser() B

↳ Parent: things3.things3_cli

Complexity

Conditions

Size

Total Lines	92
Code Lines	86

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	86
nop	0
dl	0
loc	92
rs	7.4581
c	0
b	0
f	0

How to fix Long Method

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""Simple read-only Thing 3 CLI."""

from __future__ import print_function

__author__ = "Alexander Willner"
__copyright__ = "2020 Alexander Willner"
__credits__ = ["Alexander Willner"]
__license__ = "Apache License 2.0"
__version__ = "2.1.2"
__maintainer__ = "Alexander Willner"
__email__ = "[email protected]"
__status__ = "Development"

import sys
import argparse
import json
import csv
import webbrowser
from things3.things3 import Things3


class Things3CLI():
    """Simple read-only Thing 3 CLI."""

    print_json = False
    print_csv = False
    things3 = None

    def __init__(self, database=None):
        self.things3 = Things3(database)

    def print_tasks(self, tasks):
        """Print a task."""
        if self.print_json:
            print(json.dumps(self.things3.convert_tasks_to_model(tasks)))
        elif self.print_csv:
            fieldnames = ['uuid', 'title', 'context', 'context_uuid', 'due',
                          'created', 'modified', 'started', 'stopped']
            writer = csv.DictWriter(sys.stdout, fieldnames=fieldnames)
            writer.writeheader()
            writer.writerows(self.things3.convert_tasks_to_model(tasks))
        else:
            for task in tasks:
                title = task[self.things3.I_TITLE]
                context = task[self.things3.I_CONTEXT]
                print(' - ', title, ' (', context, ')')

    @classmethod
    def print_unimplemented(cls):
        """Show warning that method is not yet implemented."""
        print("not implemented yet (see things.sh for a more complete CLI)")

    @classmethod
    def get_parser(cls):
        """Create command line argument parser"""
        parser = argparse.ArgumentParser(
            description='Simple read-only Thing 3 CLI.')

        subparsers = parser.add_subparsers(help='',
                                           metavar="command",
                                           required=True,
                                           dest="command")
        subparsers.add_parser('inbox',
                              help='Shows inbox tasks')
        subparsers.add_parser('today',
                              help='Shows todays tasks')
        subparsers.add_parser('upcoming',
                              help='Shows upcoming tasks')
        subparsers.add_parser('next',
                              help='Shows next tasks')
        subparsers.add_parser('someday',
                              help='Shows someday tasks')
        subparsers.add_parser('completed',
                              help='Shows completed tasks')
        subparsers.add_parser('cancelled',
                              help='Shows cancelled tasks')
        subparsers.add_parser('trashed',
                              help='Shows trashed tasks')
        subparsers.add_parser('feedback',
                              help='Give feedback')
        subparsers.add_parser('all',
                              help='Shows all tasks')
        subparsers.add_parser('csv',
                              help='Exports tasks as CSV')
        subparsers.add_parser('due',
                              help='Shows tasks with due dates')
        subparsers.add_parser('headings',
                              help='Shows headings')
        subparsers.add_parser('hours',
                              help='Shows hours planned today')
        subparsers.add_parser('ical',
                              help='Shows tasks ordered by due date as iCal')
        subparsers.add_parser('logbook',
                              help='Shows tasks completed today')
        subparsers.add_parser('mostClosed',
                              help='Shows days when most tasks were closed')
        subparsers.add_parser('mostCancelled',
                              help='Shows days when most tasks were cancelled')
        subparsers.add_parser('mostTrashed',
                              help='Shows days when most tasks were trashed')
        subparsers.add_parser('mostCreated',
                              help='Shows days when most tasks were created')
        subparsers.add_parser('mostTasks',
                              help='Shows projects that have most tasks')
        subparsers.add_parser('mostCharacters',
                              help='Shows tasks that have most characters')
        subparsers.add_parser('nextish',
                              help='Shows all nextish tasks')
        subparsers.add_parser('old',
                              help='Shows all old tasks')
        subparsers.add_parser('projects',
                              help='Shows all projects')
        subparsers.add_parser('repeating',
                              help='Shows all repeating tasks')
        subparsers.add_parser('schedule',
                              help='Schedules an event using a template')
        subparsers.add_parser('search',
                              help='Searches for a specific task')
        subparsers.add_parser('stat',
                              help='Provides a number of statistics')
        subparsers.add_parser('statcsv',
                              help='Exports some statistics as CSV')
        subparsers.add_parser('subtasks',
                              help='Shows all subtasks')
        subparsers.add_parser('tag',
                              help='Shows all tasks with the waiting for tag')
        subparsers.add_parser('tags',
                              help='Shows all tags ordered by their usage')
        subparsers.add_parser('waiting',
                              help='Shows all tasks with the waiting for tag')

        parser.add_argument("-j", "--json",
                            action="store_true", default=False,
                            help="output as JSON", dest="json")

        parser.add_argument("-c", "--csv",
                            action="store_true", default=False,
                            help="output as CSV", dest="csv")

        parser.add_argument(
            "--version",
            action="version",
            version="%(prog)s (version {version})".format(version=__version__))

        return parser

    def main(self, args=None):
        """ Main entry point of the app """

        if args is None:
            self.main(Things3CLI.get_parser().parse_args())
        else:
            command = args.command
            self.print_json = args.json
            self.print_csv = args.csv

            if command in self.things3.functions:
                func = self.things3.functions[command]
                self.print_tasks(func(self.things3))
            elif command == "csv":
                print("Deprecated: use --csv instead")
            elif command == "feedback":
                webbrowser.open(
                    'https://github.com/AlexanderWillner/KanbanView/issues')
            else:
                Things3CLI.print_unimplemented()


if __name__ == "__main__":
    Things3CLI().main()


1			#!/usr/bin/env python3
2			# -- coding: utf-8 --
3
4			"""Simple read-only Thing 3 CLI."""
5
6			from __future__ import print_function
7
8			__author__ = "Alexander Willner"
9			__copyright__ = "2020 Alexander Willner"
10			__credits__ = ["Alexander Willner"]
11			__license__ = "Apache License 2.0"
12			__version__ = "2.1.2"
13			__maintainer__ = "Alexander Willner"
14			__email__ = "[email protected]"
15			__status__ = "Development"
16
17			import sys
18			import argparse
19			import json
20			import csv
21			import webbrowser
22			from things3.things3 import Things3
23
24
25			class Things3CLI():
26			"""Simple read-only Thing 3 CLI."""
27
28			print_json = False
29			print_csv = False
30			things3 = None
31
32			def __init__(self, database=None):
33			self.things3 = Things3(database)
34
35			def print_tasks(self, tasks):
36			"""Print a task."""
37			if self.print_json:
38			print(json.dumps(self.things3.convert_tasks_to_model(tasks)))
39			elif self.print_csv:
40			fieldnames = ['uuid', 'title', 'context', 'context_uuid', 'due',
41			'created', 'modified', 'started', 'stopped']
42			writer = csv.DictWriter(sys.stdout, fieldnames=fieldnames)
43			writer.writeheader()
44			writer.writerows(self.things3.convert_tasks_to_model(tasks))
45			else:
46			for task in tasks:
47			title = task[self.things3.I_TITLE]
48			context = task[self.things3.I_CONTEXT]
49			print(' - ', title, ' (', context, ')')
50
51			@classmethod
52			def print_unimplemented(cls):
53			"""Show warning that method is not yet implemented."""
54			print("not implemented yet (see things.sh for a more complete CLI)")
55
56			@classmethod
57			def get_parser(cls):
58			"""Create command line argument parser"""
59			parser = argparse.ArgumentParser(
60			description='Simple read-only Thing 3 CLI.')
61
62			subparsers = parser.add_subparsers(help='',
63			metavar="command",
64			required=True,
65			dest="command")
66			subparsers.add_parser('inbox',
67			help='Shows inbox tasks')
68			subparsers.add_parser('today',
69			help='Shows todays tasks')
70			subparsers.add_parser('upcoming',
71			help='Shows upcoming tasks')
72			subparsers.add_parser('next',
73			help='Shows next tasks')
74			subparsers.add_parser('someday',
75			help='Shows someday tasks')
76			subparsers.add_parser('completed',
77			help='Shows completed tasks')
78			subparsers.add_parser('cancelled',
79			help='Shows cancelled tasks')
80			subparsers.add_parser('trashed',
81			help='Shows trashed tasks')
82			subparsers.add_parser('feedback',
83			help='Give feedback')
84			subparsers.add_parser('all',
85			help='Shows all tasks')
86			subparsers.add_parser('csv',
87			help='Exports tasks as CSV')
88			subparsers.add_parser('due',
89			help='Shows tasks with due dates')
90			subparsers.add_parser('headings',
91			help='Shows headings')
92			subparsers.add_parser('hours',
93			help='Shows hours planned today')
94			subparsers.add_parser('ical',
95			help='Shows tasks ordered by due date as iCal')
96			subparsers.add_parser('logbook',
97			help='Shows tasks completed today')
98			subparsers.add_parser('mostClosed',
99			help='Shows days when most tasks were closed')
100			subparsers.add_parser('mostCancelled',
101			help='Shows days when most tasks were cancelled')
102			subparsers.add_parser('mostTrashed',
103			help='Shows days when most tasks were trashed')
104			subparsers.add_parser('mostCreated',
105			help='Shows days when most tasks were created')
106			subparsers.add_parser('mostTasks',
107			help='Shows projects that have most tasks')
108			subparsers.add_parser('mostCharacters',
109			help='Shows tasks that have most characters')
110			subparsers.add_parser('nextish',
111			help='Shows all nextish tasks')
112			subparsers.add_parser('old',
113			help='Shows all old tasks')
114			subparsers.add_parser('projects',
115			help='Shows all projects')
116			subparsers.add_parser('repeating',
117			help='Shows all repeating tasks')
118			subparsers.add_parser('schedule',
119			help='Schedules an event using a template')
120			subparsers.add_parser('search',
121			help='Searches for a specific task')
122			subparsers.add_parser('stat',
123			help='Provides a number of statistics')
124			subparsers.add_parser('statcsv',
125			help='Exports some statistics as CSV')
126			subparsers.add_parser('subtasks',
127			help='Shows all subtasks')
128			subparsers.add_parser('tag',
129			help='Shows all tasks with the waiting for tag')
130			subparsers.add_parser('tags',
131			help='Shows all tags ordered by their usage')
132			subparsers.add_parser('waiting',
133			help='Shows all tasks with the waiting for tag')
134
135			parser.add_argument("-j", "--json",
136			action="store_true", default=False,
137			help="output as JSON", dest="json")
138
139			parser.add_argument("-c", "--csv",
140			action="store_true", default=False,
141			help="output as CSV", dest="csv")
142
143			parser.add_argument(
144			"--version",
145			action="version",
146			version="%(prog)s (version {version})".format(version=__version__))
147
148			return parser
149
150			def main(self, args=None):
151			""" Main entry point of the app """
152
153			if args is None:
154			self.main(Things3CLI.get_parser().parse_args())
155			else:
156			command = args.command
157			self.print_json = args.json
158			self.print_csv = args.csv
159
160			if command in self.things3.functions:
161			func = self.things3.functions[command]
162			self.print_tasks(func(self.things3))
163			elif command == "csv":
164			print("Deprecated: use --csv instead")
165			elif command == "feedback":
166			webbrowser.open(
167			'https://github.com/AlexanderWillner/KanbanView/issues')
168			else:
169			Things3CLI.print_unimplemented()
170
171
172			if __name__ == "__main__":
173			Things3CLI().main()
174

AlexanderWillner / KanbanView

Push — master ( 33fcc4...1be489 )

things3.things3_cli.get_parser() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like