signoffs.core.urls.signoffs#

It can be very convenient for a signoff to know the endpoints to POST / DELETE their Signet. In fact, the default renderers assume a signoff knows the URLs for sign and revoke requests.

This component can be extended to provide flexible url services to Signoff instances. They are generally “injected” into the Signoff Type using a SignoffUrlsManager service descriptor

Module Contents#

Classes#

SignoffInstanceUrls

Defines the urls for Signing and Revoking a Signoff instance

SignoffUrlsManager

A descriptor class that “injects” a SignoffInstanceUrls instance into a Signoff instance.

API#

class signoffs.core.urls.signoffs.SignoffInstanceUrls(signoff_instance, save_url_name=None, revoke_url_name=None)[source]#

Defines the urls for Signing and Revoking a Signoff instance

Initialization

Override default actions, or leave parameter None to use class default

save_url_name: str = <Multiline-String>#
revoke_url_name: str = <Multiline-String>#
get_save_url(args=None, kwargs=None)[source]#

Return the URL for requests to save the signoff

get_revoke_url(args=None, kwargs=None)[source]#

Return the URL for requests to revoke this signoff

class signoffs.core.urls.signoffs.SignoffUrlsManager[source]#

Bases: service(SignoffInstanceUrls)

A descriptor class that “injects” a SignoffInstanceUrls instance into a Signoff instance.

To inject custom URL services:

  • provide a custom service_class: urls=SignoffUrlsManager(service_class=MyInstanceUrls)

  • OR specialize class attributes: SignoffUrlsManager = utils.service(SignoffInstanceUrls, revoke_url_name="my:app:revoke_view")

  • OR both… SignoffUrlsManager = utils.service(MyInstanceUrls)