MainController._fileModified() - Code Metrics - Inspection of "move modified code out of main_controller" - QTodoTxt/QTodoTxt2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — qml ( e78c5d...75cc72 )

by Olivier

created 2017-05-16 16:38 UTC

MainController._fileModified() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
c	0
b	0
f	0
dl	0
loc	8
rs	9.4285

import logging
import os
import string

from PyQt5 import QtCore

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

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

    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()


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.filters_controller import FiltersController
11
12			logger = logging.getLogger(__name__)
13
14
15			class MainController(QtCore.QObject):
16
17			error = QtCore.pyqtSignal(str, arguments=["msg"])
18			fileExternallyModified = QtCore.pyqtSignal()
19
20			def __init__(self, args):
21			super(MainController, self).__init__()
22			self._args = args
23			self._filteredTasks = []
24			self._sortingMode = "default"
25			# use object variable for setting only used in this class
26			# others are accessed through QSettings
27			self._settings = QtCore.QSettings()
28			self._file = File()
29			self._file.fileExternallyModified.connect(self.fileExternallyModified)
30			self._file.fileModified.connect(self._fileModified)
31			self.filtersController = FiltersController()
32			self._title = "QTodoTxt"
33			self._recentFiles = self._settings.value("recent_files", [])
34			self._updateCompletionStrings()
35			self._forced = None
36
37			def showError(self, msg):
38			logger.debug("ERROR: %s", msg)
39			self.error.emit(msg)
40
41			completionChanged = QtCore.pyqtSignal()
42
43			@QtCore.pyqtProperty('QStringList', notify=completionChanged)
44			def completionStrings(self):
45			return self._completionStrings
46
47			def _updateCompletionStrings(self):
48			contexts = ['@' + name for name in self._file.getAllContexts()]
49			projects = ['+' + name for name in self._file.getAllProjects()]
50			lowest_priority = self._settings.value("lowest_priority", "D")
51			idx = string.ascii_uppercase.index(lowest_priority) + 1
52			priorities = ['(' + val + ')' for val in string.ascii_uppercase[:idx]]
53			self._completionStrings = contexts + projects + priorities + ['due:']
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			sortingModeChanged = QtCore.pyqtSignal(str)
110
111			@QtCore.pyqtProperty(str, notify=showFutureChanged)
112			def sortingMode(self):
113			return self._sortingMode
114
115			@sortingMode.setter
116			def sortingMode(self, val):
117			self._sortingMode = val
118			self.sortingModeChanged.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.filtersController.searchText
126
127			@searchText.setter
128			def searchText(self, txt):
129			self.filtersController.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.filtersController.showCompleted
138
139			@showCompleted.setter
140			def showCompleted(self, val):
141			self.filtersController.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.filtersController.model
169
170			def _updateFilterTree(self):
171			self.filtersController.updateFiltersModel(self._file)
172			self.filtersUpdated.emit()
173
174			def applyFilters(self, filters=None):
175			if filters is not None:
176			self.filtersController.setFilters(filters)
177			tasks = self.filtersController.filter(self._file.tasks)
178			tasks = getattr(tasklib.TaskSorter, self._sortingMode)(tasks)
179			self._filteredTasks = tasks
180			self.filteredTasksChanged.emit()
181
182			@QtCore.pyqtSlot()
183			def archiveCompletedTasks(self):
184			done = [task for task in self._file.tasks if task.is_complete]
185			for task in done:
186			self._file.saveDoneTask(task)
187			self._file.deleteTasl(task)
188			self.applyFilters()
189			self.auto_save()
190
191			modifiedChanged = QtCore.pyqtSignal(bool)
192
193			@QtCore.pyqtProperty('bool', notify=modifiedChanged)
194			def modified(self):
195			return self._file.modified
196
197			def _fileModified(self, val=True):
198			if val:
199			self.auto_save()
200			self.applyFilters()
201			self._updateCompletionStrings()
202			self._updateFilterTree()
203			self._updateTitle()
204			self.modifiedChanged.emit(val)
205
206			@QtCore.pyqtSlot("QUrl")
207			@QtCore.pyqtSlot()
208			def save(self, path=None):
209			if not path:
210			path = self._file.filename
211			elif isinstance(path, QtCore.QUrl):
212			path = path.toLocalFile()
213			self._file.filename = path
214
215			logger.debug('MainController, saving file: %s.', path)
216			try:
217			self._file.save(path)
218			except OSError as ex:
219			logger.exception("Error saving file %s", path)
220			self.showError(ex)
221			return
222			self._settings.setValue("last_open_file", path)
223			self._settings.sync()
224
225			def _updateTitle(self):
226			title = 'QTodoTxt - '
227			if self._file.filename:
228			filename = os.path.basename(self._file.filename)
229			title += filename
230			else:
231			title += 'Untitled'
232			if self._file.modified:
233			title += ' (*)'
234			self._title = title
235			self.titleChanged.emit(self._title)
236
237			titleChanged = QtCore.pyqtSignal(str)
238
239			@QtCore.pyqtProperty('QString', notify=titleChanged)
240			def title(self):
241			return self._title
242
243			@QtCore.pyqtSlot(result='bool')
244			def canExit(self):
245			self.auto_save()
246			return not self._file.modified
247
248			def new(self):
249			if self.canExit():
250			self._file = File()
251			self._loadFileToUI()
252
253			@QtCore.pyqtSlot()
254			def reload(self):
255			self.open(self._file.filename)
256
257			@QtCore.pyqtSlot('QUrl')
258			@QtCore.pyqtSlot('QString')
259			def open(self, filename):
260			if isinstance(filename, QtCore.QUrl):
261			filename = filename.toLocalFile()
262			logger.debug('MainController.open called with filename="%s"', filename)
263			try:
264			self._file.load(filename)
265			except Exception as ex:
266			self.showError(self.tr("Error opening file: {}.\n Exception:{}").format(filename, ex))
267			return
268			self._loadFileToUI()
269			self._settings.setValue("last_open_file", filename)
270			self.updateRecentFile()
271
272			recentFilesChanged = QtCore.pyqtSignal()
273
274			@QtCore.pyqtProperty('QVariant', notify=recentFilesChanged)
275			def recentFiles(self):
276			return self._recentFiles
277
278			def updateRecentFile(self):
279			if self._file.filename in self._recentFiles:
280			self._recentFiles.remove(self._file.filename)
281			self._recentFiles.insert(0, self._file.filename)
282			self._recentFiles = self._recentFiles[:int(self._settings.value("max_recent_files", 6))]
283			self._settings.setValue("recent_files", self._recentFiles)
284			self.recentFilesChanged.emit()
285
286			def _loadFileToUI(self):
287			self.applyFilters()
288			self._updateCompletionStrings()
289			self._updateFilterTree()
290

QTodoTxt / QTodoTxt2

Push — qml ( e78c5d...75cc72 )

MainController._fileModified() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like