class ApplicationContext:
"""
The main point of contact between your application and fbs. For information
on how to use it, please see the Manual:
https://build-system.fman.io/manual/#your-python-code
"""
def __init__(self):
self._resource_locator = self._create_resource_locator()
# Many Qt classes require a QApplication to have been instantiated.
# Do this here, before everything else, to achieve this:
self.app
# We don't build as a console app on Windows, so no point in installing
# the SIGINT handler:
if not is_windows():
self._signal_wakeup_handler = SignalWakeupHandler(self.app)
self._signal_wakeup_handler.install()
if self.app_icon:
self.app.setWindowIcon(self.app_icon)
def _create_resource_locator(self):
if is_frozen():
executable_dir = dirname(sys.executable)
if is_mac():
resources_dir = join(executable_dir, pardir, 'Resources')
else:
resources_dir = executable_dir
return _ResourceLocator([resources_dir])
else:
return _DevelopmentResourceLocator(self.__class__)
@cached_property
def app(self):
"""
The global Qt QApplication object for your app. Feel free to overwrite
this property, eg. if you wish to use your own subclass of QApplication.
An example of this is given in the Manual.
"""
return QApplication(sys.argv)
@cached_property
def app_icon(self):
"""
The app icon. Not available on Mac because app icons are handled by the
OS there.
"""
if not is_mac():
return QIcon(self.get_resource('Icon.ico'))
def get_resource(self, *rel_path):
"""
Return the absolute path to the data file with the given name or
(relative) path. When running from source, searches src/main/resources.
Otherwise, searches your app's installation directory. If no file with
the given name or path exists, a FileNotFoundError is raised.
"""
return self._resource_locator.locate(*rel_path)
def run(self):
raise NotImplementedError()
def __init__(self):
self._resource_locator = self._create_resource_locator()
# Many Qt classes require a QApplication to have been instantiated.
# Do this here, before everything else, to achieve this:
self.app
# We don't build as a console app on Windows, so no point in installing
# the SIGINT handler:
if not is_windows():
self._signal_wakeup_handler = SignalWakeupHandler(self.app)
self._signal_wakeup_handler.install()
if self.app_icon:
self.app.setWindowIcon(self.app_icon)
def __init__(self):
if self.excepthook:
self.excepthook.install()
# Many Qt classes require a QApplication to have been instantiated.
# Do this here, before everything else, to achieve this:
self.app
# We don't build as a console app on Windows, so no point in installing
# the SIGINT handler:
if not is_windows():
self._signal_wakeup_handler = \
SignalWakeupHandler(self.app, self._qt_binding.QAbstractSocket)
self._signal_wakeup_handler.install()
if self.app_icon:
self.app.setWindowIcon(self.app_icon)
class ApplicationContext:
def __init__(self):
self._resource_locator = self._create_resource_locator()
# Many Qt classes require a QApplication to have been instantiated.
# Do this here, before everything else, to achieve this:
self.app
# We don't build as a console app on Windows, so no point in installing
# the SIGINT handler:
if not is_windows():
self._signal_wakeup_handler = SignalWakeupHandler(self.app)
self._signal_wakeup_handler.install()
if self.app_icon:
self.app.setWindowIcon(self.app_icon)
def _create_resource_locator(self):
if is_frozen():
executable_dir = dirname(sys.executable)
if is_mac():
resources_dir = join(executable_dir, pardir, 'Resources')
else:
resources_dir = executable_dir
return _ResourceLocator([resources_dir])
else:
return _DevelopmentResourceLocator(self.__class__)
@cached_property
def app(self):
return QApplication(sys.argv)
@cached_property
def app_icon(self):
if not is_mac():
return QIcon(self.get_resource('Icon.ico'))
def get_resource(self, *rel_path):
return self._resource_locator.locate(*rel_path)
def run(self):
raise NotImplementedError()
class ApplicationContext:
"""
The main point of contact between your application and fbs. For information
on how to use it, please see the Manual:
https://build-system.fman.io/manual/#your-python-code
"""
def __init__(self):
if self.excepthook:
self.excepthook.install()
# Many Qt classes require a QApplication to have been instantiated.
# Do this here, before everything else, to achieve this:
self.app
# We don't build as a console app on Windows, so no point in installing
# the SIGINT handler:
if not is_windows():
self._signal_wakeup_handler = SignalWakeupHandler(self.app)
self._signal_wakeup_handler.install()
if self.app_icon:
self.app.setWindowIcon(self.app_icon)
def run(self):
"""
You should overwrite this method with the steps for starting your app.
See eg. fbs's tutorial.
"""
raise NotImplementedError()
@cached_property
def app(self):
"""
The global Qt QApplication object for your app. Feel free to overwrite
this property, eg. if you wish to use your own subclass of QApplication.
An example of this is given in the Manual.
"""
result = QApplication([])
result.setApplicationName(self.build_settings['app_name'])
result.setApplicationVersion(self.build_settings['version'])
return result
@cached_property
def build_settings(self):
"""
This dictionary contains the values of the settings listed in setting
"public_settings". Eg. `self.build_settings['version']`.
"""
if is_frozen():
return _frozen.load_build_settings()
return _source.load_build_settings(self._project_dir)
def get_resource(self, *rel_path):
"""
Return the absolute path to the data file with the given name or
(relative) path. When running from source, searches src/main/resources.
Otherwise, searches your app's installation directory. If no file with
the given name or path exists, a FileNotFoundError is raised.
"""
return self._resource_locator.locate(*rel_path)
@cached_property
def exception_handlers(self):
"""
Return a list of exception handlers that should be invoked when an error
occurs. See the documentation of module `fbs_runtime.excepthook` for
more information.
"""
return [StderrExceptionHandler()]
@cached_property
def licensing(self):
"""
This field helps you implement a license key functionality for your
application. For more information, see:
https://build-system.fman.io/manual#license-keys
"""
# fbs's licensing implementation incurs a dependency on Python library
# `rsa`. We don't want to force all users to install this library.
# So we import fbs_runtime.licensing here, instead of at the top of this
# file. This lets people who don't use licensing avoid the dependency.
from fbs_runtime.licensing import _Licensing
return _Licensing(self.build_settings['licensing_pubkey'])
@cached_property
def app_icon(self):
"""
The app icon. Not available on Mac because app icons are handled by the
OS there.
"""
if not is_mac():
return QIcon(self.get_resource('Icon.ico'))
@cached_property
def excepthook(self):
"""
Overwrite this method to use a custom excepthook. It should be an object
with a .install() method, or `None` if you want to completely disable
fbs's excepthook implementation.
"""
return _Excepthook(self.exception_handlers)
@cached_property
def _resource_locator(self):
if is_frozen():
resource_dirs = _frozen.get_resource_dirs()
else:
resource_dirs = _source.get_resource_dirs(self._project_dir)
return ResourceLocator(resource_dirs)
@cached_property
def _project_dir(self):
assert not is_frozen(), 'Only available when running from source'
return _source.get_project_dir()