MycroftAI
/
mycroft-core
mirror of https://github.com/MycroftAI/mycroft-core.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add comments and docstring for the send method 

Add docstring explaining the basics of the send method.
pull/1520/head
Åke Forslund 2018-04-05 11:20:55 +02:00
parent 9f843993b6
commit 851e3b2aa4
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
mycroft/api/__init__.py
View File

@ -79,6 +79,16 @@ class Api(object):
IdentityManager.save(data) IdentityManager.save(data)
def send(self, params): def send(self, params):
""" Send request to mycroft backend.
The method handles Etags and will return a cached response value
if nothing has changed on the remote.
Arguments:
params (dict): request parameters
Returns:
Requests response object.
"""
query_data = frozenset(params.get('query', {}).items()) query_data = frozenset(params.get('query', {}).items())
params_key = (params.get('path'), query_data) params_key = (params.get('path'), query_data)
etag = self.params_to_etag.get(params_key) etag = self.params_to_etag.get(params_key)
@ -90,6 +100,8 @@ class Api(object):
query = self.build_query(params) query = self.build_query(params)
url = self.build_url(params) url = self.build_url(params)
# For an introduction to the Etag feature check out:
# https://en.wikipedia.org/wiki/HTTP_ETag
if etag: if etag:
headers['If-None-Match'] = etag headers['If-None-Match'] = etag