Source code for umbra.components.factory.scriptEditor.models

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

"""
**models.py**

**Platform:**
	Windows, Linux, Mac Os X.

**Description:**
	Defines the :class:`umbra.components.factory.scriptEditor.scriptEditor.ScriptEditor`
	Component Interface class Models.

**Others:**

"""

#**********************************************************************************************************************
#***	Future imports.
#**********************************************************************************************************************
from __future__ import unicode_literals

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
import os
import re
from PyQt4.QtCore import QAbstractListModel
from PyQt4.QtCore import QModelIndex
from PyQt4.QtCore import QVariant
from PyQt4.QtCore import Qt
from PyQt4.QtCore import pyqtSignal

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.exceptions
import foundations.io
import foundations.verbose
import foundations.walkers
import umbra.ui.models
import umbra.ui.nodes
from umbra.components.factory.scriptEditor.nodes import ProjectNode
from umbra.components.factory.scriptEditor.nodes import DirectoryNode
from umbra.components.factory.scriptEditor.nodes import EditorNode
from umbra.components.factory.scriptEditor.nodes import FileNode
from umbra.components.factory.scriptEditor.nodes import PatternNode
from umbra.ui.languages import Language

#**********************************************************************************************************************
#***	Module attributes.
#**********************************************************************************************************************
__author__ = "Thomas Mansencal"
__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal"
__license__ = "GPL V3.0 - http://www.gnu.org/licenses/"
__maintainer__ = "Thomas Mansencal"
__email__ = "thomas.mansencal@gmail.com"
__status__ = "Production"

__all__ = ["LOGGER", "ProjectsModel",
			"LanguagesModel",
			"PatternsModel",
			"SearchResultsModel"]

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class ProjectsModel(umbra.ui.models.GraphModel): """ Defines the Model used by :class:`umbra.components.factory.scriptEditor.scriptEditor.ScriptEditor` Component Interface class. """ fileRegistered = pyqtSignal(FileNode) """ This signal is emited by the :class:`ProjectsModel` class when a file is registered. ( pyqtSignal ) :return: Registered file FileNode. :rtype: FileNode """ fileUnregistered = pyqtSignal(FileNode) """ This signal is emited by the :class:`ProjectsModel` class when a file is unregistered. ( pyqtSignal ) :return: Unregistered file FileNode. :rtype: FileNode """ editorRegistered = pyqtSignal(EditorNode) """ This signal is emited by the :class:`ProjectsModel` class when an editor is registered. ( pyqtSignal ) :return: Registered editor EditorNode. :rtype: EditorNode """ editorUnregistered = pyqtSignal(EditorNode) """ This signal is emited by the :class:`ProjectsModel` class when an editor is unregistered. ( pyqtSignal ) :return: Unregistered editor EditorNode. :rtype: EditorNode """ directoryRegistered = pyqtSignal(DirectoryNode) """ This signal is emited by the :class:`ProjectsModel` class when a directory is registered. ( pyqtSignal ) :return: Registered directory DirectoryNode. :rtype: DirectoryNode """ directoryUnregistered = pyqtSignal(DirectoryNode) """ This signal is emited by the :class:`ProjectsModel` class when a directory is unregistered. ( pyqtSignal ) :return: Unregistered directory DirectoryNode. :rtype: DirectoryNode """ projectRegistered = pyqtSignal(ProjectNode) """ This signal is emited by the :class:`ProjectsModel` class when a project is registered. ( pyqtSignal ) :return: Registered project ProjectNode. :rtype: ProjectNode """ projectUnregistered = pyqtSignal(ProjectNode) """ This signal is emited by the :class:`ProjectsModel` class when a project is unregistered. ( pyqtSignal ) :return: Unregistered project ProjectNode. :rtype: ProjectNode """ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None, defaultNode=None, defaultProject=None): """ Initializes the class. :param defaultProject: Default project name. :type defaultProject: unicode :param parent: Object parent. :type parent: QObject :param rootNode: Root node. :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. :type verticalHeaders: OrderedDict :param defaultNode: Default node. :type defaultNode: GraphModelNode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) umbra.ui.models.GraphModel.__init__(self, parent, rootNode, horizontalHeaders, verticalHeaders, defaultNode) # --- Setting class attributes. --- self.__defaultProject = None self.defaultProject = defaultProject or "defaultProject" self.__defaultProjectNode = None ProjectsModel.__initializeModel(self) #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def defaultProject(self): """ Property for **self.__defaultProject** attribute. :return: self.__defaultProject. :rtype: unicode """ return self.__defaultProject @defaultProject.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(AssertionError) def defaultProject(self, value): """ Setter for **self.__defaultProject** attribute. :param value: Attribute value. :type value: unicode """ if value is not None: assert type(value) is unicode, \ "'{0}' attribute: '{1}' type is not 'unicode'!".format("defaultProject", value) self.__defaultProject = value @defaultProject.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def defaultProject(self): """ Deleter for **self.__defaultProject** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "defaultProject"))
@property def defaultProjectNode(self): """ Property for **self.__defaultProjectNode** attribute. :return: self.__defaultProjectNode. :rtype: unicode """ return self.__defaultProjectNode @defaultProjectNode.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def defaultProjectNode(self, value): """ Setter for **self.__defaultProjectNode** attribute. :param value: Attribute value. :type value: unicode """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "defaultProjectNode")) @defaultProjectNode.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def defaultProjectNode(self): """ Deleter for **self.__defaultProjectNode** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "defaultProjectNode")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
def __initializeModel(self): """ Initializes the Model. """ LOGGER.debug("> Initializing model.") self.beginResetModel() self.rootNode = umbra.ui.nodes.DefaultNode(name="InvisibleRootNode") self.__defaultProjectNode = ProjectNode(name=self.__defaultProject, parent=self.rootNode, nodeFlags=int(Qt.ItemIsEnabled), attributesFlags=int(Qt.ItemIsEnabled)) self.enableModelTriggers(True) self.endResetModel()
[docs] def listEditorNodes(self, node=None): """ Returns the Model :class:`umbra.components.factory.scriptEditor.nodes.EditorNode` class nodes. :param node: Node to start walking from. :type node: AbstractNode or AbstractCompositeNode or Object :return: EditorNode nodes. :rtype: list """ return self.findFamily("Editor", node=node or self.__defaultProjectNode)
[docs] def listFileNodes(self, node=None): """ Returns the Model :class:`umbra.components.factory.scriptEditor.nodes.FileNode` class nodes. :param node: Node to start walking from. :type node: AbstractNode or AbstractCompositeNode or Object :return: FileNode nodes. :rtype: list """ return self.findFamily("File", node=node or self.__defaultProjectNode)
[docs] def listDirectoryNodes(self): """ Returns the Model :class:`umbra.components.factory.scriptEditor.nodes.DirectoryNode` class nodes. :return: DirectoryNode nodes. :rtype: list """ return self.findFamily("Directory")
[docs] def listProjectNodes(self, ignoreDefaultProjectNode=True): """ Returns the Model :class:`umbra.components.factory.scriptEditor.nodes.ProjectNode` class nodes. :param ignoreDefaultProjectNode: Default ProjectNode will be ignored. :type ignoreDefaultProjectNode: bool :return: ProjectNode nodes. :rtype: list """ projectNodes = self.findFamily("Project") return filter(lambda x: x != self.__defaultProjectNode, projectNodes) \ if ignoreDefaultProjectNode else projectNodes
[docs] def listEditors(self, node=None): """ Returns the Model editors. :param node: Node to start walking from. :type node: AbstractNode or AbstractCompositeNode or Object :return: Editors. :rtype: list """ return [editorNode.editor for editorNode in self.listEditorNodes(node) if editorNode.editor]
[docs] def listFiles(self, node=None): """ Returns the Model files. :param node: Node to start walking from. :type node: AbstractNode or AbstractCompositeNode or Object :return: FileNode nodes. :rtype: list """ return [fileNode.path for fileNode in self.listFileNodes(node) if fileNode.path]
[docs] def listDirectories(self): """ Returns the Model directories. :return: DirectoryNode nodes. :rtype: list """ return [directoryNode.path for directoryNode in self.listDirectoryNodes() if directoryNode.path]
[docs] def listProjects(self, ignoreDefaultProjectNode=True): """ Returns the Model projects. :param ignoreDefaultProjectNode: Default ProjectNode will be ignored. :type ignoreDefaultProjectNode: bool :return: ProjectNode nodes. :rtype: list """ return [projectNode.path for projectNode in self.listProjectNodes(ignoreDefaultProjectNode) if projectNode.path]
[docs] def getEditorNodes(self, editor, node=None): """ Returns the :class:`umbra.components.factory.scriptEditor.nodes.EditorNode` class Nodes with given editor. :param node: Node to start walking from. :type node: AbstractNode or AbstractCompositeNode or Object :param editor: Editor. :type editor: Editor :return: EditorNode nodes. :rtype: list """ return [editorNode for editorNode in self.listEditorNodes(node) if editorNode.editor == editor]
[docs] def getFileNodes(self, path, node=None): """ Returns the :class:`umbra.components.factory.scriptEditor.nodes.FileNode` class Nodes with given path. :param node: Node to start walking from. :type node: AbstractNode or AbstractCompositeNode or Object :param path: File path. :type path: unicode :return: FileNode nodes. :rtype: list """ return [fileNode for fileNode in self.listFileNodes(node) if fileNode.path == path]
[docs] def getDirectoryNodes(self, path): """ Returns the :class:`umbra.components.factory.scriptEditor.nodes.DirectoryNode` class Nodes with given path. :param path: Directory path. :type path: unicode :return: DirectoryNode nodes. :rtype: list """ return [directoryNode for directoryNode in self.listDirectoryNodes() if directoryNode.path == path]
[docs] def getProjectNodes(self, path): """ Returns the :class:`umbra.components.factory.scriptEditor.nodes.ProjectNode` class Nodes with given path. :param path: Project path. :type path: unicode :return: ProjectNode nodes. :rtype: list """ return [projectNode for projectNode in self.listProjectNodes() if projectNode.path == path]
[docs] def moveNode(self, parent, fromIndex, toIndex): """ Moves given parent child to given index. :param toIndex: Index to. :type toIndex: int :param fromIndex: Index from. :type fromIndex: int :return: Method success. :rtype: bool """ # TODO: Should be refactored once this ticket is fixed: # https://bugreports.qt-project.org/browse/PYSIDE-78 if not fromIndex >= 0 or \ not fromIndex < parent.childrenCount() or \ not toIndex >= 0 or \ not toIndex < parent.childrenCount(): return False parentIndex = self.getNodeIndex(parent) self.beginRemoveRows(parentIndex, fromIndex, fromIndex) child = parent.removeChild(fromIndex) self.endRemoveRows() startIndex = parent.childrenCount() - 1 endIndex = toIndex - 1 tail = [] for i in range(startIndex, endIndex, -1): self.beginRemoveRows(parentIndex, i, i) tail.append(parent.removeChild(i)) self.endRemoveRows() tail = list(reversed(tail)) tail.insert(0, child) for node in tail: row = parent.childrenCount() self.beginInsertRows(parentIndex, row, row) parent.addChild(node) self.endInsertRows() return True # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def registerFile(self, file, parent, ensureUniqueness=False): """ Registers given file in the Model. :param file: File to register. :type file: unicode :param parent: FileNode parent. :type parent: GraphModelNode :param ensureUniqueness: Ensure registrar uniqueness. :type ensureUniqueness: bool :return: FileNode. :rtype: FileNode """ if ensureUniqueness: if self.getFileNodes(file): raise foundations.exceptions.ProgrammingError("{0} | '{1}' file is already registered!".format( self.__class__.__name__, file)) LOGGER.debug("> Registering '{0}' file.".format(file)) row = parent.childrenCount() self.beginInsertRows(self.getNodeIndex(parent), row, row) fileNode = FileNode(name=os.path.basename(file), path=file, parent=parent) self.endInsertRows() self.fileRegistered.emit(fileNode) return fileNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def unregisterFile(self, fileNode, raiseException=False): """ Unregisters given :class:`umbra.components.factory.scriptEditor.nodes.FileNode` class Node from the Model. :param fileNode: FileNode to unregister. :type fileNode: FileNode :param raiseException: Raise the exception. :type raiseException: bool :return: FileNode. :rtype: FileNode """ if raiseException: if not fileNode in self.listFileNodes(): raise foundations.exceptions.ProgrammingError("{0} | '{1}' file 'FileNode' isn't registered!".format( self.__class__.__name__, fileNode)) LOGGER.debug("> Unregistering '{0}' file 'FileNode'.".format(fileNode)) parent = fileNode.parent row = fileNode.row() self.beginRemoveRows(self.getNodeIndex(parent), row, row) parent.removeChild(row) self.endRemoveRows() self.fileUnregistered.emit(fileNode) return fileNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def registerDirectory(self, directory, parent, ensureUniqueness=False): """ Registers given directory in the Model. :param directory: Directory to register. :type directory: unicode :param parent: DirectoryNode parent. :type parent: GraphModelNode :param ensureUniqueness: Ensure registrar uniqueness. :type ensureUniqueness: bool :return: DirectoryNode. :rtype: DirectoryNode """ if ensureUniqueness: if self.getDirectoryNodes(directory): raise foundations.exceptions.ProgrammingError("{0} | '{1}' directory is already registered!".format( self.__class__.__name__, directory)) LOGGER.debug("> Registering '{0}' directory.".format(directory)) row = parent.childrenCount() self.beginInsertRows(self.getNodeIndex(parent), row, row) directoryNode = DirectoryNode(name=os.path.basename(directory), path=directory, parent=parent) self.endInsertRows() self.directoryRegistered.emit(directoryNode) return directoryNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def unregisterDirectory(self, directoryNode, raiseException=False): """ Unregisters given :class:`umbra.components.factory.scriptEditor.nodes.DirectoryNode` class Node from the Model. :param directoryNode: DirectoryNode to unregister. :type directoryNode: DirectoryNode :param raiseException: Raise the exception. :type raiseException: bool :return: DirectoryNode. :rtype: DirectoryNode """ if raiseException: if not directoryNode in self.listDirectoryNodes(): raise foundations.exceptions.ProgrammingError("{0} | '{1}' directory 'DirectoryNode' isn't registered!".format( self.__class__.__name__, directoryNode)) LOGGER.debug("> Unregistering '{0}' directory 'DirectoryNode'.".format(directoryNode)) parent = directoryNode.parent row = directoryNode.row() self.beginRemoveRows(self.getNodeIndex(parent), row, row) parent.removeChild(row) self.endRemoveRows() self.directoryUnregistered.emit(directoryNode) return directoryNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def registerEditor(self, editor, parent, ensureUniqueness=False): """ Registers given :class:`umbra.components.factory.scriptEditor.editor.Editor` class editor in the Model. :param editor: Editor to register. :type editor: Editor :param parent: EditorNode parent. :type parent: GraphModelNode :param ensureUniqueness: Ensure registrar uniqueness. :type ensureUniqueness: bool :return: EditorNode. :rtype: EditorNode """ if ensureUniqueness: if self.getEditorNodes(editor): raise foundations.exceptions.ProgrammingError("{0} | '{1}' editor is already registered!".format( self.__class__.__name__, editor)) LOGGER.debug("> Registering '{0}' editor.".format(editor)) row = parent.childrenCount() self.beginInsertRows(self.getNodeIndex(parent), row, row) editorNode = EditorNode(editor=editor, parent=parent) self.endInsertRows() self.editorRegistered.emit(editorNode) return editorNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def unregisterEditor(self, editorNode, raiseException=False): """ Unregisters given :class:`umbra.components.factory.scriptEditor.nodes.EditorNode` class Node from the Model. :param editorNode: EditorNode to unregister. :type editorNode: EditorNode :param raiseException: Raise the exception. :type raiseException: bool :return: EditorNode. :rtype: EditorNode """ if raiseException: if not editorNode in self.listEditorNodes(): raise foundations.exceptions.ProgrammingError("{0} | '{1}' editor 'EditorNode' isn't registered!".format( self.__class__.__name__, editorNode)) LOGGER.debug("> Unregistering '{0}' editor 'EditorNode'.".format(editorNode)) parent = editorNode.parent row = editorNode.row() self.beginRemoveRows(self.getNodeIndex(parent), row, row) parent.removeChild(row) self.endRemoveRows() self.editorUnregistered.emit(editorNode) return editorNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def registerProject(self, path, ensureUniqueness=False): """ Registers given path in the Model as a project. :param path: Project path to register. :type path: unicode :param ensureUniqueness: Ensure registrar uniqueness. :type ensureUniqueness: bool :return: ProjectNode. :rtype: ProjectNode """ if ensureUniqueness: if self.getProjectNodes(path): raise foundations.exceptions.ProgrammingError("{0} | '{1}' project is already registered!".format( self.__class__.__name__, path)) LOGGER.debug("> Registering '{0}' project.".format(path)) row = self.rootNode.childrenCount() self.beginInsertRows(self.getNodeIndex(self.rootNode,), row, row) projectNode = ProjectNode(name=os.path.basename(path), path=path, parent=self.rootNode) self.endInsertRows() self.projectRegistered.emit(projectNode) return projectNode # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def unregisterProject(self, projectNode, raiseException=False): """ Unregisters given :class:`umbra.components.factory.scriptProject.nodes.ProjectNode` class Node from the Model. :param projectNode: ProjectNode to unregister. :type projectNode: ProjectNode :param raiseException: Raise the exception. :type raiseException: bool :return: ProjectNode. :rtype: ProjectNode """ if raiseException: if not projectNode in self.listProjectNodes(): raise foundations.exceptions.ProgrammingError("{0} | '{1}' project 'ProjectNode' isn't registered!".format( self.__class__.__name__, projectNode)) LOGGER.debug("> Unregistering '{0}' project 'ProjectNode'.".format(projectNode)) parent = projectNode.parent row = projectNode.row() self.beginRemoveRows(self.getNodeIndex(parent), row, row) parent.removeChild(row) self.endRemoveRows() self.projectUnregistered.emit(projectNode) return projectNode
[docs] def isAuthoringNode(self, node): """ Returns if given Node is an authoring node. :param node: Node. :type node: ProjectNode or DirectoryNode or FileNode :return: Is authoring node. :rtype: bool """ for parentNode in foundations.walkers.nodesWalker(node, ascendants=True): if parentNode is self.__defaultProjectNode: return True return False
[docs] def setAuthoringNodes(self, editor): """ Sets the Model authoring Nodes using given editor. :param editor: Editor to set. :type editor: Editor :return: Method success. :rtype: bool """ projectNode = self.defaultProjectNode fileNode = self.registerFile(editor.file, projectNode) editorNode = self.registerEditor(editor, fileNode) return True
[docs] def deleteAuthoringNodes(self, editor): """ Deletes the Model authoring Nodes associated with given editor. :param editor: Editor. :type editor: Editor :return: Method success. :rtype: bool """ editorNode = foundations.common.getFirstItem(self.getEditorNodes(editor)) fileNode = editorNode.parent self.unregisterEditor(editorNode) self.unregisterFile(fileNode, raiseException=False) return True
[docs] def updateAuthoringNodes(self, editor): """ Updates given editor Model authoring nodes. :param editor: Editor. :type editor: Editor :return: Method success. :rtype: bool """ editorNode = foundations.common.getFirstItem(self.getEditorNodes(editor)) fileNode = editorNode.parent file = editor.file fileNode.name = editorNode.name = os.path.basename(file) fileNode.path = editorNode.path = file self.nodeChanged(fileNode) return True
[docs] def setProjectNodes(self, rootNode, maximumDepth=1): """ Sets the project Model children Nodes using given root node. :param rootNode: Root node. :type rootNode: ProjectNode or DirectoryNode :param maximumDepth: Maximum nodes nesting depth. :type maximumDepth: int """ rootDirectory = rootNode.path for parentDirectory, directories, files in foundations.walkers.depthWalker(rootDirectory, maximumDepth): if parentDirectory == rootDirectory: parentNode = rootNode else: parentNode = foundations.common.getFirstItem( [node for node in foundations.walkers.nodesWalker(rootNode) \ if node.family == "Directory" and node.path == parentDirectory]) if not parentNode: continue paths = [node.path for node in parentNode.children] for directory in sorted(directories): if directory.startswith("."): continue path = os.path.join(parentDirectory, directory) if path in paths: continue directoryNode = self.registerDirectory(path, parentNode) for file in sorted(files): if file.startswith("."): continue path = os.path.join(parentDirectory, file) if path in paths: continue if foundations.io.isReadable(path): if foundations.io.isBinaryFile(path): continue fileNode = self.registerFile(path, parentNode)
[docs] def deleteProjectNodes(self, node): """ Deletes the Model project Nodes associated with given node. :param node: Node. :type node: ProjectNode """ self.unregisterProjectNodes(node) self.unregisterProject(node)
[docs] def unregisterProjectNodes(self, node): """ Unregisters given Node children. :param node: Node. :type node: ProjectNode or DirectoryNode """ for node in reversed(list(foundations.walkers.nodesWalker(node))): if node.family == "Directory": self.unregisterDirectory(node) elif node.family == "File": self.unregisterFile(node)
[docs] def updateProjectNodes(self, node): """ Updates given root Node children. :param node: Node. :type node: ProjectNode or DirectoryNode """ self.unregisterProjectNodes(node) self.setProjectNodes(node)
[docs]class LanguagesModel(QAbstractListModel): """ Defines a `QAbstractListModel <http://doc.qt.nokia.com/qabstractListmodel.html>`_ subclass used to store the :class:`umbra.components.factory.scriptEditor.scriptEditor.ScriptEditor` Component Interface class languages. """ def __init__(self, parent=None, languages=None): """ Initializes the class. :param parent: Parent object. :type parent: QObject :param languages: Languages. :type languages: list """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) QAbstractListModel.__init__(self, parent) # --- Setting class attributes. --- self.__languages = [] self.languages = languages #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def languages(self): """ Property for **self.__languages** attribute. :return: self.__languages. :rtype: list """ return self.__languages @languages.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(AssertionError) def languages(self, value): """ Setter for **self.__languages** attribute. :param value: Attribute value. :type value: list """ if value is not None: assert type(value) is list, "'{0}' attribute: '{1}' type is not 'list'!".format("languages", value) for element in value: assert type(element) is Language, "'{0}' attribute: '{1}' type is not 'Language'!".format("languages", element) self.beginResetModel() self.__languages = value self.endResetModel() @languages.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def languages(self): """ Deleter for **self.__languages** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "languages")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
[docs] def rowCount(self, parent=QModelIndex()): """ Reimplements the :meth:`QAbstractListModel.rowCount` method. :param parent: Parent. :type parent: QModelIndex :return: Row count. :rtype: int """ return len(self.__languages)
[docs] def data(self, index, role=Qt.DisplayRole): """ Reimplements the :meth:`QAbstractListModel.data` method. :param index: Index. :type index: QModelIndex :param role: Role. :type role: int :return: Data. :rtype: QVariant """ if not index.isValid(): return QVariant() if role == Qt.DisplayRole: return QVariant(self.__languages[index.row()].name) return QVariant()
[docs] def sortLanguages(self, order=Qt.AscendingOrder): """ Sorts the Model languages. :param order: Order. ( Qt.SortOrder ) """ self.beginResetModel() self.__languages = sorted(self.__languages, key=lambda x: (x.name), reverse=order) self.endResetModel() # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def registerLanguage(self, language): """ Registers given language in the :obj:`LanguagesModel.languages` class property. :param language: Language to register. :type language: Language :return: Method success. :rtype: bool """ if self.getLanguage(language): raise foundations.exceptions.ProgrammingError("{0} | '{1}' language is already registered!".format( self.__class__.__name__, language.name)) LOGGER.debug("> Registering '{0}' language.".format(language.name)) self.__languages.append(language) self.sortLanguages() return True # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def unregisterLanguage(self, name): """ Unregisters language with given name from the :obj:`LanguagesModel.languages` class property. :param name: Language to unregister. :type name: unicode :return: Method success. :rtype: bool """ if not self.getLanguage(name): raise foundations.exceptions.ProgrammingError("{0} | '{1}' language isn't registered!".format( self.__class__.__name__, name)) LOGGER.debug("> Unregistering '{0}' language.".format(name)) for i, language in enumerate(self.__languages): if not language.name == name: continue del(self.__languages[i]) self.sortLanguages() return True
[docs] def getLanguage(self, name): """ Returns the language with given name. :param name: Language name. :type name: unicode :return: File language. :rtype: Language """ for language in self.__languages: if language.name == name: LOGGER.debug("> Language '{0}': '{1}'.".format(name, language)) return language
[docs] def getFileLanguage(self, file): """ Returns the language of given file. :param file: File to get language of. :type file: unicode :return: File language. :rtype: Language """ for language in self.__languages: if re.search(language.extensions, file): LOGGER.debug("> '{0}' file detected language: '{1}'.".format(file, language.name)) return language
[docs]class PatternsModel(umbra.ui.models.GraphModel): """ Defines the Model used the by :class:`umbra.patterns.factory.scriptEditor.searchAndReplace.SearchAndReplace` class to store the search and \ replace patterns. """ # Custom signals definitions. patternInserted = pyqtSignal(PatternNode) """ This signal is emited by the :class:`PatternsModel` class when a pattern has been inserted. ( pyqtSignal ) :return: Inserted pattern node. :rtype: PatternNode """ # Custom signals definitions. patternRemoved = pyqtSignal(PatternNode) """ This signal is emited by the :class:`PatternsModel` class when a pattern has been removed. ( pyqtSignal ) :return: Removed pattern node. :rtype: PatternNode """ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None): """ Initializes the class. :param parent: Object parent. :type parent: QObject :param rootNode: Root node. :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. :type verticalHeaders: OrderedDict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) umbra.ui.models.GraphModel.__init__(self, parent, rootNode, horizontalHeaders, verticalHeaders, PatternNode) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
[docs] def initializeModel(self, rootNode): """ Initializes the Model using given root node. :param rootNode: Graph root node. :type rootNode: DefaultNode :return: Method success :rtype: bool """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) self.beginResetModel() self.rootNode = rootNode self.enableModelTriggers(True) self.endResetModel() return True
[docs] def insertPattern(self, pattern, index): """ Inserts given pattern into the Model. :param pattern: Pattern. :type pattern: unicode :param index: Insertion index. :type index: int :return: Method success. :rtype: bool """ LOGGER.debug("> Inserting '{0}' at '{1}' index.".format(pattern, index)) self.removePattern(pattern) self.beginInsertRows(self.getNodeIndex(self.rootNode), index, index) patternNode = PatternNode(name=pattern) self.rootNode.insertChild(patternNode, index) self.endInsertRows() self.patternInserted.emit(patternNode) return True
[docs] def removePattern(self, pattern): """ Removes given pattern from the Model. :param pattern: Pattern. :type pattern: unicode :return: Method success. :rtype: bool """ for index, node in enumerate(self.rootNode.children): if node.name != pattern: continue LOGGER.debug("> Removing '{0}' at '{1}' index.".format(pattern, index)) self.beginRemoveRows(self.getNodeIndex(self.rootNode), index, index) patternNode = self.rootNode.child(index) self.rootNode.removeChild(index) self.endRemoveRows() self.patternRemoved.emit(patternNode) return True
[docs]class SearchResultsModel(umbra.ui.models.GraphModel): """ Defines the Model used the by :class:`umbra.patterns.factory.scriptEditor.searchInFiles.SearchInFiles` class to store the search results. """ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None, defaultNode=None): """ Initializes the class. :param parent: Object parent. :type parent: QObject :param rootNode: Root node. :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. :type verticalHeaders: OrderedDict :param defaultNode: Default node. :type defaultNode: GraphModelNode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) umbra.ui.models.GraphModel.__init__(self, parent, rootNode, horizontalHeaders, verticalHeaders, defaultNode) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
[docs] def initializeModel(self, rootNode): """ Initializes the Model using given root node. :param rootNode: Graph root node. :type rootNode: DefaultNode :return: Method success :rtype: bool """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) self.beginResetModel() self.rootNode = rootNode self.enableModelTriggers(True) self.endResetModel() return True
[docs] def getMetrics(self): """ Returns the Model metrics. :return: Nodes metrics. :rtype: dict """ searchFileNodesCount = searchOccurenceNodesCount = 0 for node in foundations.walkers.nodesWalker(self.rootNode): if node.family == "SearchFile": searchFileNodesCount += 1 elif node.family == "SearchOccurence": searchOccurenceNodesCount += 1 return {"SearchFile" : searchFileNodesCount, "SearchOccurence" : searchOccurenceNodesCount}