Skip to main content

A Plone addon providing a hook for executing code when a generic setup profile is installed.

Project description

ftw.profilehook

ftw.profilehook provides a hook for executing custom code after a generic setup profile is installed.

Motivation

We often use import steps for executing code after import a generic setup profile. Registering a lot of setup handlers is bad because it extends the import duration of every profile and the amount of import steps are limited in generic setup, causing bad effects when exceeded. Import steps are meant to import things from any profile, not for executing code after importing a specific profile. Because of these reasons ftw.profilehook exists and provides an easy method to solve this issue.

Usage

Add ftw.profilehook as dependency in your setup.py:

setup(...
      install_requires=['ftw.profilehook'])

Register your hook function in ZCML (configure.zcml):

<configure
    xmlns="http://namespaces.zope.org/zope"
    xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
    xmlns:i18n="http://namespaces.zope.org/i18n"
    xmlns:profilehook="http://namespaces.zope.org/profilehook"
    i18n_domain="my.package">

  <include package="ftw.profilehook" />

  <genericsetup:registerProfile
      name="default"
      title="my.package"
      directory="profiles/default"
      provides="Products.GenericSetup.interfaces.EXTENSION"
      />

  <profilehook:hook
      profile="my.package:default"
      handler=".hooks.default_profile_installed"
      />

</configure>

Do things in your hook (hooks.py):

from my.package.interfaces import IMyRoot
from zope.component import alsoProvides


def default_profile_installed(site):
  mark_site_as_my_root(site)


def mark_site_as_my_root(site)
  if not IMyRoot.providedBy(site):
    alsoProvides(site, IMyRoot)

After your profile (my.package:default) is installed, your hook is executed.

Before-Import Hook

The standard hook (profilehook:hook) is executed after importing the profile. By using the profilehook:before_import_hook directive, you can register hooks which are executed before importing the profile.

<profilehook:before_import_hook
    profile="my.package:default"
    handler=".hooks.before_installing_default_profile"
    />

Changelog

1.2.1 (2016-05-12)

  • Fix compatibility with ftw.inflator. [jone]

1.2.0 (2016-05-11)

  • Support before-import hooks. [jone]

1.0.0 (2014-08-15)

  • Initial implementation. [jone]

Project details


Release history Release notifications

This version
History Node

1.2.1

History Node

1.2.0

History Node

1.0.0

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
ftw.profilehook-1.2.1.tar.gz (12.5 kB) Copy SHA256 hash SHA256 Source None May 12, 2016

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