No project description provided
Project description
A generic client for RESTful APIs based on aiohttp. Python 3.5+ only.
Installation
$ pip install genericclient-aiohttp
Quickstart
import asyncio
from genericclient_aiohttp import GenericClient
async def main():
myclient = GenericClient(api_url)
myresource = await myclient.resources.get(id=1)
actives = await myclient.posts.filter(active=True)
loop = asyncio.get_event_loop()
loop.run_until_complete(main(loop))
Usage
Instantiation
myclient = GenericClient(url, auth=None, session=None, trailing_slash=False)
Arguments:
url: The root URL of your API
auth: The auth for your API. You can pass anything that aiohttp.ClientSession can accept as auth.
session: Pass a session instance to have aiohttp use that session. If None (the default), it will instantiate an instance of aiohttp.ClientSession for you.
trailing_slash: You can set this to True if your API’s URLs end with a /
Endpoints
Endpoints are available as properties on the main instance.
.all()
Retrieves all resources (essentially a simple GET on the endpoint):
await myclient.posts.all() # GET /posts/
.filter()
.filter(**kwargs) calls a GET with kwargs as querystring values:
await myclient.posts.filter(blog=12, status=1) # GET /posts/?blog=12&status=1
.get(**kwargs)
A special case of .filter().
If kwargs contains id, pk, slug or username, that value will be used in the URL path, in that order.
Otherwise, it calls a GET with kwargs as querystring values.
If the returned list is empty, will raise ResourceNotFound.
If the returned list contains more than 1 resource, will raise MultipleResourcesFound
Note that .get() will return a Resource, not a list of Resource s
await myclient.posts.filter(blog=12, status=1) # GET /posts/?blog=12&status=1 await myclient.posts.filter(id=12) # GET /posts/12/ await myclient.posts.filter(slug='12-ways-clickbait') # GET /posts/12-ways-clickbait/
.create(payload)
Will result in a POST, with payload (a dict) as the request’s body, returning a new Resource:
post = await myclient.posts.create({'blog': 12, 'status': 1}) # POST /posts/
.get_or_create(defaults, **kwargs)
Issues a GET to fetch the resource. If the resource is not found, issues a POST to create the resource:
# Assuming it doesn't exist
post = await myclient.posts.get_or_update(slug='my-post', defaults={'status': 1}) # GET /posts/my-post/, then POST /posts/
.create_or_update(payload)
If payload contains a key called 'id', will issue a PUT. If the server returns a 400 error, a PATCH request will be re-issued. If payload` does not contains 'id', it will issue a POST:
post = await myclient.posts.create_or_update({'status': 1}) # POST /posts/
post = await myclient.posts.create_or_update({'id': 1234, 'status': 1}) # PUT /posts/1234/
post = await myclient.posts.create_or_update({'id': 1234}) # PUT /posts/1234/
# <- server returns 400
# -> PATCH /posts/1234/
.delete(pk)
Will issue a DELETE, and will use pk as part of the URL:
await myclient.posts.delete(24) # DELETE /posts/24/
Resources
All endpoints methods (with the exception of .delete()) return either a Resource or a list of Resource s.
A Resource is just a wrapping class for a dict, where keys can be accessed as properties.
Additionally, Resource s have a special property called .payload, which contains the original payload received from the server.
Resource s have the following methods:
Resource.delete() will result in a DELETE, with Resource.id as par of the URL:
blog = await myclient.posts.create({'blog': 12, 'status': 1}) # POST /posts/
await blog.delete() # DELETE /blog/345/ -- the ID 345 was returned by the server in the previous response
Resource.save() will result in a PUT, with Resource.id as par of the URL. If the server returns a 400 error, a PATCH request will be re-issued:
post = await myclient.posts.create({'blog': 12, 'status': 1}) # POST /posts/
post.status = 2
await post.save() # PUT /posts/345/
post = Resource(id=345, status=1)
await post.save() # PUT /posts/345/
# <- server returns 400
# -> PATCH /posts/345/
Routes
If your API has some non-RESTful calls within the main endpoints (sometimes referred as detail_route and list_route), you can use genericclient to call them:
await myclient.posts(id=123).publish(date=tomorrow),
await myclient.blogs().ping()
Routes http calls use POST by default, but you can specify something else by using the _method argument:
await myclient.posts(_method='get', id=123).pingbacks(),
await myclient.blogs(_method='get').visits()
Note that instead of instances of genericclient_aiohttp.Resource, this calls will return an instance of aiohttp.web.Response.
License
Licensed under the MIT License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file genericclient-aiohttp-0.0.3.tar.gz.
File metadata
- Download URL: genericclient-aiohttp-0.0.3.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5beb3bbe38ded9aa797fdabf20069e551b6a6c6864833da0dba2ef0646534a45 |
|
| MD5 | 68728e4a7a29524a00334c63ffaa4816 |
|
| BLAKE2b-256 | 555c8be1901d3ce31df5a994b874689bee8c64713eba4b7ea0daebac27a8cf4f |
File details
Details for the file genericclient_aiohttp-0.0.3-py2.py3-none-any.whl.
File metadata
- Download URL: genericclient_aiohttp-0.0.3-py2.py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ffe7f2ef66a028c0abab3c4c4fa5409d9226ee10bb1e43c03c39f594f5210314 |
|
| MD5 | 624234e902038e37f77c8f0f94294f8b |
|
| BLAKE2b-256 | 3ab831192d0f8f1c387cb6954d94d994819c38a8c445aeabbc9ed559227f747c |
