prompy.networkio package

prompy.networkio.call_factory module

call_factory

Meta web api wrapper.

Usage:

from prompy.networkio.call_factory import CallRoute, Caller
from prompy.threadio.promise_queue import PromiseQueuePool


class Api(Caller):
    def call_home(self, **kwargs):
        return CallRoute('/')

    def call_data(self, **kwargs):
        return CallRoute('/data', method='POST')


pool = PromiseQueuePool(start=True)
api = Api(base_url='http://localhost:5000', promise_container=pool)
api.call_data(data={'num': 6}).then(print).catch(print)

class prompy.networkio.call_factory.CallRoute(route, method='GET', content_type='application/json')

Bases: object

Route object used by Caller

__init__(route, method='GET', content_type='application/json')

Route data object with format methods.

Parameters:

• route (str) – url to call, with optional templating.
• method (str) – http method
• content_type (str) –

format_data(data, encoding='utf-8')

Serialize the data according to content-type.

Parameters:

• encoding –
• data (Union[Dict[~KT, ~VT], List[~T], str, None]) –

Returns:

format_route_params(*args)

Format the route params.

Example:

route = CallRoute('/user/<user>')
r = route.format_route_params(user='bob')

Returns:

class prompy.networkio.call_factory.Caller(base_url='', promise_container=None, prom_type=prompy.promise.Promise, prom_args=None)

Bases: object

Wraps all method starting with call_ with a call.

route methods must:

• return a CallRoute object.
• kwargs must be there if you want Caller.call and route params kwargs.

__init__(base_url='', promise_container=None, prom_type=prompy.promise.Promise, prom_args=None)

Parameters:

• base_url (str) –
• promise_container (Optional[BasePromiseContainer]) –
• prom_type –
• prom_args (Optional[dict]) –

after_call(route, route_params, params, result, error)

global after call callback

Parameters:

• route (CallRoute) – The route that was called.
• route_params (list) – The params of the route if any
• params (dict) – The url params
• result (Any) – The result of the call if any
• error (Any) – The error of the call if any

Returns:

before_call(route, route_params, params)

global before call callback.

Parameters:

• route (CallRoute) – The route that was called.
• route_params (list) – The params of the route if any
• params (dict) – The url params

Returns:

call(route, route_params=None, params=None, headers=None, origin_req_host=None, unverifiable=False, data=None, **kwargs)

Call a route, used by the wrapped route methods.

Parameters:

• route (CallRoute) –
• route_params (Optional[list]) –
• params (Optional[dict]) –
• headers (Optional[dict]) –
• origin_req_host –
• unverifiable (bool) –
• data –
• kwargs –

Return type:

Promise[~PromiseReturnType]

Returns:

prompy.networkio.urlcall module

prompy.networkio.urlcall.get(url, params=None, prom_type=prompy.promise.Promise, **kwargs)

Return type:Promise[]

prompy.networkio.urlcall.json_call(url, payload=None, encoding='UTF-8', prom_type=prompy.promise.Promise, headers=None, **kwargs)

Auto encode payload and decode response in json.

Return type:Promise[]

prompy.networkio.urlcall.post(url, data=None, prom_type=prompy.promise.Promise, **kwargs)

Return type:Promise[]

prompy.networkio.urlcall.put(url, data, prom_type=prompy.promise.Promise, **kwargs)

Return type:Promise[]

prompy.networkio.urlcall.url_call(url, data=None, headers=None, origin_req_host=None, unverifiable=False, method=None, content_mapper=<function default_content_mapper>, prom_type=prompy.promise.Promise, **kwargs)

Base http call using urllib.

Parameters:

• url –
• data –
• headers –
• origin_req_host –
• unverifiable –
• method –
• content_mapper (Callable[[str, str, str], Any]) –
• prom_type –
• kwargs –

Return type:

Promise[]

Returns:

A promise to resolve with a response.