puremvc.interfaces package

Submodules

puremvc.interfaces.ICommand module

class puremvc.interfaces.ICommand.ICommand

Bases: INotifier

The interface definition for a PureMVC Command

puremvc.interfaces.IController module

class puremvc.interfaces.IController.IController

Bases: ABC

The interface definition for a PureMVC Controller.

In PureMVC, an IController implementor follows the ‘Command and Controller’ strategy, and assumes these responsibilities:

Remembering which ICommand`s are intended to handle which `INotifications.

Registering itself as an IObserver with the View for each INotification that it has an ICommand mapping for.

Creating a new instance of the proper ICommand to handle a given INotification when notified by the View.

Calling the ICommand’s execute method, passing in the INotification.

puremvc.interfaces.IFacade module

class puremvc.interfaces.IFacade.IFacade

Bases: INotifier, ABC

The interface definition for a PureMVC Facade.

The Facade Pattern suggests providing a single class to act as a central point of communication for a subsystem.

In PureMVC, the Facade acts as an interface between the core MVC actors (Model, View, Controller) and the rest of your application.

puremvc.interfaces.IModel puremvc.interfaces.IView puremvc.interfaces.IController puremvc.interfaces.ICommand puremvc.interfaces.INotification

abstract has_command(notification_name: str) → bool

Check if a Command is registered for a given Notification.

Parameters:: notification_name (str) – The name of the notification to check.
Returns:: True if a command exists for the given notification_name, False otherwise.

abstract has_mediator(mediator_name: str) → bool

Check if a Mediator is registered or not

Parameters:: mediator_name (str) – The name of the mediator to check for.
Returns:: True if the mediator exists, False otherwise.

abstract has_proxy(proxy_name: str) → bool

Check if a Proxy is registered

Parameters:: proxy_name (str) – The name of the proxy to check.
Returns:: True if the proxy is currently registered, False otherwise.
Return type:: bool

abstract notify_observers(notification: INotification)

Notify Observer

Parameters:: notification (INotification) – The INotification to have the View notify Observers of.
Returns:: None

abstract register_command(notification_name: str, factory: Callable[[], ICommand])

Register an ICommand with the Controller.

Parameters:

notification_name (str) – The name of the INotification to associate the ICommand with.
factory (Callable[[], ICommand]) – A callable factory function that creates an instance of ICommand.

Returns:

None

abstract register_mediator(mediator: IMediator)

Register an IMediator instance with the View.

Parameters:: mediator (IMediator) – A reference to the IMediator instance
Returns:: None

abstract register_proxy(proxy: IProxy)

Register a Proxy with the Model by name.

Parameters:: proxy (IProxy) – The IProxy to be registered with the Model.
Returns:: None

abstract remove_command(notification_name: str)

Remove a previously registered ICommand to INotification mapping from the Controller.

Parameters:: notification_name (str) – The name of the INotification to remove the ICommand mapping for
Returns:: None

abstract remove_mediator(mediator_name: str) → IMediator

Remove a IMediator instance from the View.

Parameters:: mediator_name (str) – name of the IMediator instance to be removed.
Returns:: The IMediator instance previously registered with the given mediator_name.

abstract remove_proxy(proxy_name: str) → IProxy

Remove an IProxy instance from the Model by name.

Parameters:: proxy_name (str) – The IProxy to remove from the Model.
Returns:: the IProxy that was removed from the Model
Return type:: IProxy

abstract retrieve_mediator(mediator_name: str) → IMediator

Retrieve an IMediator instance from the View.

Parameters:: mediator_name (str) – The name of the IMediator instance to retrieve
Returns:: The mediator object found, of type IMediator.

abstract retrieve_proxy(proxy_name: str) → IProxy

Retrieve a IProxy from the Model by name.

Parameters:: proxy_name (str) – The name of the IProxy instance to be retrieved.
Returns:: the IProxy previously registered by proxyName with the Model.

puremvc.interfaces.IMediator module

class puremvc.interfaces.IMediator.IMediator

Bases: INotifier

The base interface for all Mediator classes.

In PureMVC, IMediator implementors assume these responsibilities:

Implement a common method which returns a list of all INotification the IMediator has interest in implementing a notification callback method. Implement methods that are called when the IMediator is registered or removed from the View.

Additionally, IMediator typically:

Act as an intermediary between one or more view components such as text boxes or list controls, maintaining references and coordinating their behavior.

In Flash-based apps, this is often the place where event listeners are added to view components, and their handlers implemented.

Respond to and generate INotifications, interacting with of the rest of the PureMVC app.

When an IMediator is registered with the IView, the IView will call the IMediator’s list_notification_interests method. The IMediator will return an Array of INotification names which it wishes to be notified about.

The IView will then create an Observer object encapsulating that IMediator’s (handle_notification) method and register it as an Observer for each INotification name returned by list_notification_interests.

puremvc.interfaces.IModel module

class puremvc.interfaces.IModel.IModel

Bases: ABC

The interface definition for a PureMVC Model.

In PureMVC, IModel implementors provide access to IProxy objects by named look up.

An IModel assumes these responsibilities:

Maintain a cache of IProxy instances Provide methods for registering, retrieving, and removing IProxy instances

abstract has_proxy(proxy_name: str) → bool

Check if a proxy with the given name is registered.

Parameters:: proxy_name (str) – The name of the proxy to check.
Returns:: True if the proxy is registered, False otherwise.
Return type:: bool

abstract register_proxy(proxy: IProxy)

Register an IProxy instance with the Model.

Parameters:: proxy (IProxy) – An object reference to be held by the Model.

abstract remove_proxy(proxy_name: str) → IProxy

Remove an IProxy instance from the Model.

Parameters:: proxy_name (str) – The name of the proxy to remove.
Returns:: The IProxy instance that was removed from the Model.
Return type:: IProxy

abstract retrieve_proxy(proxy_name: str) → IProxy

Retrieve an IProxy instance from the Model.

Parameters:: proxy_name (str) – The name of the proxy to retrieve.
Returns:: The IProxy instance previously registered with the given proxy_name.
Return type:: IProxy

puremvc.interfaces.INotification module

class puremvc.interfaces.INotification.INotification

Bases: ABC

The interface definition for a PureMVC Notification.

PureMVC does not rely upon underlying event models such as the one provided with Flash, and ActionScript 3 does not have an inherent event model.

The Observer Pattern as implemented within PureMVC exists to support event-driven communication between the application and the actors of the MVC triad.

Notifications are not meant to be a replacement for Events in Flex/Flash/AIR. Generally, IMediator implementors place event listeners on their view components, which they then handle in the usual way. This may lead to the broadcast of Notification to trigger ICommand or to communicate with other IMediator, IProxy and ICommand instances communicate with each other and IMediator by broadcasting INotification.

A key difference between Flash Event and PureMVC Notification is that Event follows the ‘Chain of Responsibility’ pattern, ‘bubbling’ up the display hierarchy until some parent component handles the Event, while PureMVC Notification follows a ‘Publish/Subscribe’ pattern. PureMVC classes need not be related to each other in a parent/child relationship to communicate with one another using Notification.

puremvc.interfaces.INotifier module

class puremvc.interfaces.INotifier.INotifier

Bases: ABC

The interface definition for a PureMVC Notifier.

MacroCommand, Command, Mediator and Proxy all have a need to send Notifications.

The INotifier interface provides a common method called send_notification that relieves implementation code of the necessity to actually construct Notifications.

The Notifier class, which all the above-mentioned classes extend, also provides an initialized reference to the Facade Singleton, which is required for the convenience method for sending Notifications, but also eases implementation as these classes have frequent Facade interactions and usually require access to the facade anyway.

puremvc.interfaces.IObserver module

class puremvc.interfaces.IObserver.IObserver

Bases: ABC

The interface definition for a PureMVC Observer.

In PureMVC, IObserver implementors assume these responsibilities:

Encapsulate the notification (callback) method of the interested object.

Encapsulate the notification context of the interested object.

Provide methods for setting the interested object notification method and context.

Provide a method for notifying the interested object.

PureMVC does not rely upon underlying event models such as the one provided with Flash, and ActionScript 3 does not have an inherent event model.

The Observer Pattern as implemented within PureMVC exists to support event driven communication between the application and the actors of the MVC triad.

An Observer is an object that encapsulates information about an interested object with a notification method that should be called when an INotification is broadcast. The Observer then acts as a proxy for notifying the interested object.

Observers can receive Notification`s by having their `notify_observer method invoked, passing in an object implementing the INotification interface, such as a subclass of Notification.

puremvc.interfaces.IProxy module

class puremvc.interfaces.IProxy.IProxy

Bases: INotifier

The interface definition for a PureMVC Proxy.

In PureMVC, ‘IProxy’ implementors assume these responsibilities:</P>

Implement a common method which returns the name of the Proxy. Provide methods for setting and getting the data object.

Additionally, ‘IProxy’s typically:

Maintain references to one or more pieces of model data. Provide methods for manipulating that data. Generate ‘INotifications’ when their model data changes. Expose their name as a ‘public static const’ called ‘NAME’, if they are not instantiated multiple times. Encapsulate interaction with local or remote services used to fetch and persist model data.

abstract property data: Any

Get the data object

Returns:: The data of the method.
Return type:: Any

abstract on_register(): Called by the Model when the Proxy is registered.

abstract on_remove(): Called by the Model when the Proxy is removed.

abstract property proxy_name: str

Get the Proxy name

Returns:: The name of the proxy as a string.
Return type:: str

puremvc.interfaces.IView module

class puremvc.interfaces.IView.IView

Bases: ABC

The interface definition for a PureMVC View.

In PureMVC, IView implementors assume these responsibilities:

In PureMVC, the View class assumes these responsibilities:

Maintain a cache of IMediator instances. Provide methods for registering, retrieving, and removing IMediators. Managing the observer lists for each INotification in the application. Providing a method for attaching IObservers to an INotification’s observer list. Providing a method for broadcasting an INotification. Notifying the IObservers of a given INotification when it broadcast.

puremvc.interfaces package

Submodules

puremvc.interfaces.ICommand module

See Also

puremvc.interfaces.IController module

See Also

puremvc.interfaces.IFacade module

puremvc.interfaces.IMediator module

See Also

puremvc.interfaces.IModel module

puremvc.interfaces.INotification module

See Also

puremvc.interfaces.INotifier module

See Also

puremvc.interfaces.IObserver module

See Also

puremvc.interfaces.IProxy module

puremvc.interfaces.IView module

See Also

Module contents