MainController.showHidden() - Code Metrics - Inspection of "add other keywords to completion" - QTodoTxt/QTodoTxt2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — qml ( 077131...7ef1da )

by Olivier

created 2017-06-04 08:35 UTC

MainController.showHidden() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

import logging
import os
import string

from PyQt5 import QtCore

from qtodotxt2.lib import tasklib
from qtodotxt2.lib.file import File
from qtodotxt2.filters_controller import FiltersController

logger = logging.getLogger(__name__)


class MainController(QtCore.QObject):

    error = QtCore.pyqtSignal(str, arguments=["msg"])
    fileExternallyModified = QtCore.pyqtSignal()

    def __init__(self, args):
        super(MainController, self).__init__()
        self._args = args
        self._filteredTasks = []
        self._sortingMode = "default"
        # use object variable for setting only used in this class
        # others are accessed through QSettings
        self._settings = QtCore.QSettings()
        self._file = File()
        self._file.fileExternallyModified.connect(self.fileExternallyModified)
        self._file.fileModified.connect(self._fileModified)
        self.filtersController = FiltersController()
        self._title = "QTodoTxt"
        self._recentFiles = self._settings.value("recent_files", [])
        self._updateCompletionStrings()
        self._forced = None

    def showError(self, msg):
        logger.debug("ERROR: %s", msg)
        self.error.emit(msg)

    completionChanged = QtCore.pyqtSignal()

    @QtCore.pyqtProperty('QStringList', notify=completionChanged)
    def completionStrings(self):
        return self._completionStrings

    def _updateCompletionStrings(self):
        contexts = ['@' + name for name in self._file.getAllContexts()]
        projects = ['+' + name for name in self._file.getAllProjects()]
        lowest_priority = self._settings.value("lowest_priority", "D")
        idx = string.ascii_uppercase.index(lowest_priority) + 1
        priorities = ['(' + val + ')' for val in string.ascii_uppercase[:idx]]
        keywords = ['due:', 't:', 'rec:', 'h:1']
        self._completionStrings = contexts + projects + priorities + keywords
        self.completionChanged.emit()

    @QtCore.pyqtSlot('QModelIndexList')
    def filterByIndexes(self, idxs):
        self.filtersController.setFiltersByIndexes(idxs)
        self.applyFilters()

    @QtCore.pyqtSlot('QString', 'int', result='int')
    def newTask(self, text='', after=None):
        task = tasklib.Task(text)
        if bool(self._settings.value("Preferences/add_creation_date", False, type=bool)):
            task.addCreationDate()
        if after is None:
            after = len(self._filteredTasks) - 1
        #self._file.addTask(task)
        self._filteredTasks.insert(after + 1, task)  # force the new task to be visible
        self._file.tasks.append(task)

        self._file.connectTask(task)  #Ensure task will be added
        self.filteredTasksChanged.emit()
        return after + 1

    @QtCore.pyqtSlot('QVariant')
    def deleteTask(self, task):
        if not isinstance(task, tasklib.Task):
            # if task is not a task assume it is an int
            task = self._filteredTasks[task]
        self._file.deleteTask(task)

    @property
    def allTasks(self):
        return self._file.tasks

    @allTasks.setter
    def allTasks(self, tasks):
        self._file.tasks = tasks

    filteredTasksChanged = QtCore.pyqtSignal()

    @QtCore.pyqtProperty('QVariant', notify=filteredTasksChanged)
    def filteredTasks(self):
        return self._filteredTasks

    showFutureChanged = QtCore.pyqtSignal('bool')

    @QtCore.pyqtProperty('bool', notify=showFutureChanged)
    def showFuture(self):
        return self.filtersController.showFuture

    @showFuture.setter
    def showFuture(self, val):
        self.filtersController.showFuture = val
        self.showFutureChanged.emit(val)
        self.applyFilters()

    showHiddenChanged = QtCore.pyqtSignal('bool')

    @QtCore.pyqtProperty('bool', notify=showHiddenChanged)
    def showHidden(self):
        return self.filtersController.showHidden

    @showHidden.setter
    def showHidden(self, val):
        self.filtersController.showHidden = val
        self.showHiddenChanged.emit(val)
        self.applyFilters()

    sortingModeChanged = QtCore.pyqtSignal(str)

    @QtCore.pyqtProperty(str, notify=showFutureChanged)
    def sortingMode(self):
        return self._sortingMode

    @sortingMode.setter
    def sortingMode(self, val):
        self._sortingMode = val
        self.sortingModeChanged.emit(val)
        self.applyFilters()

    searchTextChanged = QtCore.pyqtSignal(str)

    @QtCore.pyqtProperty('QString', notify=searchTextChanged)
    def searchText(self):
        return self.filtersController.searchText

    @searchText.setter
    def searchText(self, txt):
        self.filtersController.searchText = txt
        self.applyFilters()
        self.searchTextChanged.emit(txt)

    showCompletedChanged = QtCore.pyqtSignal('bool')

    @QtCore.pyqtProperty('bool', notify=showCompletedChanged)
    def showCompleted(self):
        return self.filtersController.showCompleted

    @showCompleted.setter
    def showCompleted(self, val):
        self.filtersController.showCompleted = val
        self.showCompletedChanged.emit(val)
        self.applyFilters()

    def auto_save(self):
        if bool(self._settings.value("Preferences/auto_save", True, type=bool)):
            self.save()

    def start(self):
        if self._args.file:
            filename = self._args.file
        else:
            filename = self._settings.value("last_open_file")

        if filename:
            try:
                self.open(filename)
            except OSError as ex:
                self.showError(str(ex))

        self.applyFilters()
        self._updateTitle()

    filtersUpdated = QtCore.pyqtSignal()

    @QtCore.pyqtProperty('QVariant', notify=filtersUpdated)
    def filtersModel(self):
        return self.filtersController.model

    def _updateFilterTree(self):
        self.filtersController.updateFiltersModel(self._file)
        self.filtersUpdated.emit()

    def applyFilters(self, filters=None):
        if filters is not None:
            self.filtersController.setFilters(filters)
        tasks = self.filtersController.filter(self._file.tasks)
        tasks = getattr(tasklib.TaskSorter, self._sortingMode)(tasks)
        self._filteredTasks = tasks
        self.filteredTasksChanged.emit()

    @QtCore.pyqtSlot()
    def archiveCompletedTasks(self):
        done = [task for task in self._file.tasks if task.is_complete]
        for task in done:
            self._file.saveDoneTask(task)
            self._file.deleteTasl(task)
        self.applyFilters()
        self.auto_save()

    modifiedChanged = QtCore.pyqtSignal(bool)

    @QtCore.pyqtProperty('bool', notify=modifiedChanged)
    def modified(self):
        return self._file.modified

    def _fileModified(self, val=True):
        if val:
            self.auto_save()
            self.applyFilters()
            self._updateCompletionStrings()
            self._updateFilterTree()
        self._updateTitle()
        self.modifiedChanged.emit(val)

    @QtCore.pyqtSlot("QUrl")
    @QtCore.pyqtSlot()
    def save(self, path=None):
        if not path:
            path = self._file.filename
        elif isinstance(path, QtCore.QUrl):
            path = path.toLocalFile()
        self._file.filename = path

        logger.debug('MainController, saving file: %s.', path)
        try:
            self._file.save(path)
        except OSError as ex:
            logger.exception("Error saving file %s", path)
            self.showError(ex)
            return
        self._settings.setValue("last_open_file", path)
        self._settings.sync()

    def _updateTitle(self):
        title = 'QTodoTxt - '
        if self._file.filename:
            filename = os.path.basename(self._file.filename)
            title += filename
        else:
            title += 'Untitled'
        if self._file.modified:
            title += ' (*)'
        self._title = title
        self.titleChanged.emit(self._title)

    titleChanged = QtCore.pyqtSignal(str)

    @QtCore.pyqtProperty('QString', notify=titleChanged)
    def title(self):
        return self._title

    @QtCore.pyqtSlot(result='bool')
    def canExit(self):
        self.auto_save()
        return not self._file.modified

    def new(self):
        if self.canExit():
            self._file = File()
            self._loadFileToUI()

    @QtCore.pyqtSlot()
    def reload(self):
        self.open(self._file.filename)

    @QtCore.pyqtSlot('QUrl')
    @QtCore.pyqtSlot('QString')
    def open(self, filename):
        if isinstance(filename, QtCore.QUrl):
            filename = filename.toLocalFile()
        logger.debug('MainController.open called with filename="%s"', filename)
        try:
            self._file.load(filename)
        except Exception as ex:
            self.showError(self.tr("Error opening file: {}.\n Exception:{}").format(filename, ex))
            return
        self._loadFileToUI()
        self._settings.setValue("last_open_file", filename)
        self.updateRecentFile()

    recentFilesChanged = QtCore.pyqtSignal()

    @QtCore.pyqtProperty('QVariant', notify=recentFilesChanged)
    def recentFiles(self):
        return self._recentFiles

    def updateRecentFile(self):
        if self._file.filename in self._recentFiles:
            self._recentFiles.remove(self._file.filename)
        self._recentFiles.insert(0, self._file.filename)
        self._recentFiles = self._recentFiles[:int(self._settings.value("max_recent_files", 6))]
        self._settings.setValue("recent_files", self._recentFiles)
        self.recentFilesChanged.emit()

    def _loadFileToUI(self):
        self.applyFilters()
        self._updateCompletionStrings()
        self._updateFilterTree()

    @QtCore.pyqtSlot('QVariant')
    def completeTask(self, task):
        if not task.is_complete:
            if task.recursion is not None and task.due is not None:
                new_task = tasklib.recurTask(task)
                self._file.addTask(new_task)
            task.setCompleted()
        else:
            task.setPending()



1			import logging
2			import os
3			import string
4
5			from PyQt5 import QtCore
6
7			from qtodotxt2.lib import tasklib
8			from qtodotxt2.lib.file import File
9			from qtodotxt2.filters_controller import FiltersController
10
11			logger = logging.getLogger(__name__)
12
13
14			class MainController(QtCore.QObject):
15
16			error = QtCore.pyqtSignal(str, arguments=["msg"])
17			fileExternallyModified = QtCore.pyqtSignal()
18
19			def __init__(self, args):
20			super(MainController, self).__init__()
21			self._args = args
22			self._filteredTasks = []
23			self._sortingMode = "default"
24			# use object variable for setting only used in this class
25			# others are accessed through QSettings
26			self._settings = QtCore.QSettings()
27			self._file = File()
28			self._file.fileExternallyModified.connect(self.fileExternallyModified)
29			self._file.fileModified.connect(self._fileModified)
30			self.filtersController = FiltersController()
31			self._title = "QTodoTxt"
32			self._recentFiles = self._settings.value("recent_files", [])
33			self._updateCompletionStrings()
34			self._forced = None
35
36			def showError(self, msg):
37			logger.debug("ERROR: %s", msg)
38			self.error.emit(msg)
39
40			completionChanged = QtCore.pyqtSignal()
41
42			@QtCore.pyqtProperty('QStringList', notify=completionChanged)
43			def completionStrings(self):
44			return self._completionStrings
45
46			def _updateCompletionStrings(self):
47			contexts = ['@' + name for name in self._file.getAllContexts()]
48			projects = ['+' + name for name in self._file.getAllProjects()]
49			lowest_priority = self._settings.value("lowest_priority", "D")
50			idx = string.ascii_uppercase.index(lowest_priority) + 1
51			priorities = ['(' + val + ')' for val in string.ascii_uppercase[:idx]]
52			keywords = ['due:', 't:', 'rec:', 'h:1']
53			self._completionStrings = contexts + projects + priorities + keywords
54			self.completionChanged.emit()
55
56			@QtCore.pyqtSlot('QModelIndexList')
57			def filterByIndexes(self, idxs):
58			self.filtersController.setFiltersByIndexes(idxs)
59			self.applyFilters()
60
61			@QtCore.pyqtSlot('QString', 'int', result='int')
62			def newTask(self, text='', after=None):
63			task = tasklib.Task(text)
64			if bool(self._settings.value("Preferences/add_creation_date", False, type=bool)):
65			task.addCreationDate()
66			if after is None:
67			after = len(self._filteredTasks) - 1
68			#self._file.addTask(task)
69			self._filteredTasks.insert(after + 1, task) # force the new task to be visible
70			self._file.tasks.append(task)
71
72			self._file.connectTask(task) #Ensure task will be added
73			self.filteredTasksChanged.emit()
74			return after + 1
75
76			@QtCore.pyqtSlot('QVariant')
77			def deleteTask(self, task):
78			if not isinstance(task, tasklib.Task):
79			# if task is not a task assume it is an int
80			task = self._filteredTasks[task]
81			self._file.deleteTask(task)
82
83			@property
84			def allTasks(self):
85			return self._file.tasks
86
87			@allTasks.setter
88			def allTasks(self, tasks):
89			self._file.tasks = tasks
90
91			filteredTasksChanged = QtCore.pyqtSignal()
92
93			@QtCore.pyqtProperty('QVariant', notify=filteredTasksChanged)
94			def filteredTasks(self):
95			return self._filteredTasks
96
97			showFutureChanged = QtCore.pyqtSignal('bool')
98
99			@QtCore.pyqtProperty('bool', notify=showFutureChanged)
100			def showFuture(self):
101			return self.filtersController.showFuture
102
103			@showFuture.setter
104			def showFuture(self, val):
105			self.filtersController.showFuture = val
106			self.showFutureChanged.emit(val)
107			self.applyFilters()
108
109			showHiddenChanged = QtCore.pyqtSignal('bool')
110
111			@QtCore.pyqtProperty('bool', notify=showHiddenChanged)
112			def showHidden(self):
113			return self.filtersController.showHidden
114
115			@showHidden.setter
116			def showHidden(self, val):
117			self.filtersController.showHidden = val
118			self.showHiddenChanged.emit(val)
119			self.applyFilters()
120
121			sortingModeChanged = QtCore.pyqtSignal(str)
122
123			@QtCore.pyqtProperty(str, notify=showFutureChanged)
124			def sortingMode(self):
125			return self._sortingMode
126
127			@sortingMode.setter
128			def sortingMode(self, val):
129			self._sortingMode = val
130			self.sortingModeChanged.emit(val)
131			self.applyFilters()
132
133			searchTextChanged = QtCore.pyqtSignal(str)
134
135			@QtCore.pyqtProperty('QString', notify=searchTextChanged)
136			def searchText(self):
137			return self.filtersController.searchText
138
139			@searchText.setter
140			def searchText(self, txt):
141			self.filtersController.searchText = txt
142			self.applyFilters()
143			self.searchTextChanged.emit(txt)
144
145			showCompletedChanged = QtCore.pyqtSignal('bool')
146
147			@QtCore.pyqtProperty('bool', notify=showCompletedChanged)
148			def showCompleted(self):
149			return self.filtersController.showCompleted
150
151			@showCompleted.setter
152			def showCompleted(self, val):
153			self.filtersController.showCompleted = val
154			self.showCompletedChanged.emit(val)
155			self.applyFilters()
156
157			def auto_save(self):
158			if bool(self._settings.value("Preferences/auto_save", True, type=bool)):
159			self.save()
160
161			def start(self):
162			if self._args.file:
163			filename = self._args.file
164			else:
165			filename = self._settings.value("last_open_file")
166
167			if filename:
168			try:
169			self.open(filename)
170			except OSError as ex:
171			self.showError(str(ex))
172
173			self.applyFilters()
174			self._updateTitle()
175
176			filtersUpdated = QtCore.pyqtSignal()
177
178			@QtCore.pyqtProperty('QVariant', notify=filtersUpdated)
179			def filtersModel(self):
180			return self.filtersController.model
181
182			def _updateFilterTree(self):
183			self.filtersController.updateFiltersModel(self._file)
184			self.filtersUpdated.emit()
185
186			def applyFilters(self, filters=None):
187			if filters is not None:
188			self.filtersController.setFilters(filters)
189			tasks = self.filtersController.filter(self._file.tasks)
190			tasks = getattr(tasklib.TaskSorter, self._sortingMode)(tasks)
191			self._filteredTasks = tasks
192			self.filteredTasksChanged.emit()
193
194			@QtCore.pyqtSlot()
195			def archiveCompletedTasks(self):
196			done = [task for task in self._file.tasks if task.is_complete]
197			for task in done:
198			self._file.saveDoneTask(task)
199			self._file.deleteTasl(task)
200			self.applyFilters()
201			self.auto_save()
202
203			modifiedChanged = QtCore.pyqtSignal(bool)
204
205			@QtCore.pyqtProperty('bool', notify=modifiedChanged)
206			def modified(self):
207			return self._file.modified
208
209			def _fileModified(self, val=True):
210			if val:
211			self.auto_save()
212			self.applyFilters()
213			self._updateCompletionStrings()
214			self._updateFilterTree()
215			self._updateTitle()
216			self.modifiedChanged.emit(val)
217
218			@QtCore.pyqtSlot("QUrl")
219			@QtCore.pyqtSlot()
220			def save(self, path=None):
221			if not path:
222			path = self._file.filename
223			elif isinstance(path, QtCore.QUrl):
224			path = path.toLocalFile()
225			self._file.filename = path
226
227			logger.debug('MainController, saving file: %s.', path)
228			try:
229			self._file.save(path)
230			except OSError as ex:
231			logger.exception("Error saving file %s", path)
232			self.showError(ex)
233			return
234			self._settings.setValue("last_open_file", path)
235			self._settings.sync()
236
237			def _updateTitle(self):
238			title = 'QTodoTxt - '
239			if self._file.filename:
240			filename = os.path.basename(self._file.filename)
241			title += filename
242			else:
243			title += 'Untitled'
244			if self._file.modified:
245			title += ' (*)'
246			self._title = title
247			self.titleChanged.emit(self._title)
248
249			titleChanged = QtCore.pyqtSignal(str)
250
251			@QtCore.pyqtProperty('QString', notify=titleChanged)
252			def title(self):
253			return self._title
254
255			@QtCore.pyqtSlot(result='bool')
256			def canExit(self):
257			self.auto_save()
258			return not self._file.modified
259
260			def new(self):
261			if self.canExit():
262			self._file = File()
263			self._loadFileToUI()
264
265			@QtCore.pyqtSlot()
266			def reload(self):
267			self.open(self._file.filename)
268
269			@QtCore.pyqtSlot('QUrl')
270			@QtCore.pyqtSlot('QString')
271			def open(self, filename):
272			if isinstance(filename, QtCore.QUrl):
273			filename = filename.toLocalFile()
274			logger.debug('MainController.open called with filename="%s"', filename)
275			try:
276			self._file.load(filename)
277			except Exception as ex:
278			self.showError(self.tr("Error opening file: {}.\n Exception:{}").format(filename, ex))
279			return
280			self._loadFileToUI()
281			self._settings.setValue("last_open_file", filename)
282			self.updateRecentFile()
283
284			recentFilesChanged = QtCore.pyqtSignal()
285
286			@QtCore.pyqtProperty('QVariant', notify=recentFilesChanged)
287			def recentFiles(self):
288			return self._recentFiles
289
290			def updateRecentFile(self):
291			if self._file.filename in self._recentFiles:
292			self._recentFiles.remove(self._file.filename)
293			self._recentFiles.insert(0, self._file.filename)
294			self._recentFiles = self._recentFiles[:int(self._settings.value("max_recent_files", 6))]
295			self._settings.setValue("recent_files", self._recentFiles)
296			self.recentFilesChanged.emit()
297
298			def _loadFileToUI(self):
299			self.applyFilters()
300			self._updateCompletionStrings()
301			self._updateFilterTree()
302
303			@QtCore.pyqtSlot('QVariant')
304			def completeTask(self, task):
305			if not task.is_complete:
306			if task.recursion is not None and task.due is not None:
307			new_task = tasklib.recurTask(task)
308			self._file.addTask(new_task)
309			task.setCompleted()
310			else:
311			task.setPending()
312
313

QTodoTxt / QTodoTxt2

Push — qml ( 077131...7ef1da )

MainController.showHidden() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like