updated documentation

Author: VladimirParkhomenko

qencode/exeptions.py

@@ -27,5 +27,7 @@ def x265_video_codec():
   from . custom_params import Libx265_VideoCodecParameters
   return Libx265_VideoCodecParameters()
 
+from . exeptions import QencodeClientException, QencodeTaskException
+
 
 

qencode/__init__.py renamed to qencode3/__init__.py

@@ -7,13 +7,15 @@ class Client(object):
       :return: encoder object
 
   """
-  def __init__(self, api_key, api_url=None, version=None, **kwargs):
+  def __init__(self, api_key, api_url=None, version=None):
     self.api_key = api_key
     self.api_url = api_url if api_url else 'https://api.qencode.com/'
     self.version = version if version else 'v1'
     self.connect = Http(self.version, self.api_url)
     self.access_token = None
+    self.expire = None
     self.error = None
+    self.code = None
     self.message = ''
     self._get_access_token()
 
@@ -24,14 +26,18 @@ def refresh_access_token(self, **kwargs):
     response = self.connect.request('access_token', dict(api_key=self.api_key))
     if not response['error']:
       self.access_token = response['token']
+      self.expire = response['expire']
     else:
       self.error = response['error']
+      self.code = response['error']
       self.message = response.get('message')
 
   def _get_access_token(self):
     response = self.connect.request('access_token', dict(api_key=self.api_key))
     if not response['error']:
       self.access_token = response['token']
+      self.expire = response['expire']
     else:
      self.error = response['error']
+     self.code = response['error']
      self.message = response.get('message')

qencode/client.py renamed to qencode3/client.py

@@ -1,6 +1,6 @@
 import json
 from json import JSONEncoder
-from . utils import rm_key_if_null
+from . utils import rm_attributes_if_null
 
 class CustomTranscodingParams(object):
   """CustomTranscodingParams
@@ -13,10 +13,10 @@ def __init__(self):
     self.source = None
     self.format = None
     self.callback_url = None
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
   def remove_null_params(self):
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
 class Format(object):
   """
@@ -45,10 +45,10 @@ def __init__(self):
     self.time = None
     self.path = None
     self.resize_mod = None
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
   def remove_null_params(self):
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
 class Destination(object):
   def __init__(self):
@@ -57,10 +57,10 @@ def __init__(self):
     self.secret = None
     self.permissions = None
     self.storage_class = None
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
   def remove_null_params(self):
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
 class Stream(object):
   def __init__(self):
@@ -84,10 +84,10 @@ def __init__(self):
     self.downmix_mode = None
     self.logo = None
     self.aspect_ratio = None
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
   def remove_null_params(self):
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
 
 
@@ -101,10 +101,10 @@ def __init__(self):
     self.bf = None
     self.directpred = None
     self.me_method = None
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
   def remove_null_params(self):
-    rm_key_if_null(self)
+    rm_attributes_if_null(self)
 
 class Libx265_VideoCodecParameters(object):
   def __init__(self):
@@ -134,7 +134,7 @@ def prepare_params(self):
   def validate_params(self):
     if not self.params:
       self.error = True
-      self.message = 'for custom start encode - params is required'
+      self.message = 'Params is required'
       return
     if not 'source' in self.params.__dict__:
       self.error = True
@@ -144,19 +144,5 @@ def validate_params(self):
       self.error = True
       self.message = 'Params: format is required'
       return
-    for format in self.params.format:
-      if not 'stream' in format.__dict__:
-        self.error = True
-        self.message = 'Params: stream is required in the format list'
-        return
-      if not 'output' in format.__dict__:
-        self.error = True
-        self.message = 'Params: output format is required in the format list'
-        return
-      for stream in format.stream:
-        if not 'size' in stream.__dict__:
-          self.error = True
-          self.message = 'Params: size is required in the stream list'
-          return
 
 

qencode/const.py renamed to qencode3/const.py

@@ -0,0 +1,14 @@
+class QencodeException(Exception):
+  def __init__(self, message,  *args):
+    super(QencodeException, self).__init__(message, *args)
+    self.error = message
+    self.arg = [i for i in args]
+
+class QencodeClientException(QencodeException):
+  def __init__(self, message,  *args):
+    super(QencodeClientException, self).__init__(message, *args)
+
+
+class QencodeTaskException(QencodeException):
+  def __init__(self, message,  *args):
+    super(QencodeTaskException, self).__init__(message, *args)

qencode/custom_params.py renamed to qencode3/custom_params.py

@@ -1,6 +1,8 @@
-from . custom_params import Query
+from . custom_params import Query, CustomTranscodingParams
 from . const import *
 import time
+import json
+from . utils import is_json, rm_key_if_null
 
 
 
@@ -17,6 +19,74 @@ def __init__(self, access_token, connect, debug=False, **kwargs):
 
 
 
+  def start(self, profiles, video_url, **kwargs):
+    """Creating task and starting encode
+
+      :param profiles: String or List object. Profile uuid
+      :param transfer_method: String. Transfer method uuid
+      :param video_url: String. Url of source video
+      :param payload: String.
+      :return: None
+
+    """
+    if not self.error:
+      self._create_task(1)
+      data = self._prepare_data(profiles, video_url, **kwargs)
+
+      if not self.error and self.task_token:
+        self._start_encode('start_encode', data)
+
+
+  def custom_start(self, data,  **kwargs):
+    """Creating task and starting encode
+
+          :param query: JSON object for query param. For examples: https://docs.qencode.com
+          :param payload: String.
+          :return: None
+
+    """
+    if data is None:
+      self.error = True
+      self.message = 'Params is required'
+      
+    if not self.error:
+      self._create_task(1)
+
+    if not self.error:
+      data = self._prepare_data_custom(self._prepare_query(data), **kwargs)
+
+    if not self.error and self.task_token:
+      self._start_encode('start_encode2', data)
+
+
+  def status(self):
+    return self._status()
+
+  def main_status(self):
+    return self._status2()
+
+  def progress_changed(self, callback, *args, **kwargs):
+    while 1:
+      status = self._status()
+      if status['error']:
+        return callback(status, *args, **kwargs)
+      callback(status, *args, **kwargs)
+      if status.get('status') in COMPLETED_STATUS:
+        break
+      time.sleep(SLEEP_REGULAR)
+
+
+  def task_completed(self, callback, *args, **kwargs):
+    while 1:
+      status = self._status()
+      if status['error']:
+        return callback(status, *args, **kwargs)
+      if status.get('status') in COMPLETED_STATUS:
+        return callback(status, *args, **kwargs)
+      if status.get('status') in COMPLETED_STATUS:
+        break
+      time.sleep(SLEEP_REGULAR)
+
   def _prepare_data(self, profiles, video_url, **kwargs):
     data = dict(
       task_token=self.task_token,
@@ -27,7 +97,30 @@ def _prepare_data(self, profiles, video_url, **kwargs):
       data.update(kwargs)
     return data
 
-  def _prepare_data2(self, query_json, **kwargs):
+  def _prepare_query(self, params):    
+    if isinstance(params, CustomTranscodingParams):
+      query_obj = Query()
+      query_obj.params = params
+      query_obj.validate_params()
+      if query_obj.error:
+        self.error = query_obj.error
+        self.message = query_obj.message
+      query_obj.prepare_params()
+      if query_obj.error:
+        self.error = query_obj.error
+        self.message = query_obj.message
+      return query_obj.query
+    
+    if isinstance(params, dict):
+      query = rm_key_if_null(params)      
+      return json.dumps(query)
+    
+    if isinstance(params, str):
+      if is_json(params):
+        query = rm_key_if_null(params)
+        return query
+
+  def _prepare_data_custom(self, query_json, **kwargs):
     data = dict(
       task_token=self.task_token,
       query=query_json
@@ -82,90 +175,3 @@ def _status2(self):
     else:
       return response
 
-
-
-
-  def start(self, profiles, video_url, **kwargs):
-    """Creating task and starting encode
-
-      :param profiles: String or List object. Profile uuid
-      :param transfer_method: String. Transfer method uuid
-      :param video_url: String. Url of source video
-      :param payload: String.
-      :return: None
-
-    """
-    if not self.error:
-      self._create_task(1)
-      data = self._prepare_data(profiles, video_url, **kwargs)
-
-      if not self.error and self.task_token:
-        self._start_encode('start_encode', data)
-
-
-  def custom_start(self, params,  **kwargs):
-    """Creating task and starting encode
-
-          :param query: JSON object for query param. For examples: https://docs.qencode.com
-          :param payload: String.
-          :return: None
-
-    """
-    query_obj = Query()
-    query_obj.params = params
-    query_obj.validate_params()
-    if query_obj.error:
-      self.error = query_obj.error
-      self.message = query_obj.message
-      return
-
-    query_obj.prepare_params()
-    if query_obj.error:
-      self.error = query_obj.error
-      self.message = query_obj.message
-
-    if not self.error:
-      self._create_task(1)
-      data = self._prepare_data2(query_obj.query, **kwargs)
-
-      if not self.error and self.task_token:
-        self._start_encode('start_encode2', data)
-
-
-  def status(self):
-    """Getting status of encode from master-server.
-        real time updating.
-
-            :return: JSON object:
-                {
-                  'status' : 'encoding', 'percent': '50.90'  'error': 0 ...
-                }
-
-        """
-    return self._status()
-
-  def main_status(self):
-    return self._status2()
-
-  def progress_changed(self, callback, *args, **kwargs):
-    while 1:
-      status = self._status()
-      if status['error']:
-        return callback(status, *args, **kwargs)
-      callback(status, *args, **kwargs)
-      if status.get('status') in COMPLETED_STATUS:
-        break
-      time.sleep(SLEEP_REGULAR)
-
-
-  def task_completed(self, callback, *args, **kwargs):
-    while 1:
-      status = self._status()
-      if status['error']:
-        return callback(status, *args, **kwargs)
-      if status.get('status') in COMPLETED_STATUS:
-        return callback(status, *args, **kwargs)
-      if status.get('status') in COMPLETED_STATUS:
-        break
-      time.sleep(SLEEP_REGULAR)
-