Response

API adapter response classes for odin-control adapters.

This module defines the response container class used by API adapters to return data, content type and status code information.

Tim Nicholls, STFC Detector Systems Software Group

ApiAdapterResponse

Bases: object

API adapter response object.

This is a container class for responses returned by ApiAdapter method calls. It encapsulates the required attributes for all responses; data, content type and status code.

Source code in src/odin_control/adapters/response.py

class ApiAdapterResponse(object):
    """API adapter response object.

    This is a container class for responses returned by ApiAdapter method calls.
    It encapsulates the required attributes for all responses; data, content type and
    status code.
    """

    def __init__(self, data, content_type="text/plain", status_code=200):
        """Initialise the APiAdapterResponse object.

        :param data: data to return from data
        :param content_type: content type of response
        :param status_code: HTTP status code to return
        """
        self.data = data
        self.content_type = content_type
        self.status_code = status_code

    def set_content_type(self, content_type):
        """Set the content type for the adapter response.

        :param content_type: response content type
        """
        self.content_type = content_type

    def set_status_code(self, status_code):
        """Set the HTTP status code for the adapter response.

        :param status_code: HTTP status code
        """
        self.status_code = status_code

__init__(data, content_type='text/plain', status_code=200)

Initialise the APiAdapterResponse object.

Parameters:

Name	Type	Description	Default
data		data to return from data	required
content_type		content type of response	'text/plain'
status_code		HTTP status code to return	200

Source code in src/odin_control/adapters/response.py

def __init__(self, data, content_type="text/plain", status_code=200):
    """Initialise the APiAdapterResponse object.

    :param data: data to return from data
    :param content_type: content type of response
    :param status_code: HTTP status code to return
    """
    self.data = data
    self.content_type = content_type
    self.status_code = status_code

set_content_type(content_type)

Set the content type for the adapter response.

Parameters:

Name	Type	Description	Default
content_type		response content type	required

Source code in src/odin_control/adapters/response.py

def set_content_type(self, content_type):
    """Set the content type for the adapter response.

    :param content_type: response content type
    """
    self.content_type = content_type

set_status_code(status_code)

Set the HTTP status code for the adapter response.

Parameters:

Name	Type	Description	Default
status_code		HTTP status code	required

Source code in src/odin_control/adapters/response.py

def set_status_code(self, status_code):
    """Set the HTTP status code for the adapter response.

    :param status_code: HTTP status code
    """
    self.status_code = status_code