coarnotify.patterns.announce_review

Pattern to represent the Announce Review notification https://coar-notify.net/specification/1.0.0/announce-review/

Classes

AnnounceReview	Class to represent Announce Review pattern
AnnounceReviewContext	Custom Context for Announce Review, specifically to return custom
AnnounceReviewItem	Custom AnnounceReviewItem which provides additional validation over the basic NotifyItem
AnnounceReviewObject	Custom Announce Review Object to apply custom validation for this pattern

Module Contents

class coarnotify.patterns.announce_review.AnnounceReview(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyPattern

Class to represent Announce Review pattern

validate() → bool

Extends the base validation to make context required

Returns:

True if valid, otherwise raises coarnotify.exceptions.ValidationError

TYPE

Announce Review type, including Acitivity Streams Announce and Notify Review Action

property context: AnnounceReviewContext | None

Custom getter to retrieve AnnounceReview Context

Returns:

AnnounceReviewContext

property object: AnnounceReviewObject | None

Custom getter to retrieve Announce Review object

Returns:

Announce Review Object

class coarnotify.patterns.announce_review.AnnounceReviewContext(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyObject

Custom Context for Announce Review, specifically to return custom Announce Review Item

property item: AnnounceReviewItem | None

Custom getter to retrieve AnnounceReviewItem

Returns:

AnnounceReviewItem

class coarnotify.patterns.announce_review.AnnounceReviewItem(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyItem

Custom AnnounceReviewItem which provides additional validation over the basic NotifyItem

validate() → bool

In addition to the base validator, this:

• Reintroduces type validation

• make mediaType a required field

Returns:

True if valid, else raises a ValidationError

class coarnotify.patterns.announce_review.AnnounceReviewObject(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyObject

Custom Announce Review Object to apply custom validation for this pattern

validate() → bool

In addition to the base validator this:

• Makes type required

Returns:

True if valid, else raises ValidationError