Congegni
/
libretime
mirror of https://github.com/libretime/libretime.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cc-4105: formatted comments in api_client

This commit is contained in:
Rudi Grinberg 2012-08-09 12:15:45 -04:00
parent 5bc170ba31
commit d5e7d881ab
1 changed files with 32 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
python_apps/api_clients/api_client.py
View File

@ -1,9 +1,9 @@
############################################################################### ###############################################################################
# This file holds the implementations for all the API clients. # This file holds the implementations for all the API clients.
# #
# If you want to develop a new client, here are some suggestions: # If you want to develop a new client, here are some suggestions: Get the fetch
# Get the fetch methods working first, then the push, then the liquidsoap notifier. # methods working first, then the push, then the liquidsoap notifier. You will
# You will probably want to create a script on your server side to automatically # probably want to create a script on your server side to automatically
# schedule a playlist one minute from the current time. # schedule a playlist one minute from the current time.
############################################################################### ###############################################################################
import sys import sys
@ -55,7 +55,8 @@ class AirtimeApiClient():
elif (not AirtimeApiClient.default_config): elif (not AirtimeApiClient.default_config):
raise ValueError("Cannot slip config_path attribute when it has \ raise ValueError("Cannot slip config_path attribute when it has \
never been passed yet") never been passed yet")
return AirtimeApiClient( logger=None, config_path=AirtimeApiClient.default_config ) return AirtimeApiClient( logger=None,
config_path=AirtimeApiClient.default_config )
def __init__(self, logger=None,config_path='/etc/airtime/api_client.cfg'): def __init__(self, logger=None,config_path='/etc/airtime/api_client.cfg'):
if logger is None: if logger is None:
@ -93,14 +94,15 @@ class AirtimeApiClient():
def get_response_into_file(self, url, block=True): def get_response_into_file(self, url, block=True):
""" """
This function will query the server and download its response directly This function will query the server and download its response directly
into a temporary file. This is useful in the situation where the response into a temporary file. This is useful in the situation where the
from the server can be huge and we don't want to store it into memory (potentially response from the server can be huge and we don't want to store it into
causing Python to use hundreds of MB's of memory). By writing into a file we can memory (potentially causing Python to use hundreds of MB's of memory).
then open this file later, and read data a little bit at a time and be very mem By writing into a file we can then open this file later, and read data
efficient. a little bit at a time and be very mem efficient.
The return value of this function is the path of the temporary file. Unless specified using The return value of this function is the path of the temporary file.
block = False, this function will block until a successful HTTP 200 response is received. Unless specified using block = False, this function will block until a
successful HTTP 200 response is received.
""" """
logger = self.logger logger = self.logger
@ -130,7 +132,9 @@ class AirtimeApiClient():
def __get_airtime_version(self): def __get_airtime_version(self):
logger = self.logger logger = self.logger
url = "http://%s:%s/%s/%s" % (self.config["base_url"], str(self.config["base_port"]), self.config["api_base"], self.config["version_url"]) url = "http://%s:%s/%s/%s" % (self.config["base_url"],
str(self.config["base_port"]), self.config["api_base"],
self.config["version_url"])
logger.debug("Trying to contact %s", url) logger.debug("Trying to contact %s", url)
url = url.replace("%%api_key%%", self.config["api_key"]) url = url.replace("%%api_key%%", self.config["api_key"])
@ -173,7 +177,8 @@ class AirtimeApiClient():
elif (version[0:3] != AIRTIME_VERSION[0:3]): elif (version[0:3] != AIRTIME_VERSION[0:3]):
if (verbose): if (verbose):
logger.info('Airtime version found: ' + str(version)) logger.info('Airtime version found: ' + str(version))
logger.info('pypo is at version ' + AIRTIME_VERSION + ' and is not compatible with this version of Airtime.\n') logger.info('pypo is at version ' + AIRTIME_VERSION +
' and is not compatible with this version of Airtime.\n')
return False return False
else: else:
if (verbose): if (verbose):
@ -387,11 +392,12 @@ class AirtimeApiClient():
def send_media_monitor_requests(self, action_list, dry=False): def send_media_monitor_requests(self, action_list, dry=False):
""" """
Send a gang of media monitor events at a time. actions_list is a list of dictionaries Send a gang of media monitor events at a time. actions_list is a list
where every dictionary is representing an action. Every action dict must contain a 'mode' of dictionaries where every dictionary is representing an action. Every
key that says what kind of action it is and an optional 'is_record' key that says whether action dict must contain a 'mode' key that says what kind of action it
the show was recorded or not. The value of this key does not matter, only if it's present is and an optional 'is_record' key that says whether the show was
or not. recorded or not. The value of this key does not matter, only if it's
present or not.
""" """
logger = self.logger logger = self.logger
try: try:
@ -535,10 +541,10 @@ class AirtimeApiClient():
return response return response
""" """
Purpose of this method is to contact the server with a "Hey its me!" message. Purpose of this method is to contact the server with a "Hey its me!"
This will allow the server to register the component's (component = media-monitor, pypo etc.) message. This will allow the server to register the component's (component
ip address, and later use it to query monit via monit's http service, or download log files = media-monitor, pypo etc.) ip address, and later use it to query monit via
via a http server. monit's http service, or download log files via a http server.
""" """
def register_component(self, component): def register_component(self, component):
logger = self.logger logger = self.logger
@ -606,8 +612,8 @@ class AirtimeApiClient():
logger.error("traceback: %s", traceback.format_exc()) logger.error("traceback: %s", traceback.format_exc())
""" """
When watched dir is missing(unplugged or something) on boot up, this function will get called When watched dir is missing(unplugged or something) on boot up, this
and will call appropriate function on Airtime. function will get called and will call appropriate function on Airtime.
""" """
def handle_watched_dir_missing(self, dir): def handle_watched_dir_missing(self, dir):
logger = self.logger logger = self.logger
@ -667,8 +673,8 @@ class AirtimeApiClient():
def update_replay_gain_values(self, pairs): def update_replay_gain_values(self, pairs):
""" """
'pairs' is a list of pairs in (x, y), where x is the file's database row id 'pairs' is a list of pairs in (x, y), where x is the file's database
and y is the file's replay_gain value in dB row id and y is the file's replay_gain value in dB
""" """
#http://localhost/api/update-replay-gain-value/ #http://localhost/api/update-replay-gain-value/