Skip to main content

Manager is the Components Manager package of Umbra, sIBL_GUI and sIBL_Reporter.

Project description

https://secure.travis-ci.org/KelSolaar/Manager.png?branch=master

Introduction

Manager is the Components Manager package of Umbra, sIBL_GUI and sIBL_Reporter. Components are simple python packages extending capabilities of their host application.

Installation

The following dependencies are needed:

To install Manager from the Python Package Index you can issue this command in a shell:

pip install Manager

or this alternative command:

easy_install Manager

Alternatively, if you want to directly install from Github source repository:

git clone git://github.com/KelSolaar/Manager.git
cd Manager
python setup.py install

If you want to build the documentation you will also need:

Usage

Please refer to Manager - Api for precise usage examples.

A Component package contains at least a resource .rc description file and a main module:

testsComponentA
├── __init__.py
├── testsComponentA.py
└── testsComponentA.rc

The description file is a configuration style file with a structure similar to what you would find in Microsoft Windows INI files:

[Component]
Name = core.testsComponentA
Title = Tests Component A
Module = testsComponentA
Object = TestsComponentA
Version = 1.0

[Informations]
Author = Thomas Mansencal
Email = thomas.mansencal@gmail.com
Url = http://www.hdrlabs.com/
Description = Core tests Component A.

Given the following directories structure:

core
├── __init__.py
├── testsComponentA
│   ├── __init__.py
│   ├── testsComponentA.py
│   └── testsComponentA.rc
└── testsComponentB
        ├── __init__.py
        ├── testsComponentB.py
        └── testsComponentB.rc

Instantiating the Components Manager is done the following way:

>>> manager = Manager(("./manager/tests/testsManager/resources/components/core",))
>>> manager.registerComponents()
True
>>> manager.listComponents()
['core.testsComponentA', 'core.testsComponentB']
>>> manager.instantiateComponents()
True
>>> manager.getInterface("core.testsComponentA")
<testsComponentA.TestsComponentA object at 0x11dd990>

manager.componentsManager.Manager.getInterface(name) method returns the interface of given Component, in the previous example it’s the object declared in the description file by this statement: Object = TestsComponentA.

Three base Components are provided by default:

  • manager.component.Component
  • manager.qobjectComponent.QObjectComponent
  • manager.qwidgetComponent.QWidgetComponent

When inheriting from those Components, one have to reimplement the following methods for all the Components types:

  • activate
  • deactivate

activated attribute has to be set accordingly in the methods implementation.

When implementing a manager.qwidgetComponent.Component or manager.qobjectComponent.QObjectComponent, the following methods are also needed:

  • initialize
  • uninitialize

initialized attribute has to be set accordingly in the methods implementation.

Or alternatively, those methods when implementing a manager.qwidgetComponent.QWidgetComponent:

  • initializeUi
  • uninitializeUi

initializedUi attribute has to be set accordingly in the methods implementation.

Reference Component implementation example class:

class TestsComponentA(Component):

        def __init__(self, name=None):
                Component.__init__(self, name=name)

                self.deactivatable = True

        def activate(self):
                print("> Activating '{0}' Component.".format(self.__class__.__name__))

                self.activated = True
                return True

        def deactivate(self):
                print("> Deactivating '{0}' Component.".format(self.__class__.__name__))

                self.activated = False
                return True

        def initialize(self):
                print("> Initializing '{0}' Component.".format(self.__class__.__name__))

                self.initialized = True
                return True

        def uninitialize(self):
                print("> Uninitializing '{0}' Component.".format(self.__class__.__name__))

                self.initialized = False
                return True

About

Manager by Thomas Mansencal – 2008 - 2013
Copyright© 2008 - 2013 – Thomas Mansencal – thomas.mansencal@gmail.com
This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/

Project details


Release history Release notifications

History Node

2.0.5

This version
History Node

2.0.4

History Node

2.0.3

History Node

2.0.2

History Node

2.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Manager-2.0.4.tar.gz (539.6 kB) Copy SHA256 hash SHA256 Source None Apr 21, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page