Source code for camelot.admin.application_admin

#  ============================================================================
#
#  Copyright (C) 2007-2011 Conceptive Engineering bvba. All rights reserved.
#  www.conceptive.be / project-camelot@conceptive.be
#
#  This file is part of the Camelot Library.
#
#  This file may be used under the terms of the GNU General Public
#  License version 2.0 as published by the Free Software Foundation
#  and appearing in the file license.txt included in the packaging of
#  this file.  Please review this information to ensure GNU
#  General Public Licensing requirements will be met.
#
#  If you are unsure which license is appropriate for your use, please
#  visit www.python-camelot.com or contact project-camelot@conceptive.be
#
#  This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
#  WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
#  For use of this library in commercial applications, please contact
#  project-camelot@conceptive.be
#
#  ============================================================================

import os
import logging
logger = logging.getLogger('camelot.admin.application_admin')

from PyQt4 import QtCore, QtGui

from camelot.view.model_thread import model_function
from camelot.core.backup import BackupMechanism
from camelot.core.utils import ugettext_lazy as _
from camelot.view import art
from camelot.view import database_selection

_application_admin_ = []

#
# The translations data needs to be kept alive during the
# running of the application
#
_translations_data_ = []

[docs]def get_application_admin(): if not len(_application_admin_): raise Exception('No application admin class has been constructed yet') return _application_admin_[0]
[docs]class ApplicationAdmin(QtCore.QObject): """The ApplicationAdmin class defines how the application should look like, it also ties Python classes to their associated :class:`camelot.admin.object_admin.ObjectAdmin` class or subclass. It's behaviour can be steered by overwriting its static attributes or it's methods : .. attribute:: name The name of the application, as it will appear in the title of the main window. .. attribute:: application_url The url of the web site where the user can find more information on the application. .. attribute:: help_url Points to either a local html file or a web site that contains the documentation of the application. .. attribute:: author The name of the author of the application .. attribute:: domain The domain name of the author of the application, eg 'mydomain.com', this domain will be used to store settings of the application. .. attribute:: version A string with the version of the application .. attribute:: backup_mechanism A subclass of :class:`camelot.core.backup.BackupMechanism` that enables the application to perform backups an restores. .. attribute:: database_profile_wizard The wizard that should be used to create new database profiles. Defaults to :class:`camelot.view.database_selection.ProfileWizard` .. attribute:: database_selection if this is set to True, present the user with a database selection wizard prior to starting the application. Defaults to :keyword:`False`. """ backup_mechanism = BackupMechanism database_profile_wizard = database_selection.ProfileWizard name = 'Camelot' application_url = None help_url = 'http://www.python-camelot.com/docs.html' author = 'Conceptive Engineering' domain = 'python-camelot.com' version = '1.0' admins = {} # This signal is emitted whenever the sections are changed, and the views # should be updated sections_changed_signal = QtCore.pyqtSignal() # This signal is emitted whenever the tile of the main window needs to # be changed. title_changed_signal = QtCore.pyqtSignal(str) # Emitted whenever the application actions need to be changed actions_changed_signal = QtCore.pyqtSignal() database_selection = False def __init__(self): """Construct an ApplicationAdmin object and register it as the prefered ApplicationAdmin to use througout the application""" QtCore.QObject.__init__(self) _application_admin_.append(self) # # Cache created ObjectAdmin objects # self._object_admin_cache = {}
[docs] def register(self, entity, admin_class): """Associate a certain ObjectAdmin class with another class. This ObjectAdmin will be used as default to render object the specified type. :param entity: :class:`class` :param admin_class: a subclass of :class:`camelot.admin.object_admin.ObjectAdmin` or :class:`camelot.admin.entity_admin.EntityAdmin` """ self.admins[entity] = admin_class
@model_function
[docs] def get_sections(self): """A list of :class:`camelot.admin.section.Section` objects, these are the sections to be displayed in the left panel. .. image:: /_static/picture2.png """ from camelot.admin.section import Section return [ Section( _('Relations'), self ), Section( _('Configuration'), self ), ]
[docs] def get_entity_admin(self, entity): """Get the default :class:`camelot.admin.object_admin.ObjectAdmin` class for a specific entity, return None, if not known. The ObjectAdmin should either be registered through the :meth:`register` method or be defined as an inner class with name :keyword:`Admin` of the entity. :param entity: a :class:`class` deprecated : use get_related_admin instead """ admin_class = None try: admin_class = self.admins[entity] except KeyError: pass if not admin_class and hasattr(entity, 'Admin'): admin_class = entity.Admin if admin_class: try: return self._object_admin_cache[admin_class] except KeyError: admin = admin_class(self, entity) self._object_admin_cache[admin_class] = admin return admin
[docs] def create_main_window(self): """Create the main window that will be shown when the application starts up. By default, returns an instance of :class:`camelot.view.mainwindow.MainWindow` :return: a :class:`PyQt4.QtGui.QWidget` """ from camelot.view.mainwindow import MainWindow mainwindow = MainWindow(self) shortcut_versions = QtGui.QShortcut( QtCore.Qt.CTRL+QtCore.Qt.ALT+QtCore.Qt.Key_V, mainwindow ) shortcut_versions.activated.connect( self.show_versions ) shortcut_dump_state = QtGui.QShortcut( QtCore.Qt.CTRL+QtCore.Qt.ALT+QtCore.Qt.Key_D, mainwindow ) shortcut_dump_state.activated.connect( self.dump_state ) shortcut_read_null = QtGui.QShortcut( QtCore.Qt.CTRL+QtCore.Qt.ALT+QtCore.Qt.Key_0, mainwindow ) shortcut_read_null.activated.connect( self.read_null ) return mainwindow
@QtCore.pyqtSlot()
[docs] def show_versions(self): """Pops up a messagebox showing the version of certain libraries used. This is for debugging purposes.""" logger.debug('showing about message box with versions') abtmsg = self.get_versions() QtGui.QMessageBox.about(None, 'Versions', abtmsg) logger.debug('about message with versions closed')
[docs] def get_actions(self): """ :return: a list of :class:`camelot.admin.application_action.ApplicationAction` objects that should be added to the menu and the icon bar for this application """ return []
[docs] def get_name(self): """ :return: the name of the application, by default this is the class attribute name""" return unicode( self.name )
[docs] def get_version(self): """:return: string representing version of the application, by default this is the class attribute verion""" return self.version
[docs] def get_icon(self): """:return: the :class:`camelot.view.art.Icon` that should be used for the application""" from camelot.view.art import Icon return Icon('tango/32x32/apps/system-users.png').getQIcon()
[docs] def get_splashscreen(self): """:return: a :class:`PyQt4.QtGui.QPixmap` to be used as splash screen""" from camelot.view.art import Pixmap return Pixmap('splashscreen.png').getQPixmap()
[docs] def get_organization_name(self): return self.author
[docs] def get_organization_domain(self): return self.domain
[docs] def get_help_url(self): """:return: a :class:`PyQt4.QtCore.QUrl` pointing to the index page for help""" from PyQt4.QtCore import QUrl if self.help_url: return QUrl( self.help_url )
[docs] def get_whats_new(self): """:return: a widget that has a show() method """ return None
[docs] def get_affiliated_url(self): """:return: a :class:`PyQt4.QtCore.QUrl` pointing to an affiliated webpage When this method returns a QUrl, an additional item will be available in the 'Help' menu, when clicked the system browser will be opened an pointing to this url. This can be used to connect the user to a website that is used a lot in the organization, but hard to remember. """ from PyQt4.QtCore import QUrl if self.application_url: return QUrl( self.application_url )
[docs] def get_remote_support_url(self): """:return: a :class:`PyQt4.QtCore.QUrl` pointing to a page to get remote support When this method returns a QUrl, an additional item will be available in the 'Help' menu, when clicked the system browser will be opened an pointing to this url. This can be used to connect the user to services like logmein.com, an online ticketing system or others. """ return None
[docs] def get_stylesheet(self): """ :return: a string with the qt stylesheet to be used for this application as a string or None if no stylesheet needed. Camelot comes with a couple of default stylesheets : * stylesheet/office2007_blue.qss * stylesheet/office2007_black.qss * stylesheet/office2007_silver.qss Have a look at the default implementation to use another stylesheet. """ return art.read('stylesheet/office2007_blue.qss')
def _load_translator_from_file( self, module_name, file_name, directory = '', search_delimiters = '_', suffix = '.qm' ): """ Tries to create a translator based on a file stored within a module. The file is loaded through the pkg_resources, to enable loading it from within a Python egg. This method tries to mimic the behavior of :meth:`QtCore.QTranslator.load` while looking for an appropriate translation file. :param module_name: the name of the module in which to look for the translation file with pkg_resources. :param file_name: the filename of the the tranlations file, without suffix :param directory: the directory, relative to the module in which to look for translation files :param suffix: the suffix of the filename :return: :keyword:None if unable to load the file, otherwise a :obj:`QtCore.QTranslator` object. """ from camelot.core.resources import resource_string file_names = [] for search_delimiter in search_delimiters: file_name_parts = file_name.split( search_delimiter ) for i in range( len(file_name_parts) ): partial_file_name = search_delimiter.join( file_name_parts[:len(file_name_parts)-i] ) file_names.append( partial_file_name + suffix ) file_names.append( partial_file_name ) translations = None for file_name in file_names: try: translations = resource_string( module_name, os.path.join(directory,file_name) ) break except IOError: pass if translations: _translations_data_.append( translations ) # keep the data alive translator = QtCore.QTranslator() if translator.loadFromData( translations ): logger.info("add translation %s" % (directory + file_name)) return translator
[docs] def get_translator(self): """Reimplement this method to add application specific translations to your application. The default method returns a list with the default Qt and the default Camelot translator for the current system locale. Call :meth:`QLocale.setDefault` before this method is called if you want to load different translations then the system default. :return: a list of :obj:`QtCore.QTranslator` objects that should be used to translate the application """ translators = [] qt_translator = QtCore.QTranslator() locale_name = QtCore.QLocale().name() language_name = locale_name.split('_')[0] logger.info( u'using locale %s'%locale_name ) if qt_translator.load( "qt_" + locale_name, QtCore.QLibraryInfo.location( QtCore.QLibraryInfo.TranslationsPath ) ): translators.append( qt_translator ) camelot_translator = self._load_translator_from_file( 'camelot', 'camelot', 'art/translations/%s/LC_MESSAGES/'%language_name ) if camelot_translator: translators.append( camelot_translator ) else: logger.debug( 'no camelot translations found for %s'%locale_name ) return translators
[docs] def get_about(self): """:return: the content of the About dialog, a string with html syntax""" import datetime from camelot.core import license today = datetime.date.today() return """<b>Camelot</b><br/> Building desktop applications at warp speed <p> Copyright &copy; 2007-%s Conceptive Engineering. All rights reserved. </p> <p> %s </p> <p> http://www.python-camelot.com<br/> http://www.conceptive.be </p> """%(today.year, license.license_type)
[docs] def get_versions(self): """ :return: html which displays the versions of used libs for development """ import sys import sqlalchemy import elixir import chardet import jinja2 import xlrd import xlwt return """<em>Python:</em> <b>%s</b><br> <em>Qt:</em> <b>%s</b><br> <em>PyQt:</em> <b>%s</b><br> <em>SQLAlchemy:</em> <b>%s</b><br> <em>Elixir:</em> <b>%s</b><br> <em>Chardet:</em> <b>%s</b><br> <em>Jinja:</em> <b>%s</b><br> <em>xlrd:</em> <b>%s</b><br> <em>xlwt:</em> <b>%s</b><br><br> <em>path:<br></em> %s""" % ('.'.join([str(el) for el in sys.version_info]), float('.'.join(str(QtCore.QT_VERSION_STR).split('.')[0:2])), QtCore.PYQT_VERSION_STR, sqlalchemy.__version__, elixir.__version__, chardet.__version__, jinja2.__version__, xlrd.__VERSION__, xlwt.__VERSION__, unicode(sys.path))
[docs] def read_null(self): """Create a segmentation fault by reading null, this is to test the faulthandling functions. this method is triggered by pressing :kbd:`Ctrl-Alt-0` in the GUI""" ok = QtGui.QMessageBox.critical( None, 'Experimental segfault', 'Are you sure you want to segfault the application', buttons = QtGui.QMessageBox.No | QtGui.QMessageBox.Yes ) if ok == QtGui.QMessageBox.Yes: import faulthandler faulthandler._read_null()
[docs] def dump_state(self): """Dump the state of the application to the output, this method is triggered by pressing :kbd:`Ctrl-Alt-D` in the GUI""" from camelot.view.model_thread import post from camelot.view.register import dump_register from camelot.view.proxy.collection_proxy import CollectionProxy import gc gc.collect() dump_register() def dump_session_state(): import collections from camelot.model.authentication import Person print '======= begin session ==============' type_counter = collections.defaultdict(int) for o in Person.query.session: type_counter[type(o).__name__] += 1 for k,v in type_counter.items(): print k,v print '====== end session ==============' post( dump_session_state ) for o in gc.get_objects(): if isinstance(o, CollectionProxy): print o for r in gc.get_referrers(o): print ' ', type(r).__name__ for rr in gc.get_referrers(r): print ' ', type(rr).__name__
[docs] def get_default_field_attributes(self, type_, field): """Returns the default field attributes""" from camelot.core.view.field_attributes import \ _sqlalchemy_to_python_type_ return _sqlalchemy_to_python_type_[type_](field)
[docs] def backup(self, main_window): from camelot.view.wizard.backup import BackupWizard wizard = BackupWizard(self.backup_mechanism, main_window) wizard.exec_()
[docs] def restore(self, main_window): from camelot.view.wizard.backup import RestoreWizard wizard = RestoreWizard(self.backup_mechanism, main_window) wizard.exec_()

Comments
blog comments powered by Disqus