Repose - Python API client framework¶

Api¶

class repose.api.Api(**options)¶

A top-level API representation

Initialising an Api instance is a necessary step as doing so will furnish all registered Resources (and their Managers) with access to the API backend.

For example:

my_api = Api(base_url='http://example.com/api/v1')
my_api.register_resource(User)
my_api.register_resource(Comment)
my_api.register_resource(Page)

The same can be achieved by implementing a child class. This also gives the additional flexibility of being able to add more complex logic by overriding existing methods. For example:

class MyApi(Api):
    # Alternative way to provide base_url and resources
    base_url = '/api/v1'
    resources = [User, Comment, Page]

    # Additionally, customise the base URL generation
    def get_base_url(self):
        return 'http://{host}/api/{account}'.format(
            host=self.host,
            account=self.account,
        )

my_api = MyApi(host='myhost.com', account='my-account')

base_url¶

str

The fully-qualified base URL to the the API. (Eg: "http://example.com")

backend_class¶

ApiBackend

The class to instantiate for use as the Api Backend (default: ApiBackend).

resources¶

list[Resource]

Resource classes to register with the API. Can also be registered using register_resource().

client_class¶

The client class to instantiate. Should be either Client or a subclass thereof.

__init__(**options)¶

Initialise the Api

Pass options in to customise instance variables. For example:

my_api = Api(base_url='http://example.com/api/v1')

Parameters:	base_url (str) – The fully-qualified base URL to the the API. (Eg: "http://example.com") backend_class (ApiBackend) – The class to instantiate for use as the Api Backend (default: ApiBackend). resources (list[Resource]) – Resource classes to register with the API. Can also be registered using register_resource(). **options – All options specified will will become available as instance variables.

backend_class

alias of ApiBackend

register_resource(resource)¶

Register a resource with the Api

This will cause the resource’s backend attribute to be populated.

Parameters:	resource (Resource) – The resource class to register

Resources¶

class repose.resources.Resource(**kwargs)¶

Representation of an API resource

parent_resource¶

list

A list of all parent resources to this one. Often useful in generating endpoints for child resources. Parent resources are stored as weakref.ref()

api¶

Api

The API instance

class Meta¶

Override this class in child resources to provide configuration details.

The endpoints listed here can include placeholders in the form {fieldname}. If this resource is a child of another resource, the parent resource’s fields may be accessed in the form {parentname_fieldname}}, where parentname is the lowercase class name.

For example, a User resource may contain several Comment resources. In which case the endpoint for the Comment could be:

/user/{user_id}/comments/{id}

You could also expand the latter placeholder as follows:

/user/{user_id}/comments/{comment_id}

endpoint¶

str

Endpoint URL for a single resource (will be appended to the API’s base_url)

endpoint_list¶

str

Endpoint URL for listing resources (will be appended to the API’s base_url)

Resource.__init__(**kwargs)¶

Initialise the resource with field values specified in *kwargs

Parameters:	**kwargs – Fields and their (decoded) values

classmethod Resource.contribute_api(api)¶

Contribute the API backend to this resource and its managers.

Note

Mainly for internal use

Resource.contribute_parents(parent=None)¶

Furnish this class with it’s parent resources

Note

Mainly for internal use

Resource.prepare_save(encoded)¶

Prepare the resource to be saved

Will only return values which have changed

Can be used as a hook with which to tweak data before sending back to the server. For example:

def prepare_save(encoded):
    prepared = super(MyResource, self).prepare_save(encoded)
    prepared['extra_value'] = 'Something'
    return prepared

Parameters:	encoded (dict) – The encoded resource data

Resource.save()¶

Persist pending changes

Fields Reference¶

class repose.fields.Dictionary(*args, **kwargs)¶

Field subclass with dict validation.

__init__(*args, **kwargs)¶

class repose.fields.IsoDate(*args, **kwargs)¶

Field subclass for ISO8601 dates.

Todo

The IsoDate field needs implementing Should parse ISO8601 strings into datetime objects and back again.

class repose.fields.ManagedIdListCollection(model, *args, **kwargs)¶

Use for providing a managed collection upon a field which contains a list of model IDs.

This does a little fancy footwork to ensure that the values are only loaded when accessed. This functionality is largely provided by LazyList

__init__(model, *args, **kwargs)¶

Managers¶

Managers have the task of managing access to resources.

For example, to access a group of fictional User resources you would use:

# Simple user of a manager
users = User.objects.all()

Here you access the objects manager on the User resource. The objects manager is known as the ‘default’ manager. Additional managers may also by provided. For example:

class User(Resource):
    ... define fields...

    # Note you need to explicitly define the 'objects' default
    # manager when you add custom managers
    objects = Manager()

    # Now add some custom managers
    active_users = Manager(filter=lambda u: u.is_active)
    inactive_users = Manager(filter=lambda u: not u.is_active)
    super_users = Manager(filter=lambda u: u.is_super_user)

Now you can use statements such as:

awesome_users = User.super_users.all()
total_active_users = User.active_users.count()

You can also extend the Manager class to provide both additional functionality and greater intelligence. For example:

class UserManager(Manager):

    def count(self):
        # Pull the count from the server rather than pulling all
        # users then counting them.
        json = self.api.get('/users/total_count')
        return json['total']

Or perhaps you want be able to perform custom actions on groups of Resources:

class LightManager(manager):

    def turn_on(self):
        for light in self.all():
            light.on = True
            light.save()

class repose.managers.Manager(decoders=None, results_endpoint=None, filter=None)¶

The base Manager class

api¶

Api

The Api instance

decoders¶

list[Decoder]

The decoders used to decode list data

model¶

Resource

The Resource class to be managed

results¶

list

The results as loaded from the API

results_endpoint¶

list

The results to be used to fetch results

__init__(decoders=None, results_endpoint=None, filter=None)¶

Initialise the Manager

Parameters:	decoders (list[Decoder]) – The decoders used to decode list data results_endpoint (str) – The results to be used to fetch results. Defaults to Meta.endpoint_list filter (callable) – The filter function to be applied to the results. Will be passed a single result and must return True/False if the result should be included/excluded in the results respectively.

all()¶

Return all results

count()¶

Return the total number of results

Returns:	int

Note

This is a naive implementation of count() which simply retrieves all results and counts them. You should consider overriding this (as demoed above) if dealing with non-trivial numbers of results.

get(**endpoint_params)¶

Get a single resource

Parameters:	endpoint_params (dict) – Parameters which should be used to format the Meta.endpoint string.
Returns:
Return type:	Resource

get_decoders()¶

Return the decoders to be used for decoding list data

Returns:	Manager.decoders by default
Return type:	list[Decoder]

get_results_endpoint()¶

Get the results endpoint

Returns:	results_endpoint as passed to __init__() or Meta.endpoint_list.
Return type:	str

ApiBackend¶

class repose.apibackend.ApiBackend(base_url)¶

Default backend implementation providing HTTP access to the remote API

This can be extended and passed into your Api instance at instantiation time. This can be useful if you need to customise how requests are made, or how responses are parsed.

__init__(base_url)¶

Instantiate this class

Parameters:	base_url (str) – The fully-qualified base URL to the the API. (Eg: "http://example.com").

delete(endpoint, json)¶

Perform a HTTP DELETE request for the specified endpoint

Parameters:	json (dict) – The JSON body to post with the request
Returns:	Typically a python list, dictionary, or None
Return type:	object

get(endpoint, params=None)¶

Perform a HTTP GET request for the specified endpoint

Parameters:	params (dict) – Dictionary of URL params
Returns:	Typically a python list or dictionary
Return type:	object

make_url(endpoint)¶

Construct the fully qualified URL for the given endpoint.

For example:

>>> my_backend = ApiBackend(base_url="http://example.com/api")
>>> my_backend.make_url("/user/1")
"http://example.com/api/user/1"

Parameters:	endpoint (str) – The API endpoint (Eg: "/user/1").
Returns:	The fully qualified URL
Return type:	str

parse_response(response)¶

Parse a response into a Python structure

Parameters:	response (requests.Response) – A Response object, unless otherwise provided by the get()
Returns:	Typically a python list or dictionary
Return type:	object

post(endpoint, json)¶

Perform a HTTP POST request for the specified endpoint

Parameters:	json (dict) – The JSON body to post with the request
Returns:	Typically a python list, dictionary, or None
Return type:	object

put(endpoint, json)¶

Perform a HTTP PUT request for the specified endpoint

Parameters:	json (dict) – The JSON body to post with the request
Returns:	Typically a python list, dictionary, or None
Return type:	object

Decoders¶

Decoders are used be fields to decode incoming data from the API into a form usable in Python.

Those listed here are typically used by the fields module. Unless you are creating your own field, you can probably focus your attention there.

This is the inverse operation to that of encoders.

class repose.decoders.IdToLazyModelListDecoder(resource)¶

Decode a list of resource IDs into a lazily loaded list of Resource objects

__init__(resource)¶

Initialise the decoder

Parameters:	resource (Resource) – The Resource class (not an instance) to which the IDs listed relate.

decode(value)¶

Decode the value into a LazyList.

Note

This assumes the destination Resource has an ID field and that the endpoint is in the form /myresource/{myresource_id}

Todo

Consider refactoring out these assumptions

Encoders¶

Decoders are used be fields to encode Python values into a form consumable by the API.

Those listed here are typically used by the fields module. Unless you are creating your own field, you can probably focus your attention there.

This is the inverse operation to that of decoders.

class repose.encoders.ModelToIdListEncoder¶

Encode a list of Resource instances into a list of resource IDs.

encode(value)¶

Initialise the encoder

Parameters:	value (list[Resource]) – A list of Resource instances to be encoded

Utilities¶

General utilities used within Repose.

For the most part these can be ignored, their usage is mainly for internal purposes.

class repose.utilities.LazyList(generator, size)¶

Wraps a generator from which data is only loaded when needed.

Todo

The LazyList loading logic could be more intelligent

Todo

Make the size parameter optional

__init__(generator, size)¶

Initialise the LazyList

Parameters:	generator (generator) – The generator to be lazy loaded size (int) – The size of the list to be loaded

repose.utilities.get_values_from_endpoint(resource, endpoint_params)¶

Determine if any values in the endpoint parameters should be used to populate fields.

An example of this would be resources which don’t provide their own ID in the return data, and it must therefore come from the endpoint used to access the resource. In which case, you may define the resource’s ID field as:

id = fields.Integer(from_endpoint='id')

Parameters:	resource (repose.resources.Resource) – The class of the resource being populated endpoint_params (dict) – All parameters available for formatting to the endpoint strings.

repose.utilities.make_endpoint(model)¶

Make an endpoint for a given model

See the repose.resources.Resource.Meta for a description of endpoint URL formatting.