members.api package

Submodules

members.api.serializers module

DRF serializers defined by the members package

class members.api.serializers.MemberBirthdaySerializer(*args, **kwargs)

Bases: events.api.serializers.base.calendarjs.CalenderJSSerializer

Serializer that renders the member birthdays to the CalendarJS format

class Meta

Bases: events.api.serializers.base.calendarjs.CalenderJSSerializer.Meta

model

alias of members.models.member.Member

class members.api.serializers.MemberListSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Serializer that renders a list of members

class Meta

Bases: object

fields = ('pk', 'display_name', 'avatar')

model

alias of members.models.member.Member

class members.api.serializers.ProfileEditSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Serializer that renders a profile to be edited

class Meta

Bases: object

fields = ('pk', 'email', 'first_name', 'last_name', 'address_street', 'address_street2', 'address_postal_code', 'address_city', 'address_country', 'phone_number', 'show_birthday', 'website', 'photo', 'emergency_contact', 'emergency_contact_phone_number', 'profile_description', 'nickname', 'display_name_preference', 'language', 'receive_optin', 'receive_newsletter', 'receive_magazine', 'display_name', 'avatar', 'birthday', 'starting_year', 'programme', 'membership_type', 'achievements', 'societies')

model

alias of members.models.profile.Profile

read_only_fields = ('display_name', 'starting_year', 'programme', 'birthday')

class members.api.serializers.ProfileRetrieveSerializer(*args, **kwargs)

Bases: rest_framework.serializers.ModelSerializer

Serializer that renders a member profile

class Meta

Bases: object

fields = ('pk', 'display_name', 'avatar', 'profile_description', 'birthday', 'starting_year', 'programme', 'website', 'membership_type', 'achievements', 'societies')

model

alias of members.models.profile.Profile

members.api.urls module

DRF routes defined by the members package

members.api.viewsets module

DRF viewsets defined by the members package

class members.api.viewsets.MemberViewset(**kwargs)

Bases: rest_framework.viewsets.ReadOnlyModelViewSet, rest_framework.mixins.UpdateModelMixin

Viewset that renders or edits a member

basename = None

birthdays(request)

description = None

detail = None

filter_backends = (<class 'rest_framework.filters.OrderingFilter'>, <class 'rest_framework.filters.SearchFilter'>)

get_object()

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

get_permissions()

Instantiates and returns the list of permissions that this view requires.

get_queryset()

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_class()

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

is_self_reference()

lookup_field = 'pk'

name = None

ordering_fields = ('profile__starting_year', 'first_name', 'last_name')

queryset

search_fields = ('profile__nickname', 'first_name', 'last_name', 'username')

suffix = None