Source code for umbra.ui.common

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

"""
**common.py**

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

**Description:**
	Defines common ui manipulation related objects.

**Others:**

"""

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

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
import fnmatch
import functools
import os
import re
import sys
from PyQt4.QtCore import QString
from PyQt4.QtCore import QStringList
from PyQt4.QtCore import QVariant
from PyQt4.QtCore import Qt
from PyQt4.QtGui import QAbstractButton
from PyQt4.QtGui import QApplication
from PyQt4.QtGui import QIcon

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.common
import foundations.dataStructures
import foundations.exceptions
import foundations.strings
import foundations.verbose
import umbra.exceptions
from foundations.parsers import SectionsFileParser
from umbra.globals.constants import Constants
from umbra.globals.runtimeGlobals import RuntimeGlobals
from umbra.globals.uiConstants import UiConstants

#**********************************************************************************************************************
#***	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",
		"Location",
		"getApplicationInstance",
		"parseLocation",
		"getResourcePath",
		"setWindowDefaultIcon",
		"getSectionsFileParser",
		"storeLastBrowsedPath",
		"getQVariantAsString",
		"parentsWalker",
		"signalsBlocker",
		"showWaitCursor",
		"setToolBoxHeight",
		"setChildrenPadding"]

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class Location(foundations.dataStructures.Structure): """ Defines a storage object for the :class:`SearchInFiles` class location. """ def __init__(self, **kwargs): """ Initializes the class. :param \*\*kwargs: directories, files, filtersIn, filtersOut, targets. :type \*\*kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) foundations.dataStructures.Structure.__init__(self, **kwargs)
[docs]def getApplicationInstance(): """ Returns the current `QApplication <http://doc.qt.nokia.com/qapplication.html>`_ instance or create one if it doesn't exists. :return: Application instance. :rtype: QApplication """ instance = QApplication.instance() if not instance: instance = QApplication(sys.argv) return instance
[docs]def parseLocation(data): """ Parses given location data. :param data: Exception. :type data: Exception :return: Location object. :rtype: Location """ tokens = data.split(",") location = Location(directories=[], files=[], filtersIn=[], filtersOut=[], targets=[]) if not tokens: return location for token in tokens: token = token.strip() if not token: continue if foundations.common.pathExists(token): if os.path.isdir(token): location.directories.append(token) else: location.files.append(token) else: match = re.match("(?P<filterIn>\*\.\w+)", token) if match: location.filtersIn.append(fnmatch.translate(match.group("filterIn"))) continue match = re.match("!(?P<filterOut>\*\.\w+)", token) if match: location.filtersOut.append(fnmatch.translate(match.group("filterOut"))) continue match = re.match("\<(?P<target>[\w ]+)\>", token) if match: location.targets.append(match.group("target")) continue return location # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(umbra.exceptions.ResourceExistsError)
[docs]def getResourcePath(name, raiseException=False): """ Returns the resource file path matching the given name. :param name: Resource name. :type name: unicode :param raiseException: Raise the exception. :type raiseException: bool :return: Resource path. :rtype: unicode """ if not RuntimeGlobals.resourcesDirectories: RuntimeGlobals.resourcesDirectories.append( os.path.normpath(os.path.join(umbra.__path__[0], Constants.resourcesDirectory))) for path in RuntimeGlobals.resourcesDirectories: path = os.path.join(path, name) if foundations.common.pathExists(path): LOGGER.debug("> '{0}' resource path: '{1}'.".format(name, path)) return path if raiseException: raise umbra.exceptions.ResourceExistsError( "{0} | No resource file path found for '{1}' name!".format(__name__, name))
[docs]def setWindowDefaultIcon(window): """ Sets the default Application icon to the given window. :param window: Window. :type window: QWidget :return: Definition success. :rtype: bool """ window.setWindowIcon(QIcon(getResourcePath(UiConstants.applicationWindowsIcon))) return True # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError)
[docs]def getSectionsFileParser(file): """ Returns a sections file parser. :param file: File. :type file: unicode :return: Parser. :rtype: SectionsFileParser """ if not foundations.common.pathExists(file): raise foundations.exceptions.FileExistsError("{0} | '{1}' sections file doesn't exists!".format(__name__, file)) sectionsFileParser = SectionsFileParser(file) sectionsFileParser.parse() return sectionsFileParser # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(TypeError)
[docs]def storeLastBrowsedPath(data): """ Defines a wrapper method used to store the last browsed path. :param data: Path data. :type data: QString or QList :return: Last browsed path. :rtype: unicode """ if type(data) in (tuple, list, QStringList): data = [foundations.strings.toString(path) for path in data] lastBrowsedPath = foundations.common.getFirstItem(data) elif type(data) in (unicode, QString): data = lastBrowsedPath = foundations.strings.toString(data) else: raise TypeError("{0} | '{1}' type is not supported!".format(__name__, type(data))) if foundations.common.pathExists(lastBrowsedPath): lastBrowsedPath = os.path.normpath(lastBrowsedPath) if os.path.isfile(lastBrowsedPath): lastBrowsedPath = os.path.dirname(lastBrowsedPath) LOGGER.debug("> Storing last browsed path: '%s'.", lastBrowsedPath) RuntimeGlobals.lastBrowsedPath = lastBrowsedPath return data
[docs]def getQVariantAsString(data): """ Returns given `QVariant <http://doc.qt.nokia.com/qvariant.html>`_ data as a string. :param data: Given data. :type data: object :return: QVariant data as string. :rtype: unicode """ if isinstance(data, QVariant): data = data.toString() data = QString(data) return foundations.strings.toString(data)
[docs]def parentsWalker(object): """ Defines a generator used to retrieve the chain of parents of the given :class:`QObject` instance. :param object: Given path. :type object: QObject :yield: Object parent. ( QObject ) """ while object.parent(): object = object.parent() yield object
[docs]def signalsBlocker(instance, attribute, *args, **kwargs): """ Blocks given instance signals before calling the given attribute with \ given arguments and then unblocks the signals. :param instance: Instance object. :type instance: QObject :param attribute: Attribute to call. :type attribute: QObject :param \*args: Arguments. :type \*args: \* :param \*\*kwargs: Keywords arguments. :type \*\*kwargs: \*\* :return: Object. :rtype: object """ value = None try: hasattr(instance, "blockSignals") and instance.blockSignals(True) value = attribute(*args, **kwargs) finally: hasattr(instance, "blockSignals") and instance.blockSignals(False) return value
[docs]def showWaitCursor(object): """ Shows a wait cursor while processing. :param object: Object to decorate. :type object: object :return: Object. :rtype: object """ # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @functools.wraps(object) def showWaitCursorWrapper(*args, **kwargs): """ Shows a wait cursor while processing. :param \*args: Arguments. :type \*args: \* :param \*\*kwargs: Keywords arguments. :type \*\*kwargs: \*\* :return: Object. :rtype: object """ QApplication.setOverrideCursor(Qt.WaitCursor) value = None try: value = object(*args, **kwargs) finally: QApplication.restoreOverrideCursor() return value return showWaitCursorWrapper
[docs]def setToolBoxHeight(toolBox, height=32): """ Sets given height to given QToolBox widget. :param toolbox: ToolBox. :type toolbox: QToolBox :param height: Height. :type height: int :return: Definition success. :rtype: bool """ for button in toolBox.findChildren(QAbstractButton): button.setMinimumHeight(height) return True
[docs]def setChildrenPadding(widget, types, height=None, width=None): """ Sets given Widget children padding. :param widget: Widget to sets the children padding. :type widget: QWidget :param types: Children types. :type types: tuple or list :param height: Height padding. :type height: int :param width: Width padding. :type width: int :return: Definition success. :rtype: bool """ for type in types: for child in widget.findChildren(type): child.setStyleSheet("{0}{{height: {1}px; width: {2}px;}}".format( type.__name__, child.fontMetrics().height() + (height if height is not None else 0) * 2, child.fontMetrics().width(child.text()) + (width if width is not None else 0) * 2)) return True