When OpenTeacher is run, this module sets a profile, controls enabling of all modules in the current profile, and sends an event (startRunning) when that's done so other modules can take over control at the right time.
In other words, this module controls the complete execution of OpenTeacher from the moment on the moduleManager is initialized.
| Type: | execute |
| Uses (at least one of): |
SettingsModule >
TranslatorModule > |
| Requires (at least one of): |
EventModule >
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2011-2013, Marten de Vries
#
# This file is part of OpenTeacher.
#
# OpenTeacher is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# OpenTeacher is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with OpenTeacher. If not, see <http://www.gnu.org/licenses/>.
import argparse
import sys
import logging
DEFAULT_PROFILE = "all"
class ExecuteModule:
"""When OpenTeacher is run, this module sets a profile, controls
enabling of all modules in the current profile, and sends an
event (``startRunning``) when that's done so other modules can
take over control at the right time.
In other words, this module controls the complete execution of
OpenTeacher from the moment on the moduleManager is initialized.
"""
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
self._mm = moduleManager
self.type = "execute"
self.requires = (
self._mm.mods(type="event"),
)
self.uses = (
self._mm.mods(type="settings"),
self._mm.mods(type="translator"),
)
self.filesWithTranslations = ("execute.py",)
self.active = True
def _getMod(self, *args, **kwargs):
mods = set(self._mm.mods(*args, **kwargs))
if len(mods) != 1:
raise ValueError("There has to be exactly one module installed with signature %s." % ((args, kwargs),))
return mods.pop()
@property
def _profileIfUnspecified(self):
value = self._profileSetting["value"]
#convert deprecated profiles to their aliases that exist today.
return {
"wordsonly": "words-only"
}.get(value, value)
def execute(self):
#enable printing a stacktrace in the case of a segfault if
#supported.
try:
import faulthandler
faulthandler.enable()
except (ImportError, AttributeError):
pass
#load the settings module and its dependencies (currently one)
try:
self._getMod(type="dataStore")
settings = self._getMod(type="settings")
except ValueError:
self._profileSetting = {"value": DEFAULT_PROFILE}
else:
settings.initialize()
self._profileSetting = settings.registerSetting(**{
"internal_name": "org.openteacher.execute.startup_profile",
"type": "profile",
"defaultValue": DEFAULT_PROFILE,
"callback": {
"args": (),
"kwargs": {"type": "execute"},
"method": "_settingChanged",
}
})
parser = argparse.ArgumentParser()
parser.add_argument("-p", "--profile", **{
"nargs": "?",
"default": self._profileIfUnspecified,
"type": str,
"help": "Start OpenTeacher with the PROFILE profile. Don't know which profiles are included? I'll give away one: 'help' ;).",
})
parser.add_argument("-d", "--debug", **{
"action": "store_true",
"help": "Enable debugging messages. Useful for developers and bug reporters only."
})
args, otherArgs = parser.parse_known_args(sys.argv)
#remove the args we parsed from sys.argv
del sys.argv[0:]
sys.argv.extend(otherArgs)
#setup logging
level = logging.DEBUG if args.debug else logging.ERROR
logging.basicConfig(level=level)
logging.captureWarnings(True)
#setup the modules module
self._modules = self._getMod(type="modules")
#build events used by other mods
event = self._modules.default(type="event")
self.startRunning = event.createEvent()
#enable all other mods
self._modules.profile = args.profile
self._modules.updateToProfile()
#setup translation
try:
translator = self._modules.default("active", type="translator")
except IndexError:
pass
else:
translator.languageChanged.handle(self._retranslate)
self._retranslate()
self.startRunning.send()
def _retranslate(self):
try:
translator = self._modules.default("active", type="translator")
except IndexError:
_, ngettext = str, lambda a, b, n: a if n == 1 else b
else:
_, ngettext = translator.gettextFunctions(
self._mm.resourcePath("translations")
)
self._profileSetting.update({
"name": _("Profile"),
"category": _("General"),
"subcategory": _("Profile"),
})
def _settingChanged(self):
try:
dialogShower = self._modules.default("active", type="dialogShower")
settingsDialog = self._modules.default("active", type="settingsDialog")
dialogShower.showMessage.send(settingsDialog.tab, "Restart OpenTeacher for this setting to take effect.")
except IndexError:
#no guarantees can be made for these modules...
pass
def init(moduleManager):
return ExecuteModule(moduleManager)
|