# coding: utf-8
"""Mambu Centres objects.
.. autosummary::
:nosignatures:
:toctree: _autosummary
MambuCentre holds a centre.
MambuCentres holds a list of centres.
Uses mambugeturl.getcentresurl as default urlfunc
"""
from ..mambugeturl import getcentresurl
from .mambustruct import MambuStruct
from .mamburestutils import MambuStructIterator
mod_urlfunc = getcentresurl
[docs]class MambuCentre(MambuStruct):
"""A Centre from Mambu.
With the default urlfunc, entid argument must be the ID of the
centre you wish to retrieve.
"""
[docs] def __init__(self, urlfunc=mod_urlfunc, entid="", *args, **kwargs):
"""Tasks done here:
Just initializes the MambuStruct.
"""
MambuStruct.__init__(
self, urlfunc, entid, custom_field_name="customFieldValues", *args, **kwargs
)
[docs] def setBranch(self, *args, **kwargs):
"""Adds the branch for this centre to a 'branch' field.
Returns the number of requests done to Mambu.
"""
try:
self.mambubranchclass
except AttributeError:
from .mambubranch import MambuBranch
self.mambubranchclass = MambuBranch
brnch = self.mambubranchclass(entid=self["assignedBranchKey"], *args, **kwargs)
self["branch"] = brnch
return 1
[docs]class MambuCentres(MambuStruct):
"""A list of Centres from Mambu.
With the default urlfunc, entid argument must be empty at
instantiation time to retrieve all the centres according to any
other filter you send to the urlfunc.
"""
[docs] def __init__(self, urlfunc=mod_urlfunc, entid="", *args, **kwargs):
"""By default, entid argument is empty. That makes perfect
sense: you want several centres, not just one
"""
MambuStruct.__init__(self, urlfunc, entid, *args, **kwargs)
[docs] def __iter__(self):
return MambuStructIterator(self.attrs)
[docs] def convert_dict_to_attrs(self, *args, **kwargs):
"""The trick for iterable Mambu Objects comes here:
You iterate over each element of the responded List from Mambu,
and create a Mambu Centre object for each one, initializing them
one at a time, and changing the attrs attribute (which just
holds a list of plain dictionaries) with a MambuCentre just
created.
.. todo:: pass a valid (perhaps default) urlfunc, and its
corresponding id to entid to each MambuCentre, telling
MambuStruct not to connect() by default. It's desirable to
connect at any other further moment to refresh some element in
the list.
"""
for n, b in enumerate(self.attrs):
# ok ok, I'm modifying elements of a list while iterating it. BAD PRACTICE!
try:
params = self.params
except AttributeError:
params = {}
kwargs.update(params)
try:
self.mambucentreclass
except AttributeError:
self.mambucentreclass = MambuCentre
centre = self.mambucentreclass(urlfunc=None, entid=None, *args, **kwargs)
centre.init(b, *args, **kwargs)
centre._MambuStruct__urlfunc = getcentresurl
self.attrs[n] = centre