MainController.allTasks() - Code Metrics - Inspection of "first controller test" - QTodoTxt/QTodoTxt2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — qml ( cb107e...bc64a3 )

by Olivier

created 2017-04-30 11:34 UTC

MainController.allTasks() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

import logging
import os
import string

from PyQt5 import QtCore

from qtodotxt.lib import tasklib
from qtodotxt.lib.file import File

from qtodotxt.controllers.filters_tree_controller import FiltersTreeController
from qtodotxt.lib.filters import SimpleTextFilter, FutureFilter, IncompleteTasksFilter, CompleteTasksFilter

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 = []
        # use object variable for setting only used in this class
        # others are accessed through QSettings
        self._settings = QtCore.QSettings()
        self._showCompleted = self._settings.value("show_completed", False)
        self._showFuture = self._settings.value("show_completed", True)
        self._file = File()
        self._file.fileModified.connect(self.fileExternallyModified)
        self._modified = False
        self._filters_tree_controller = FiltersTreeController()
        self._title = "QTodoTxt"
        self._recentFiles = self._settings.value("recent_files", [])
        self._searchText = ""
        self._currentFilters = []
        # self._currentFilters = self._settings.value("current_filters", ["All"])  # move to QML
        self._updateCompletionStrings()

    def _taskModified(self, task):
        self.setModified()
        self.auto_save()
        if not task.text:
            self.deleteTask(task)
            return
        self.applyFilters()

    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]]
        self._completionStrings = contexts + projects + priorities + ['due:']
        self.completionChanged.emit()

    @QtCore.pyqtSlot('QModelIndexList')
    def filterByIndexes(self, idxs):
        filters = [self._filters_tree_controller.model.itemFromIndex(idx).filter for idx in idxs]
        self._currentFilters = filters
        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()
        task.modified.connect(self._taskModified)
        if after is None:
            after = len(self._filteredTasks) - 1
        self._file.tasks.append(task)
        self._filteredTasks.insert(after + 1, task)  # force the new task to be visible
        self.setModified()
        self.auto_save()
        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.tasks.remove(task)
        self.setModified()
        self.auto_save()
        self.applyFilters()  # update filtered list for UI

    @property
    def allTasks(self):
        return self._file.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._showFuture

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

    searchTextChanged = QtCore.pyqtSignal(str)

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

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

    showCompletedChanged = QtCore.pyqtSignal('bool')

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

    @showCompleted.setter
    def showCompleted(self, val):
        self._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._filters_tree_controller.model
   
    def _updateFilterTree(self):
        self._filters_tree_controller.showFilters(self._file)
        self.filtersUpdated.emit()

    def applyFilters(self):
        # First we filter with filters tree
        tasks = tasklib.filterTasks(self._currentFilters, self._file.tasks)
        # Then with our search text
        if self._searchText:
            tasks = tasklib.filterTasks([SimpleTextFilter(self._searchText)], tasks)
        # with future filter if needed
        if not self._showFuture:
            tasks = tasklib.filterTasks([FutureFilter()], tasks)
        # with complete filter if needed
        if not self._showCompleted and not CompleteTasksFilter() in self._currentFilters:
            tasks = tasklib.filterTasks([IncompleteTasksFilter()], 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.tasks.remove(task)
        self.applyFilters()
        self.setModified()
        self.auto_save()

    modifiedChanged = QtCore.pyqtSignal(bool)

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

    def setModified(self, val=True):
        self._modified = val
        self._updateTitle()
        if val:
            self._updateCompletionStrings()
            self._updateFilterTree()
        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()
        self.setModified(False)

    def _updateTitle(self):
        title = 'QTodoTxt - '
        if self._file.filename:
            filename = os.path.basename(self._file.filename)
            title += filename
        else:
            title += 'Untitled'
        if self._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._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)
        for task in self._file.tasks:
            task.modified.connect(self._taskModified)
        self.applyFilters()
        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.setModified(False)
        self.applyFilters()
        self._updateCompletionStrings()
        self._updateFilterTree()


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

QTodoTxt / QTodoTxt2

Push — qml ( cb107e...bc64a3 )

MainController.allTasks() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like