onvif-python 0.1.8__tar.gz → 0.1.9__tar.gz

{onvif_python-0.1.8/onvif_python.egg-info → onvif_python-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.1.8
+Version: 0.1.9
 Summary: A modern Python library for ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -47,7 +47,7 @@ Dynamic: license-file
 	
 [![Codacy grade](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?label=Code%20Quality&logo=codacy)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nirsimetri/onvif-python)
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.8-orange?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.9-orange?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=Downloads&color=red)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 <br>
 [![Build](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml)
@@ -254,7 +254,7 @@ usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password
              [--health-check-interval HEALTH_CHECK_INTERVAL] [--version]
              [service] [method] [params ...]
 
-ONVIF Terminal Client — v0.1.8
+ONVIF Terminal Client — v0.1.9
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -318,7 +318,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell — v0.1.8
+ONVIF Interactive Shell — v0.1.9
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:
@@ -863,6 +863,7 @@ Below is a list of ONVIF services implemented and supported by this library, alo
 | Access Rules           | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AccessRules.xml)           | [accessrules.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/accessrules/wsdl/accessrules.wsdl)           | -                                      | ✅ Complete |
 | Action Engine          | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/ActionEngine.xml)          | [actionengine.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/actionengine.wsdl)          | -                                      | ✅ Complete |
 | Analytics              | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Analytics.xml)             | [analytics.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/wsdl/analytics.wsdl)             | [rules.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/rules.xsd) <br> [humanbody.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/humanbody.xsd) <br> [humanface.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/humanface.xsd) | ✅ Complete |
+| Analytics Device       | [Document](https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalyticsDevice-Service-Spec-v211.pdf) | [analyticsdevice.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/analyticsdevice.wsdl)             | - | ✅ Complete |
 | Application Management | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AppMgmt.xml)               | [appmgmt.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/appmgmt/wsdl/appmgmt.wsdl)               | -                                     | ✅ Complete |
 | Authentication Behavior| [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AuthenticationBehavior.xml) | [authenticationbehavior.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl) | -                                     | ✅ Complete |
 | Cloud Integration      | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/CloudIntegration.xml)      | [cloudintegration.yaml](https://developer.onvif.org/pub/specs/branches/development/doc/yaml.php?yaml=cloudintegration.yaml)      | -                                     | ❌ Not yet |
@@ -1023,6 +1024,7 @@ This project is an **independent open-source implementation** of the [ONVIF](htt
 - Use of the ONVIF trademark in this repository is solely nominative and does not imply any partnership, certification, or official status.
 - This project includes WSDL/XSD/HTML files from the official ONVIF specifications.
 - These files are © ONVIF and are redistributed here for interoperability purposes.
+- The WSDL files in the [`wsdl/`](./onvif/wsdl) folder are distributed under the ONVIF Contributor License Agreement and Apache License 2.0. See [`LICENSE.md`](./onvif/wsdl/LICENSE.md) for details.
 - All rights to the ONVIF specifications are reserved by ONVIF.
 
 If you require certified ONVIF-compliant devices or clients, please refer to the official [ONVIF conformant product list](https://www.onvif.org/conformant-products/). For authoritative reference and the latest official ONVIF specifications, please consult the [ONVIF Official Specifications](https://www.onvif.org/profiles/specifications/specification-history/).

{onvif_python-0.1.8 → onvif_python-0.1.9}/README.md

@@ -4,7 +4,7 @@
 	
 [![Codacy grade](https://img.shields.io/codacy/grade/bff08a94e4d447b690cea49c6594826d?label=Code%20Quality&logo=codacy)](https://app.codacy.com/gh/nirsimetri/onvif-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/nirsimetri/onvif-python)
-[![PyPI](https://img.shields.io/badge/PyPI-0.1.8-orange?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.9-orange?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=Downloads&color=red)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 <br>
 [![Build](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/nirsimetri/onvif-python/actions/workflows/python-app.yml)
@@ -211,7 +211,7 @@ usage: onvif [-h] [--host HOST] [--port PORT] [--username USERNAME] [--password
              [--health-check-interval HEALTH_CHECK_INTERVAL] [--version]
              [service] [method] [params ...]
 
-ONVIF Terminal Client — v0.1.8
+ONVIF Terminal Client — v0.1.9
 https://github.com/nirsimetri/onvif-python
 
 positional arguments:
@@ -275,7 +275,7 @@ Examples:
 <summary><b>2. Interactive Shell</b></summary> 
 
 ```bash
-ONVIF Interactive Shell — v0.1.8
+ONVIF Interactive Shell — v0.1.9
 https://github.com/nirsimetri/onvif-python
 
 Basic Commands:
@@ -820,6 +820,7 @@ Below is a list of ONVIF services implemented and supported by this library, alo
 | Access Rules           | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AccessRules.xml)           | [accessrules.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/accessrules/wsdl/accessrules.wsdl)           | -                                      | ✅ Complete |
 | Action Engine          | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/ActionEngine.xml)          | [actionengine.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/actionengine.wsdl)          | -                                      | ✅ Complete |
 | Analytics              | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/Analytics.xml)             | [analytics.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/wsdl/analytics.wsdl)             | [rules.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/rules.xsd) <br> [humanbody.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/humanbody.xsd) <br> [humanface.xsd](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver20/analytics/humanface.xsd) | ✅ Complete |
+| Analytics Device       | [Document](https://www.onvif.org/specs/srv/analytics/ONVIF-VideoAnalyticsDevice-Service-Spec-v211.pdf) | [analyticsdevice.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/analyticsdevice.wsdl)             | - | ✅ Complete |
 | Application Management | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AppMgmt.xml)               | [appmgmt.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/appmgmt/wsdl/appmgmt.wsdl)               | -                                     | ✅ Complete |
 | Authentication Behavior| [Document](https://developer.onvif.org/pub/specs/branches/development/doc/AuthenticationBehavior.xml) | [authenticationbehavior.wsdl](https://developer.onvif.org/pub/specs/branches/development/wsdl/ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl) | -                                     | ✅ Complete |
 | Cloud Integration      | [Document](https://developer.onvif.org/pub/specs/branches/development/doc/CloudIntegration.xml)      | [cloudintegration.yaml](https://developer.onvif.org/pub/specs/branches/development/doc/yaml.php?yaml=cloudintegration.yaml)      | -                                     | ❌ Not yet |
@@ -980,6 +981,7 @@ This project is an **independent open-source implementation** of the [ONVIF](htt
 - Use of the ONVIF trademark in this repository is solely nominative and does not imply any partnership, certification, or official status.
 - This project includes WSDL/XSD/HTML files from the official ONVIF specifications.
 - These files are © ONVIF and are redistributed here for interoperability purposes.
+- The WSDL files in the [`wsdl/`](./onvif/wsdl) folder are distributed under the ONVIF Contributor License Agreement and Apache License 2.0. See [`LICENSE.md`](./onvif/wsdl/LICENSE.md) for details.
 - All rights to the ONVIF specifications are reserved by ONVIF.
 
 If you require certified ONVIF-compliant devices or clients, please refer to the official [ONVIF conformant product list](https://www.onvif.org/conformant-products/). For authoritative reference and the latest official ONVIF specifications, please consult the [ONVIF Official Specifications](https://www.onvif.org/profiles/specifications/specification-history/).

{onvif_python-0.1.8 → onvif_python-0.1.9}/onvif/cli/interactive.py

@@ -173,6 +173,9 @@ class InteractiveShell(cmd.Cmd):
         if hasattr(args, "no_patch") and args.no_patch:
             options_info.append(f"  ZeepPatcher   : {colorize('Disabled', 'red')}")
 
+        if hasattr(args, "wsdl") and args.wsdl:
+            options_info.append(f"  Custom WSDL   : {colorize(args.wsdl, 'yellow')}")
+
         if (
             hasattr(args, "health_check_interval") and args.health_check_interval != 10
         ):  # 10 is default
@@ -191,7 +194,7 @@ class InteractiveShell(cmd.Cmd):
             "  / __ \\/ | / / |  / /  _/ ____/",
             " / / / /  |/ /| | / // // /_    ",
             "/ /_/ / /|  / | |/ // // __/    ",
-            "\\____/_/ |_/  |___/___/_/  v0.1.8",
+            "\\____/_/ |_/  |___/___/_/  v0.1.9",
             "                                ",
         ]
 
@@ -1268,6 +1271,11 @@ class InteractiveShell(cmd.Cmd):
         if hasattr(self.args, "no_patch") and self.args.no_patch:
             options_info.append(f"  ZeepPatcher   : {colorize('Disabled', 'red')}")
 
+        if hasattr(self.args, "wsdl") and self.args.wsdl:
+            options_info.append(
+                f"  Custom WSDL   : {colorize(self.args.wsdl, 'yellow')}"
+            )
+
         if (
             hasattr(self.args, "health_check_interval")
             and self.args.health_check_interval != 10
@@ -1385,7 +1393,7 @@ class InteractiveShell(cmd.Cmd):
             super().do_help(line)
         else:
             help_text = f"""
-{colorize('ONVIF Interactive Shell — v0.1.8', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
+{colorize('ONVIF Interactive Shell — v0.1.9', 'cyan')}\n{colorize('https://github.com/nirsimetri/onvif-python', 'white')}
 
 {colorize('Basic Commands:', 'yellow')}
   capabilities, caps       - Show device capabilities

{onvif_python-0.1.8 → onvif_python-0.1.9}/onvif/cli/main.py

@@ -17,7 +17,7 @@ def create_parser():
     """Create argument parser for ONVIF CLI"""
     parser = argparse.ArgumentParser(
         prog="onvif",
-        description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v0.1.8\nhttps://github.com/nirsimetri/onvif-python",
+        description=f"{colorize('ONVIF Terminal Client', 'yellow')} — v0.1.9\nhttps://github.com/nirsimetri/onvif-python",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog=f"""
 Examples:
@@ -149,7 +149,7 @@ def main():
 
     # Show ONVIF CLI version
     if args.version:
-        print(colorize("0.1.8", "yellow"))
+        print(colorize("0.1.9", "yellow"))
         sys.exit(0)
 
     # Validate arguments early (before discovery)

{onvif_python-0.1.8 → onvif_python-0.1.9}/onvif/operator.py

@@ -191,3 +191,104 @@ class ONVIFOperator:
         except Exception as e:
             # logging.error(f"ONVIF call error in {method}: {e}")
             raise ONVIFOperationException(operation=method, original_exception=e)
+
+    def create_type(self, type_name: str):
+        """
+        Create a type instance from WSDL schema for the given type name.
+
+        Recursively initializes nested complex types so that fields like TimeZone, DateTime,
+        Date, and Time are properly instantiated as objects rather than None.
+
+        Args:
+            type_name (str): Name of the type to create (e.g., 'SetHostname', 'SetIPAddressFilter')
+
+        Returns:
+            Type instance that can be populated with data
+
+        Raises:
+            AttributeError: If type not found in WSDL schema
+        """
+        # Method 1: Try to get element from WSDL (works for operation parameters)
+        # Common namespace prefixes for ONVIF services
+        namespaces_to_try = [
+            "ns0",  # Default namespace
+            "tt",  # Common types (User, NetworkInterface, etc.)
+        ]
+
+        # Try to get element with namespace prefix
+        for ns in namespaces_to_try:
+            try:
+                element = self.client.get_element(f"{ns}:{type_name}")
+                instance = element()
+                return self._initialize_nested_types(instance)
+            except Exception:
+                continue
+
+        # Method 2: Try without namespace prefix
+        try:
+            element = self.client.get_element(type_name)
+            instance = element()
+            return self._initialize_nested_types(instance)
+        except Exception:
+            pass
+
+        # Method 3: Try to get type from schema (for complex types)
+        try:
+            for ns in namespaces_to_try:
+                try:
+                    type_obj = self.client.get_type(f"{ns}:{type_name}")
+                    instance = type_obj()
+                    return self._initialize_nested_types(instance)
+                except Exception:
+                    continue
+
+            # Try without namespace
+            type_obj = self.client.get_type(type_name)
+            instance = type_obj()
+            return self._initialize_nested_types(instance)
+        except Exception:
+            pass
+
+        raise AttributeError(f"Type '{type_name}' not found in WSDL schema.")
+
+    def _initialize_nested_types(self, instance):
+        """
+        Recursively initialize nested complex types in a Zeep object.
+
+        This ensures that fields like TimeZone, DateTime, Date, and Time are
+        properly instantiated as objects rather than None values.
+
+        Args:
+            instance: A Zeep object instance to initialize
+
+        Returns:
+            The instance with all nested complex types initialized
+        """
+        try:
+            # Get the XSD type from the instance's class
+            if hasattr(instance.__class__, "_xsd_type"):
+                xsd_type = instance.__class__._xsd_type
+
+                # Iterate through elements defined in the XSD type
+                if hasattr(xsd_type, "elements"):
+                    for element_name, element_obj in xsd_type.elements:
+                        current_value = getattr(instance, element_name, None)
+
+                        # Only initialize if the value is None and the element has a type
+                        if current_value is None and hasattr(element_obj, "type"):
+                            element_type = element_obj.type
+
+                            # Check if this is a complex type (has elements)
+                            if hasattr(element_type, "elements"):
+                                # Complex type - instantiate it and recursively initialize
+                                nested_instance = element_type()
+                                nested_instance = self._initialize_nested_types(
+                                    nested_instance
+                                )
+                                setattr(instance, element_name, nested_instance)
+        except Exception:
+            # If anything goes wrong during nested initialization, just return the instance
+            # The important thing is that the top-level object is created
+            pass
+
+        return instance

{onvif_python-0.1.8 → onvif_python-0.1.9}/onvif/services/analyticsdevice.py

@@ -48,10 +48,10 @@ class AnalyticsDevice(ONVIFService):
             "CreateAnalyticsEngineControl", Configuration=Configuration
         )
 
-    def SetAnalyticsEngineControl(self, SetAnalyticsEngineControl, ForcePersistence):
+    def SetAnalyticsEngineControl(self, Configuration, ForcePersistence):
         return self.operator.call(
             "SetAnalyticsEngineControl",
-            SetAnalyticsEngineControl=SetAnalyticsEngineControl,
+            Configuration=Configuration,
             ForcePersistence=ForcePersistence,
         )
 
@@ -78,11 +78,11 @@ class AnalyticsDevice(ONVIFService):
             ForcePersistence=ForcePersistence,
         )
 
-    def SetAnalyticsEngineInput(self, Configuration, InputToken):
+    def SetAnalyticsEngineInput(self, Configuration, ForcePersistence):
         return self.operator.call(
             "SetAnalyticsEngineInput",
             Configuration=Configuration,
-            InputToken=InputToken,
+            ForcePersistence=ForcePersistence,
         )
 
     def GetAnalyticsEngineInput(self, ConfigurationToken):

{onvif_python-0.1.8 → onvif_python-0.1.9}/onvif/utils/service.py

@@ -3,6 +3,14 @@
 from .exceptions import ONVIFOperationException
 
 
+def _is_zeep_object(obj):
+    """Check if an object is a Zeep-generated object.
+
+    Zeep objects have the _xsd_type attribute which is the XSD type definition.
+    """
+    return hasattr(obj, "_xsd_type")
+
+
 class ONVIFService:
     """Base class for all ONVIF service implementations.
 
@@ -29,19 +37,6 @@ class ONVIFService:
         3. Is not a private method (doesn't start with underscore)
         4. Is not an internal attribute (like 'operator')
 
-    ONVIF operations that will be wrapped:
-        ✓ GetDeviceInformation()
-        ✓ GetProfiles()
-        ✓ ContinuousMove()
-        ✓ CreatePullPointSubscription()
-        ✓ GetImagingSettings()
-
-    Methods that will NOT be wrapped:
-        ✗ _internal_method()  (starts with underscore)
-        ✗ helper_function()   (starts with lowercase)
-        ✗ operator            (internal attribute)
-        ✗ non_callable_attr   (not a method)
-
     Benefits:
         1. **DRY Principle**: No need to repeat error handling in every method
         2. **Consistency**: All ONVIF operations behave the same way
@@ -94,9 +89,20 @@ class ONVIFService:
         if not name[0].isupper():
             return attr
 
-        # Wrap ONVIF methods with error handling
+        # Wrap ONVIF methods with error handling and Zeep object conversion
         def wrapped_method(*args, **kwargs):
             try:
+                # If called with 1 positional arg that is a Zeep object and no kwargs,
+                # convert the object's fields to kwargs instead of passing it as positional arg
+                if len(args) == 1 and not kwargs and _is_zeep_object(args[0]):
+                    params_obj = args[0]
+                    # Extract fields from Zeep object using its XSD type elements
+                    if hasattr(params_obj._xsd_type, "elements"):
+                        kwargs = {}
+                        for elem_name, elem_obj in params_obj._xsd_type.elements:
+                            kwargs[elem_name] = getattr(params_obj, elem_name)
+                        return attr(**kwargs)
+
                 return attr(*args, **kwargs)
             except ONVIFOperationException:
                 # Re-raise ONVIF exceptions as-is
@@ -106,3 +112,45 @@ class ONVIFService:
                 raise ONVIFOperationException(name, e)
 
         return wrapped_method
+
+    def type(self, type_name: str):
+        """
+        Create and return an instance of the specified ONVIF type.
+
+        Args:
+            type_name (str): Name of the type to create (e.g., 'SetHostname', 'SetIPAddressFilter')
+
+        Returns:
+            Type instance that can be populated with data
+
+        Raises:
+            ONVIFOperationException: If type creation fails
+
+        Example:
+            device = client.devicemgmt()
+
+            newuser = device.type('CreateUsers')
+            newuser.User.append({"Username": 'new_user', "Password": 'new_password', "UserLevel": 'User'})
+            device.CreateUsers(newuser)
+
+            hostname = device.type('SetHostname')
+            hostname.Name = 'NewHostname'
+            device.SetHostname(hostname)
+
+            time_params = device.type('SetSystemDateAndTime')
+            time_params.DateTimeType = 'NTP'
+            time_params.DaylightSavings = True
+            time_params.TimeZone.TZ = 'UTC+02:00'
+            now = datetime.now()
+            time_params.UTCDateTime.Date.Year = now.year
+            time_params.UTCDateTime.Date.Month = now.month
+            time_params.UTCDateTime.Date.Day = now.day
+            time_params.UTCDateTime.Time.Hour = now.hour
+            time_params.UTCDateTime.Time.Minute = now.minute
+            time_params.UTCDateTime.Time.Second = now.second
+            device.SetSystemDateAndTime(time_params)
+        """
+        try:
+            return self.operator.create_type(type_name)
+        except Exception as e:
+            raise ONVIFOperationException(f"type({type_name})", e)