org.directives

Attributes

FormFactory

Classes

SettingViewMeta
SettingViewMetaAction	A configuration action.
SettingViewAction	A composite configuration action.
HomepageWidgetAction	Register a cronjob.
ExportAction	Register an export.
UserlinkAction	Registers a user link group.
DirectorySearchWidgetAction	Registers a directory search widget.
EventSearchWidgetAction	Registers a text search widget.
Boardlet	Registers a boardlet on the Dashboard.

Module Contents

type org.directives.FormFactory = type[Form] | Callable[[Any, RequestT], type[Form]]

class org.directives.SettingViewMeta

model: type

name: str

form: FormFactory[Any]

setting: str

icon: str

order: int

category: str | None

class org.directives.SettingViewMetaAction(model: type, name: str, form: FormFactory[Any], setting: str | None, icon: str | None, order: int, category: str | None)

Bases: dectate.Action

A configuration action.

Base class of configuration actions.

A configuration action is performed for an object (typically a function or a class object) and affects one or more configuration objects.

Actions can conflict with each other based on their identifier and discriminators. Actions can override each other based on their identifier. Actions can only be in conflict with actions of the same action class or actions with the same action_group.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

model

name

form

setting

icon

order

category

identifier(setting_view_registry: SettingViewRegistry) → tuple[type, str]

perform(obj: collections.abc.Callable[..., Any], setting_view_registry: SettingViewRegistry) → None

class org.directives.SettingViewAction(model: type, name: str, form: FormFactory[RequestT], setting: str | None = None, icon: str | None = None, order: int = 0, category: str | None = None, listed: bool = True, render: collections.abc.Callable[[Any, RequestT], webob.Response] | None = None, template: str | None = None, load: collections.abc.Callable[[RequestT], Any] | None = None, permission: object | None = None, internal: bool = False, pass_model: bool = False, **predicates: Any)

Bases: dectate.Composite

A composite configuration action.

Base class of composite actions.

Composite actions are very simple: implement the action method and return a iterable of actions in there.

query_classes

A list of actual action classes that this composite can generate.

This is to allow the querying of composites. If the list if empty (the default) the query system refuses to query the composite. Note that if actions of the same action class can also be generated in another way they are in the same query result.

model

name

form

setting = None

icon = None

order = 0

category = None

listed = True

render = None

template = None

load = None

permission = None

internal = False

pass_model = False

predicates

actions[RequestT: onegov.org.request.OrgRequest](obj: collections.abc.Callable[[Any, RequestT, Any], Any]) → collections.abc.Iterator[tuple[dectate.Action, collections.abc.Callable[[Any, RequestT, Any], Any]]]

Specify a iterable of actions to perform for obj.

The iteratable should yield action, obj tuples, where action is an instance of class Action or Composite and obj is the object to perform the action with.

Needs to be implemented by the Composite subclass.

Parameters:

obj – the obj that the composite action was performed on.

Returns:

iterable of action, obj tuples.

class org.directives.HomepageWidgetAction(tag: str)

Bases: dectate.Action

Register a cronjob.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

tag

identifier(homepage_widget_registry: dict[str, RegisteredHomepageWidget]) → str

perform(func: collections.abc.Callable[[], HomepageWidget], homepage_widget_registry: dict[str, RegisteredHomepageWidget]) → None

class org.directives.ExportAction(id: str, **kwargs: Any)

Bases: dectate.Action

Register an export.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

id

kwargs

identifier(export_registry: dict[str, Any]) → str

perform(cls: collections.abc.Callable[..., Any], export_registry: dict[str, Any]) → None

class org.directives.UserlinkAction

Bases: dectate.Action

Registers a user link group.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

counter: ClassVar

name

identifier(linkgroup_registry: list[LinkGroupFactory]) → int

perform(func: LinkGroupFactory, linkgroup_registry: list[LinkGroupFactory]) → None

class org.directives.DirectorySearchWidgetAction(name: str)

Bases: dectate.Action

Registers a directory search widget.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

name

identifier(directory_search_widget_registry: DirectorySearchWidgetRegistry) → str

perform(cls: type[DirectorySearchWidget[Any]], directory_search_widget_registry: DirectorySearchWidgetRegistry) → None

class org.directives.EventSearchWidgetAction(name: str)

Bases: dectate.Action

Registers a text search widget.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

name

identifier(event_search_widget_registry: EventSearchWidgetRegistry) → str

perform(cls: type[EventSearchWidget], event_search_widget_registry: EventSearchWidgetRegistry) → None

class org.directives.Boardlet(name: str, order: tuple[int, int], icon: str = '', kind: Literal['user', 'citizen'] = 'user')

Bases: dectate.Action

Registers a boardlet on the Dashboard.

config

Describe configuration.

A dict mapping configuration names to factory functions. The resulting configuration objects are passed into Action.identifier(), Action.discriminators(), Action.perform(), and Action.before() and Action.after().

After commit completes, the configured objects are found as attributes on App.config.

name

boardlet_order

icon = ''

kind = 'user'

identifier(boardlets_registry: dict[BoardletKind, dict[str, BoardletConfig]]) → str

perform(func: type[onegov.org.models.Boardlet], boardlets_registry: dict[BoardletKind, dict[str, BoardletConfig]]) → None