Energenie EG-PMS Manuel d'utilisateur télécharger pdf (Page 19)

pickups Documentation, Release 0.7.0

turn_on_running()

Turn on a thing whenever a build is running. One could turn off all other lamps while a build is running.

turn_off_running()

Turn off a thing whenever no build is currently running. After turning off the indicator for running builds

one could turn on either turn_on_success() or turn_on_failure().

get_status()

Return the overall status of a extreme feedback device.

Module contents This module contains all necessary functionality to implement new feedback device classes

Submodules

basepickup

class pickups.basepickup.BasePickup(conﬁgﬁle)

Bases: object

BasePickup is an abstract metaclass deﬁning behaviours for specialized pickup classes. A child class inherits

from BasePickup and implements the deﬁned methods to work as an interface between a buildserver (Bamboo,

Jenkins, ...) and the pickups package.

Child classes should delegate the reading in of a conﬁg ﬁle to BasePickup using super. A conﬁg ﬁle is mandatory

and usually contains at least an IP address pointing to the buildserver.

Parameters conﬁgﬁle – A conﬁg ﬁle in the stile of key = value.

Raises IOError if no conﬁg ﬁle is given.

cleanup()

Cleanup method, used by :func:pickups.helpers.register. Usually one would turn off feedback devices etc.

here in case a interruption occurs.

update_data()

Receives updated data from the buildserver. The received data should contain information on build-

statuses. Often one can use a REST-API, provided by the buildserver to receive this data.

update_status()

Updates feedback devices according to data received from the buildserver. Common implementations

dictate to use three devices (for example coloured lamps). Common logic is to update the devices as

follows:

•Build is running: yellow light is ﬂashing.

•Build is successful: green light is illuminated.

•Build is not successful: red light is illuminated.

helpers

pickups.helpers.register(cls, conﬁgﬁle, sign=15)

SIGTERM or other. Possible Signals are deﬁned in signal as constants.

Parameters

• cls – The class to register.

3.4. Reference 15

1 2 ... 14 15 16 17 18 19 20 21 22 23 24 ... 29 30

Pas de commentaire

Energenie EG-PMS Manuel d'utilisateur Page 19