Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alfred82santa/aio-service-client
Service Client Framework powered by Python asyncio
https://github.com/alfred82santa/aio-service-client
Last synced: about 4 hours ago
JSON representation
Service Client Framework powered by Python asyncio
- Host: GitHub
- URL: https://github.com/alfred82santa/aio-service-client
- Owner: alfred82santa
- License: lgpl-3.0
- Created: 2016-04-26T16:55:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-29T13:59:08.000Z (about 3 years ago)
- Last Synced: 2024-10-04T09:21:15.072Z (about 1 month ago)
- Language: Python
- Size: 128 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
|travis-master| |coverall-master| |doc-master| |pypi-downloads| |pypi-lastrelease| |python-versions|
|project-status| |project-license| |project-format| |project-implementation|
.. |travis-master| image:: https://travis-ci.org/alfred82santa/aio-service-client.svg?branch=master
:target: https://travis-ci.org/alfred82santa/aio-service-client
.. |coverall-master| image:: https://coveralls.io/repos/alfred82santa/aio-service-client/badge.svg?branch=master&service=github
:target: https://coveralls.io/r/alfred82santa/aio-service-client?branch=master
.. |doc-master| image:: https://readthedocs.org/projects/aio-service-client/badge/?version=latest
:target: http://aio-service-client.readthedocs.io/?badge=latest
:alt: Documentation Status
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: Downloads
.. |pypi-lastrelease| image:: https://img.shields.io/pypi/v/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: Latest Version
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: Supported Python versions
.. |project-status| image:: https://img.shields.io/pypi/status/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: Development Status
.. |project-license| image:: https://img.shields.io/pypi/l/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: License
.. |project-format| image:: https://img.shields.io/pypi/format/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: Download format
.. |project-implementation| image:: https://img.shields.io/pypi/implementation/aio-service-client.svg
:target: https://pypi.python.org/pypi/aio-service-client/
:alt: Supported Python implementations
========================
Service Client Framework
========================
Service Client Framework powered by Python asyncio.
The easiest way to implement a client to work with a service REST API.
Features
========
- Easy way to make request to service.
- AsyncIO implementation using aiohttp.
- Powerful plugin system.
- Useful plugins.
- Mock plugin in order to make tests.
- Opensource license: GNU LGPLv3
Installation
============
.. code-block:: bash
$ pip install aio-service-client
Getting started
===============
Service client framework is used to call HTTP service API's. So, you must define how to
communicate with this service API defining its endpoint:
.. code-block:: python
spec = {"get_users": {"path": "/user",
"method": "get"},
"get_user_detail": {"path": "/user/{user_id}",
"method": "get"},
"create_user": {"path": "/user",
"method": "post"},
"update_user": {"path": "/user/{user_id}",
"method": "put"}}
Imagine you are using a Rest JSON API in order to manage users. So, your data must be sent
as a JSON and response must be a JSON string. It mean you must serialize every request payload
to a JSON, and parse every response as JSON. So, you only need to define JSON parser and serializer
for your service:
.. code-block:: python
service = ServiceClient(spec=spec,
plugins=[PathToken()],
base_path="http://example.com",
parser=json_decoder,
serializer=json_encoder)
So, you are ready to make request to service API:
.. code-block:: python
resp = yield from service.call("get_users")
# it could be called directly
# resp = yield from service.get_users()
# if response is like:
# {"users": {"item": [{"userId": "12", "username": "foo"}, {"userId": "13", "username": "bar"}], "count": 2}
print("Count: %d" % resp.data['users']['count'])
for user in resp.data['users']['items']:
print("User `%s`: %s" % (user['userId'], user['username']))
In order to send a payload you must use ``payload`` keyword on call:
.. code-block:: python
resp = yield from service.call("create_user", payload={"username": "foobar"})
# it could be called directly
# resp = yield from service.create_user(payload={"username": "foobar"})
# it will make a request like:
# POST http://example.com/user
#
# {"username": "foobar"}
Changelog
=========
v0.7.2
------
- Fix Mock and Loggers plugins work together.
- Added RawDataMock in order to allow to set mock data as string or byte-string directly on spec.
- Added JsonDataMock in order to allow to set mock json data as a dictionary or list on spec.
v0.7.1
------
- Python 3.9 compatible.
- Update aiohttp.
v0.6.1
------
- Pool plugin now add ``blocked_by_pool`` attribute to session containing elapsed time (seconds) on pool. It allows
to log this time using log plugins.
- RateLimit plugin now add ``blocked_by_ratelimit`` attribute to session containing elapsed time (seconds) blocked by
rate limit. It allows to log this time using log plugins.
- Tests improved.
- Added new exceptions: `service_client.plugins.TooManyRequestsPendingError` and
`service_client.plugins.TooMuchTimePendingError`.
- Added decorator in order to help to build service clients. It allows to define a method using a request model
but to call it using keywords to build request model which will be used to call method.
.. code-block:: python
class RequestModel:
def __init__(param_1=None):
self.param_1 = param_1
class Service:
@build_parameter_object
async def method_1(request: RequestModel):
return do_something(request)
serv = Service()
await serv.method_1(param_1=23)
v0.6.0
------
- Improved Pool plugin. It now allows to set hard limit of pending requests, if it reach limit requests will
fail raising `RequestLimitError`. In same way, it allows to set a timeout, in seconds, for pending requests and
it will raise same exception.
- Added new RateLimit plugin. It is similar to Pool plugin but using a period parameter, in seconds, in order to limit number
of request in this period.
- Improved error logging.
- Added new hook ``close`` in order to notify plugins that client is going to close.
- Removed compatibility with Python 3.4.
v0.5.4
------
- Made compatible with aiohttp 2.0.x.
v0.5.2
------
- Made compatible with aiohttp 1.0.x.
- Simplified factory code.
v0.5.1
------
- Resolved problem with requests streamed.
v0.5.0
------
- Added factories
- Added spec loaders
v0.4.1
------
- Fix elapsed data on logs.
v0.4.0
------
- Added new ``Pool`` plugin.
- Improved ``Elapsed`` plugin.
- Added new hook in order to allow plugins to override response methods.
v0.3.1
------
- Fix response when using Timeout plugin.
v0.3.0
------
- Added TrackingToken plugin. Token is added to session and to response.
- Added a log formatter.
- Removed tracking token stuff from log plugins.
- Improved log plugins. They avoid to print body if it is streamed or must be hidden.
- Improved session wrapper.
Plugins
=======
PathTokens
----------
It allows to fill placeholders on path in order to build uri.
.. code-block:: python
service = ServiceClient(spec={"endpoint1": {"method": "get",
"path": "/endpoint/{placeholder1}/{placeholder2}"}},
plugins=[PathToken()],
base_path="http://example.com")
resp = yield from service.call("endpoint1", placeholder1=21, placeholder1="foo")
# It will make request:
# GET http://example.com/endpoint/21/foo
Headers
-------
It allows to define default headers, endpoint headers and request headers.
.. code-block:: python
service = ServiceClient(spec={"endpoint1": {"method": "get",
"path": "/endpoint/foo/bar",
"headers": {"X-fake-header": "header; data"}}},
plugins=[Headers(headers={"content-type": "application/json"})],
base_path="http://example.com")
resp = yield from service.call("endpoint1", headers={"X-other-fake-header": "foo"})
# It will make request:
# GET http://example.com/endpoint/foo/bar
# X-fake-header: header; data
# content-type: application/json
# X-other-fake-header: foo
Timeout
-------
It allows to define default timeout for service request, endpoint or request.
Elapsed
-------
It adds elapsed time to response.
TrackingToken
-------------
It allows to assign a token for each pair request/response in order to identify them.
QueryParams
-----------
It allows to use query parameters on request. They could be defined at service client, endpoint or request.
InnerLogger
-----------
It allows to log request after serialize and response before parse.
OuterLogger
-----------
It allows to log request before serialize and response after parse.
Pool
----
It allows to limit concurrent requests. Besides it allows to set a hard limit of pending requests and a timeout
for blocked ones.
RateLimit
---------
It allows to limit number of requests in a time period. Besides it allows to set a hard limit of
pending requests and a timeout for blocked ones.