Merge branch 'zeep' into pr/async-services

Author: FalkTannhaeuser

onvif/client.py

@@ -1,39 +1,40 @@
 from __future__ import print_function, division
 __version__ = '0.0.1'
+import datetime as dt
+import logging
 import os.path
 from threading import Thread, RLock
 
-import logging
-logger = logging.getLogger('onvif')
-logging.basicConfig(level=logging.INFO)
-logging.getLogger('zeep.client').setLevel(logging.CRITICAL)
-
 from zeep.client import Client, CachingClient, Settings
 from zeep.wsse.username import UsernameToken
 import zeep.helpers
 
 from onvif.exceptions import ONVIFError
 from onvif.definition import SERVICES
-import datetime as dt
+
+logger = logging.getLogger('onvif')
+logging.basicConfig(level=logging.INFO)
+logging.getLogger('zeep.client').setLevel(logging.CRITICAL)
+
+
 # Ensure methods to raise an ONVIFError Exception
 # when some thing was wrong
 def safe_func(func):
     def wrapped(*args, **kwargs):
         try:
             return func(*args, **kwargs)
         except Exception as err:
-            #print('Ouuups: err =', err, ', func =', func, ', args =', args, ', kwargs =', kwargs)
             raise ONVIFError(err)
     return wrapped
 
 
 class UsernameDigestTokenDtDiff(UsernameToken):
-    '''
+    """
     UsernameDigestToken class, with a time offset parameter that can be adjusted;
     This allows authentication on cameras without being time synchronized.
     Please note that using NTP on both end is the recommended solution,
     this should only be used in "safe" environments.
-    '''
+    """
     def __init__(self, user, passw, dt_diff=None, **kwargs):
         super().__init__(user, passw, **kwargs)
         self.dt_diff = dt_diff  # Date/time difference in datetime.timedelta
@@ -42,17 +43,15 @@ def apply(self, envelope, headers):
         old_created = self.created
         if self.created is None:
             self.created = dt.datetime.utcnow()
-        #print('UsernameDigestTokenDtDiff.created: old = %s (type = %s), dt_diff = %s (type = %s)' % (self.created, type(self.created), self.dt_diff, type(self.dt_diff)), end='')
         if self.dt_diff is not None:
             self.created += self.dt_diff
-        #print('   new = %s' % self.created)
         result = super().apply(envelope, headers)
         self.created = old_created
         return result
 
 
 class ONVIFService(object):
-    '''
+    """
     Python Implemention for ONVIF Service.
     Services List:
         DeviceMgmt DeviceIO Event AnalyticsDevice Display Imaging Media
@@ -80,12 +79,12 @@ class ONVIFService(object):
         params = device_service.create_type('SetHostname')
         params.Hostname = 'NewHostName'
         device_service.SetHostname(params)
-    '''
+    """
 
     @safe_func
     def __init__(self, xaddr, user, passwd, url,
                  encrypt=True, daemon=False, zeep_client=None, no_cache=False,
-                 portType=None, dt_diff=None, binding_name='', transport=None):
+                 dt_diff=None, binding_name='', transport=None):
         if not os.path.isfile(url):
             raise ONVIFError('%s doesn`t exist!' % url)
 
@@ -94,7 +93,6 @@ def __init__(self, xaddr, user, passwd, url,
         wsse = UsernameDigestTokenDtDiff(user, passwd, dt_diff=dt_diff, use_digest=encrypt)
         # Create soap client
         if not zeep_client:
-            #print(self.url, self.xaddr)
             ClientType = Client if no_cache else CachingClient
             settings = Settings()
             settings.strict = False
@@ -139,7 +137,6 @@ def call(params=None, callback=None):
                 try:
                     ret = func(**params)
                 except TypeError:
-                    #print('### func =', func, '### params =', params, '### type(params) =', type(params))
                     ret = func(params)
                 if callable(callback):
                     callback(ret)
@@ -154,23 +151,23 @@ def call(params=None, callback=None):
         return wrapped
 
     def __getattr__(self, name):
-        '''
+        """
         Call the real onvif Service operations,
         See the official wsdl definition for the
         APIs detail(API name, request parameters,
         response parameters, parameter types, etc...)
-        '''
-        builtin =  name.startswith('__') and name.endswith('__')
+        """
+        builtin = name.startswith('__') and name.endswith('__')
         if builtin:
             return self.__dict__[name]
         else:
             return self.service_wrapper(getattr(self.ws_client, name))
 
 
 class ONVIFCamera(object):
-    '''
-    Python Implemention ONVIF compliant device
-    This class integrates onvif services
+    """
+    Python Implementation of an ONVIF compliant device.
+    This class integrates ONVIF services
 
     adjust_time parameter allows authentication on cameras without being time synchronized.
     Please note that using NTP on both end is the recommended solution,
@@ -183,18 +180,20 @@ class ONVIFCamera(object):
     >>> media_service = mycam.create_media_service()
     >>> ptz_service = mycam.create_ptz_service()
     # Get PTZ Configuration:
-    >>> mycam.ptz.GetConfiguration()
-    # Another way:
     >>> ptz_service.GetConfiguration()
-    '''
+    """
 
     # Class-level variables
     services_template = {'devicemgmt': None, 'ptz': None, 'media': None,
-                         'imaging': None, 'events': None, 'analytics': None }
+                         'imaging': None, 'events': None, 'analytics': None}
     use_services_template = {'devicemgmt': True, 'ptz': True, 'media': True,
-                         'imaging': True, 'events': True, 'analytics': True }
-    def __init__(self, host, port ,user, passwd, wsdl_dir=os.path.join(os.path.dirname(os.path.dirname(__file__)), "wsdl"),
-                 encrypt=True, daemon=False, no_cache=False, adjust_time=False, transport=None):
+                             'imaging': True, 'events': True, 'analytics': True}
+
+    def __init__(self, host, port, user, passwd,
+                 wsdl_dir=os.path.join(os.path.dirname(os.path.dirname(__file__)),
+                                       "wsdl"),
+                 encrypt=True, daemon=False, no_cache=False, adjust_time=False,
+                 transport=None):
         os.environ.pop('http_proxy', None)
         os.environ.pop('https_proxy', None)
         self.host = host
@@ -209,7 +208,7 @@ def __init__(self, host, port ,user, passwd, wsdl_dir=os.path.join(os.path.dirna
         self.transport = transport
 
         # Active service client container
-        self.services = { }
+        self.services = {}
         self.services_lock = RLock()
 
         # Set xaddrs
@@ -220,16 +219,16 @@ def __init__(self, host, port ,user, passwd, wsdl_dir=os.path.join(os.path.dirna
     def update_xaddrs(self):
         # Establish devicemgmt service first
         self.dt_diff = None
-        self.devicemgmt  = self.create_devicemgmt_service()
-        if self.adjust_time :
+        self.devicemgmt = self.create_devicemgmt_service()
+        if self.adjust_time:
             cdate = self.devicemgmt.GetSystemDateAndTime().UTCDateTime
-            cam_date = dt.datetime(cdate.Date.Year, cdate.Date.Month, cdate.Date.Day, cdate.Time.Hour, cdate.Time.Minute, cdate.Time.Second)
+            cam_date = dt.datetime(cdate.Date.Year, cdate.Date.Month, cdate.Date.Day,
+                                   cdate.Time.Hour, cdate.Time.Minute, cdate.Time.Second)
             self.dt_diff = cam_date - dt.datetime.utcnow()
             self.devicemgmt.dt_diff = self.dt_diff
-            #self.devicemgmt.set_wsse()
-            self.devicemgmt  = self.create_devicemgmt_service()
+            self.devicemgmt = self.create_devicemgmt_service()
         # Get XAddr of services on the device
-        self.xaddrs = { }
+        self.xaddrs = {}
         capabilities = self.devicemgmt.GetCapabilities({'Category': 'All'})
         for name in capabilities:
             capability = capabilities[name]
@@ -243,8 +242,9 @@ def update_xaddrs(self):
         with self.services_lock:
             try:
                 self.event = self.create_events_service()
-                self.xaddrs['http://www.onvif.org/ver10/events/wsdl/PullPointSubscription'] = self.event.CreatePullPointSubscription().SubscriptionReference.Address._value_1
-            except:
+                self.xaddrs['http://www.onvif.org/ver10/events/wsdl/PullPointSubscription'] = \
+                    self.event.CreatePullPointSubscription().SubscriptionReference.Address._value_1
+            except Exception:
                 pass
 
     def update_url(self, host=None, port=None):
@@ -268,14 +268,13 @@ def update_url(self, host=None, port=None):
                 self.services[sname].ws_client.set_options(location=xaddr)
 
     def get_service(self, name, create=True):
-        service = None
         service = getattr(self, name.lower(), None)
         if not service and create:
             return getattr(self, 'create_%s_service' % name.lower())()
         return service
 
     def get_definition(self, name, portType=None):
-        '''Returns xaddr and wsdl of specified service'''
+        """Returns xaddr and wsdl of specified service"""
         # Check if the service is supported
         if name not in SERVICES:
             raise ONVIFError('Unknown service %s' % name)
@@ -301,12 +300,21 @@ def get_definition(self, name, portType=None):
         # Get other XAddr
         xaddr = self.xaddrs.get(ns)
         if not xaddr:
-            raise ONVIFError('Device doesn`t support service: %s' % name)
+            raise ONVIFError("Device doesn't support service: %s" % name)
 
         return xaddr, wsdlpath, binding_name
 
-    def create_onvif_service(self, name, from_template=True, portType=None, transport=None):
-        '''Create ONVIF service client'''
+    def create_onvif_service(self, name, portType=None, transport=None):
+        """
+        Create ONVIF service client.
+
+        :param name: service name, should be present as a key within
+        the `SERVICES` dictionary declared within the `onvif.definition` module
+        :param portType:
+        :param transport:
+        :return:
+        """
+        """Create ONVIF service client"""
 
         name = name.lower()
         xaddr, wsdl_file, binding_name = self.get_definition(name, portType)
@@ -318,7 +326,6 @@ def create_onvif_service(self, name, from_template=True, portType=None, transpor
             service = ONVIFService(xaddr, self.user, self.passwd,
                                    wsdl_file, self.encrypt,
                                    self.daemon, no_cache=self.no_cache,
-                                   portType=portType,
                                    dt_diff=self.dt_diff,
                                    binding_name=binding_name,
                                    transport=transport)
@@ -331,41 +338,47 @@ def create_onvif_service(self, name, from_template=True, portType=None, transpor
 
         return service
 
-    def create_devicemgmt_service(self, from_template=True, transport=None):
+    def create_devicemgmt_service(self, transport=None):
         # The entry point for devicemgmt service is fixed.
-        return self.create_onvif_service('devicemgmt', from_template, transport=transport)
+        return self.create_onvif_service('devicemgmt', transport=transport)
+
+    def create_media_service(self, transport=None):
+        return self.create_onvif_service('media', transport=transport)
+
+    def create_ptz_service(self, transport=None):
+        return self.create_onvif_service('ptz', transport=transport)
 
-    def create_media_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('media', from_template, transport=transport)
+    def create_imaging_service(self, transport=None):
+        return self.create_onvif_service('imaging', transport=transport)
 
-    def create_ptz_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('ptz', from_template, transport=transport)
+    def create_deviceio_service(self, transport=None):
+        return self.create_onvif_service('deviceio', transport=transport)
 
-    def create_imaging_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('imaging', from_template, transport=transport)
+    def create_events_service(self, transport=None):
+        return self.create_onvif_service('events', transport=transport)
 
-    def create_deviceio_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('deviceio', from_template, transport=transport)
+    def create_analytics_service(self, transport=None):
+        return self.create_onvif_service('analytics', transport=transport)
 
-    def create_events_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('events', from_template, transport=transport)
+    def create_recording_service(self, transport=None):
+        return self.create_onvif_service('recording', transport=transport)
 
-    def create_analytics_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('analytics', from_template, transport=transport)
+    def create_search_service(self, transport=None):
+        return self.create_onvif_service('search', transport=transport)
 
-    def create_recording_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('recording', from_template, transport=transport)
+    def create_replay_service(self, transport=None):
+        return self.create_onvif_service('replay', transport=transport)
 
-    def create_search_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('search', from_template, transport=transport)
+    def create_pullpoint_service(self, transport=None):
+        return self.create_onvif_service('pullpoint',
+                                         portType='PullPointSubscription',
+                                         transport=transport)
 
-    def create_replay_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('replay', from_template, transport=transport)
+    def create_receiver_service(self, transport=None):
+        return self.create_onvif_service('receiver', transport=transport)
 
-    def create_pullpoint_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('pullpoint', from_template, 
-                                          portType='PullPointSubscription', 
-                                          transport=transport)
+    def create_notification_service(self, transport=None):
+        return self.create_onvif_service('notification', transport=transport)
 
-    def create_receiver_service(self, from_template=True, transport=None):
-        return self.create_onvif_service('receiver', from_template, transport=transport)
+    def create_subscription_service(self, transport=None):
+        return self.create_onvif_service('subscription', transport=transport)

onvif/definition.py

@@ -1,17 +1,19 @@
 SERVICES = {
         # Name                              namespace                           wsdl file                      binding name
-        'devicemgmt': {'ns': 'http://www.onvif.org/ver10/device/wsdl',    'wsdl': 'devicemgmt.wsdl', 'binding' : 'DeviceBinding'},
-        'media'     : {'ns': 'http://www.onvif.org/ver10/media/wsdl',     'wsdl': 'media.wsdl',      'binding' : 'MediaBinding'},
-        'ptz'       : {'ns': 'http://www.onvif.org/ver20/ptz/wsdl',       'wsdl': 'ptz.wsdl',        'binding' : 'PTZBinding'},
-        'imaging'   : {'ns': 'http://www.onvif.org/ver20/imaging/wsdl',   'wsdl': 'imaging.wsdl',    'binding' : 'ImagingBinding'},
-        'deviceio'  : {'ns': 'http://www.onvif.org/ver10/deviceIO/wsdl',  'wsdl': 'deviceio.wsdl',   'binding' : 'DeviceIOBinding'},
-        'events'    : {'ns': 'http://www.onvif.org/ver10/events/wsdl',    'wsdl': 'events.wsdl',     'binding' : 'EventBinding'},
-        'pullpoint' : {'ns': 'http://www.onvif.org/ver10/events/wsdl',    'wsdl': 'events.wsdl',     'binding' : 'PullPointSubscriptionBinding'},
-        'analytics' : {'ns': 'http://www.onvif.org/ver20/analytics/wsdl', 'wsdl': 'analytics.wsdl',  'binding' : 'AnalyticsEngineBinding'},
-        'recording' : {'ns': 'http://www.onvif.org/ver10/recording/wsdl', 'wsdl': 'recording.wsdl',  'binding' : 'RecordingBinding'},
-        'search'    : {'ns': 'http://www.onvif.org/ver10/search/wsdl',    'wsdl': 'search.wsdl',     'binding' : 'SearchBinding'},
-        'replay'    : {'ns': 'http://www.onvif.org/ver10/replay/wsdl',    'wsdl': 'replay.wsdl',     'binding' : 'ReplayBinding'},
-        'receiver'  : {'ns': 'http://www.onvif.org/ver10/receiver/wsdl',  'wsdl': 'receiver.wsdl',   'binding' : 'ReceiverBinding'},
+        'devicemgmt'   : {'ns': 'http://www.onvif.org/ver10/device/wsdl',    'wsdl': 'devicemgmt.wsdl', 'binding' : 'DeviceBinding'},
+        'media'        : {'ns': 'http://www.onvif.org/ver10/media/wsdl',     'wsdl': 'media.wsdl',      'binding' : 'MediaBinding'},
+        'ptz'          : {'ns': 'http://www.onvif.org/ver20/ptz/wsdl',       'wsdl': 'ptz.wsdl',        'binding' : 'PTZBinding'},
+        'imaging'      : {'ns': 'http://www.onvif.org/ver20/imaging/wsdl',   'wsdl': 'imaging.wsdl',    'binding' : 'ImagingBinding'},
+        'deviceio'     : {'ns': 'http://www.onvif.org/ver10/deviceIO/wsdl',  'wsdl': 'deviceio.wsdl',   'binding' : 'DeviceIOBinding'},
+        'events'       : {'ns': 'http://www.onvif.org/ver10/events/wsdl',    'wsdl': 'events.wsdl',     'binding' : 'EventBinding'},
+        'pullpoint'    : {'ns': 'http://www.onvif.org/ver10/events/wsdl',    'wsdl': 'events.wsdl',     'binding' : 'PullPointSubscriptionBinding'},
+        'notification' : {'ns': 'http://www.onvif.org/ver10/events/wsdl',    'wsdl': 'events.wsdl',     'binding' : 'NotificationProducerBinding'},
+        'subscription' : {'ns': 'http://www.onvif.org/ver10/events/wsdl',    'wsdl': 'events.wsdl',     'binding' : 'SubscriptionManagerBinding'},
+        'analytics'    : {'ns': 'http://www.onvif.org/ver20/analytics/wsdl', 'wsdl': 'analytics.wsdl',  'binding' : 'AnalyticsEngineBinding'},
+        'recording'    : {'ns': 'http://www.onvif.org/ver10/recording/wsdl', 'wsdl': 'recording.wsdl',  'binding' : 'RecordingBinding'},
+        'search'       : {'ns': 'http://www.onvif.org/ver10/search/wsdl',    'wsdl': 'search.wsdl',     'binding' : 'SearchBinding'},
+        'replay'       : {'ns': 'http://www.onvif.org/ver10/replay/wsdl',    'wsdl': 'replay.wsdl',     'binding' : 'ReplayBinding'},
+        'receiver'     : {'ns': 'http://www.onvif.org/ver10/receiver/wsdl',  'wsdl': 'receiver.wsdl',   'binding' : 'ReceiverBinding'},
         }
 
 #