beat.web.plotters.api module

class beat.web.plotters.api.ListPlotterView(**kwargs)

Bases: beat.web.common.api.ListContributionView

List all available plotters

model

alias of beat.web.plotters.models.Plotter

serializer_class

alias of beat.web.plotters.serializers.PlotterSerializer

class beat.web.plotters.api.ListFormatPlotterView(**kwargs)

Bases: beat.web.common.api.ListContributionView

List all plotters corresponding to the given dataformat

model

alias of beat.web.plotters.models.Plotter

serializer_class

alias of beat.web.plotters.serializers.PlotterSerializer

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)

class beat.web.plotters.api.ListPlotterParameterView(**kwargs)

Bases: beat.web.common.api.ListContributionView

List all available plotters parameters

model

alias of beat.web.plotters.models.PlotterParameter

serializer_class

alias of beat.web.plotters.serializers.PlotterParameterSerializer

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)

class beat.web.plotters.api.ListDefaultPlotterView(**kwargs)

Bases: rest_framework.generics.ListAPIView

List all available plotters

model

alias of beat.web.plotters.models.DefaultPlotter

serializer_class

alias of beat.web.plotters.serializers.DefaultPlotterSerializer

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)

class beat.web.plotters.api.CheckPlotterNameView(**kwargs)

Bases: beat.web.common.api.CheckContributionNameView

This view sanitizes a Plotter name and checks whether it is already used.

model

alias of beat.web.plotters.models.Plotter

class beat.web.plotters.api.ListCreatePlottersView(**kwargs)

Bases: beat.web.common.api.ListCreateContributionView

Read/Write end point that list the plotters available from a given author and allows the creation of new plotters

model

alias of beat.web.plotters.models.Plotter

serializer_class

alias of beat.web.plotters.serializers.PlotterAllSerializer

writing_serializer_class

alias of beat.web.plotters.serializers.PlotterCreationSerializer

namespace = 'api_plotters'

class beat.web.plotters.api.RetrieveUpdateDestroyPlottersView(**kwargs)

Bases: beat.web.code.api.RetrieveUpdateDestroyCodeView

Read/Write/Delete endpoint for a given plotter

model

alias of beat.web.plotters.models.Plotter

serializer_class

alias of beat.web.plotters.serializers.FullPlotterSerializer

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)

class beat.web.plotters.api.CheckPlotterParameterNameView(**kwargs)

Bases: beat.web.common.api.CheckContributionNameView

This view sanitizes a PlotterParameter name and checks whether it is already used.

model

alias of beat.web.plotters.models.PlotterParameter

class beat.web.plotters.api.SharePlotterParameterView(**kwargs)

Bases: beat.web.common.api.ShareView

This view allows to share a PlotterParameter with other users and/or teams

model

alias of beat.web.plotters.models.PlotterParameter

class beat.web.plotters.api.ListPlotterParametersView(**kwargs)

Bases: beat.web.common.api.ListCreateContributionView

List all available PlotterParameters

model

alias of beat.web.plotters.models.PlotterParameter

serializer_class

alias of beat.web.plotters.serializers.FullPlotterParameterSerializer

writing_serializer_class

alias of beat.web.plotters.serializers.PlotterParameterCreationSerializer

namespace = 'api_plotters'

class beat.web.plotters.api.RetrieveUpdateDestroyPlotterParametersView(**kwargs)

Bases: beat.web.common.api.RetrieveUpdateDestroyContributionView

Read/Write/Delete endpoint for a given PlotterParameter

model

alias of beat.web.plotters.models.PlotterParameter

serializer_class

alias of beat.web.plotters.serializers.FullPlotterParameterSerializer

put(request, author_name, object_name, version=None)