mailmanclient.restbase.base.RESTBase

class documentation

class RESTBase: (source)

Known subclasses: mailmanclient.restbase.base.RESTDict, mailmanclient.restbase.base.RESTList, mailmanclient.restbase.base.RESTObject

View In Hierarchy

Base class for data coming from the REST API.

Subclasses can (and sometimes must) define some attributes to handle a particular entity.

Method	`__init__`	No summary
Method	`__repr__`	Undocumented
Method	`save`	Undocumented
Property	`rest_data`	Get data from API and cache it (only once per instance).
Method	`_get`	Undocumented
Method	`_reset_cache`	Undocumented
Method	`_set`	Undocumented
Class Variable	`_autosave`	automatically send a `PATCH` request to the API when a value is changed. Otherwise, the `save()` method must be called.
Class Variable	`_properties`	the list of expected entity properties. This is required for API elements that behave like an object, with REST data accessed through attributes. If this value is None, the REST data is used to list available properties.
Class Variable	`_read_only_properties`	list of properties that cannot be written to (defaults to `self_link` only).
Class Variable	`_writable_properties`	list of properties that can be written to using a `PATCH` request. If this value is `None`, all properties are writable.
Instance Variable	`_changed_rest_data`	Undocumented
Instance Variable	`_connection`	Undocumented
Instance Variable	`_rest_data`	Undocumented
Instance Variable	`_url`	Undocumented

def __init__(self, connection, url, data=None): (source) ¶

overridden in mailmanclient.restobjects.address.Addresses, mailmanclient.restobjects.archivers.ListArchivers, mailmanclient.restobjects.ban.Bans, mailmanclient.restobjects.configuration.Configuration, mailmanclient.restobjects.header_match.HeaderMatches, mailmanclient.restobjects.mailinglist.MailingList, mailmanclient.restobjects.templates.TemplateList, mailmanclient.restobjects.user.User

Parameters
connection:`Connection.`	An API connection object.
url:`str.`	The url of the API endpoint.
data:`dict.`	The initial data to use.

def __repr__(self): (source) ¶

overridden in mailmanclient.restbase.base.RESTDict, mailmanclient.restbase.base.RESTList, mailmanclient.restobjects.address.Address, mailmanclient.restobjects.ban.BannedAddress, mailmanclient.restobjects.domain.Domain, mailmanclient.restobjects.header_match.HeaderMatch, mailmanclient.restobjects.held_message.HeldMessage, mailmanclient.restobjects.mailinglist.MailingList, mailmanclient.restobjects.member.Member, mailmanclient.restobjects.queue.Queue, mailmanclient.restobjects.templates.Template, mailmanclient.restobjects.user.User

Undocumented

def save(self): (source) ¶

Undocumented

@property
rest_data = (source) ¶

overridden in mailmanclient.restbase.base.RESTList

Get data from API and cache it (only once per instance).

def _get(self, key): (source) ¶

Undocumented

def _reset_cache(self): (source) ¶

Undocumented

def _set(self, key, value): (source) ¶

Undocumented

_autosave: bool = (source) ¶

overridden in mailmanclient.restbase.base.RESTDict

automatically send a PATCH request to the API when a value is changed. Otherwise, the save() method must be called.

_properties = (source) ¶

overridden in mailmanclient.restobjects.address.Address, mailmanclient.restobjects.ban.BannedAddress, mailmanclient.restobjects.domain.Domain, mailmanclient.restobjects.header_match.HeaderMatch, mailmanclient.restobjects.held_message.HeldMessage, mailmanclient.restobjects.mailinglist.MailingList, mailmanclient.restobjects.member.Member, mailmanclient.restobjects.preferences.Preferences, mailmanclient.restobjects.queue.Queue, mailmanclient.restobjects.templates.Template, mailmanclient.restobjects.user.User

the list of expected entity properties. This is required for API elements that behave like an object, with REST data accessed through attributes. If this value is None, the REST data is used to list available properties.

_read_only_properties: list[str] = (source) ¶

overridden in mailmanclient.restobjects.settings.Settings, mailmanclient.restobjects.styles.Styles

list of properties that cannot be written to (defaults to self_link only).

_writable_properties = (source) ¶

overridden in mailmanclient.restobjects.ban.BannedAddress, mailmanclient.restobjects.configuration.Configuration, mailmanclient.restobjects.header_match.HeaderMatch, mailmanclient.restobjects.member.Member, mailmanclient.restobjects.templates.Template, mailmanclient.restobjects.user.User

list of properties that can be written to using a PATCH request. If this value is None, all properties are writable.

_changed_rest_data: dict = (source) ¶

Undocumented

_connection = (source) ¶

Undocumented

_rest_data = (source) ¶

Undocumented

_url = (source) ¶

Undocumented