Chilero’s API¶
chilero.web.application module¶
chilero.web.resource module¶
-
class
chilero.web.resource.CollectionResponse(resource, extra_content=None, **kwargs)¶
-
class
chilero.web.resource.EntityResponse(resource, body=None, extra_content=None, **kwargs)¶
-
class
chilero.web.resource.Resource(*args, **kwargs)¶ Bases:
chilero.web.view.ViewBase class for HTTP Resources (RESTful?)
-
default_kwargs_for_urls()¶ Default keyword arguments for building the resource’s urls.
Returns: dict
-
get_definition_url(resource=None, **kwargs)¶
-
get_encoder_class()¶
-
get_index_url(resource=None, **kwargs)¶ Builds the url of the resource’s index.
Parameters: - resource – name of the resource or None
- kwargs – additional keyword arguments to build the url
Returns: url of the resource’s index
-
get_nested_resources()¶
-
get_nested_urls()¶
-
get_object_url(id, resource=None, **kwargs)¶
-
get_parent()¶ Returns the url to the parent endpoint.
-
get_resource_name()¶
-
get_self_url()¶
-
has_nested_resources()¶
-
id_pattern= '{id}'¶
-
is_collection()¶
-
is_entity()¶ Hacky solution to detect if current instance of the class is an entity or collection endpoint.
-
nested_collection_resources= None¶
-
nested_entity_resources= None¶
-
resource_definition(**kwargs)¶
-
response(*args, **kwargs)¶
-
-
class
chilero.web.resource.ResourceResponse(resource, kind=None, extra_content=None, **kwargs)¶
chilero.web.response module¶
-
class
chilero.web.response.HTMLResponse(body, **kwargs)¶
-
class
chilero.web.response.JSONResponse(data, cls=None, **kwargs)¶
-
class
chilero.web.response.JavaScriptResponse(data, **kwargs)¶
-
class
chilero.web.response.Response(body=None, **kwargs)¶ Bases:
aiohttp.web_response.Response