onvif-python 0.0.9__tar.gz → 0.1.0__tar.gz

{onvif_python-0.0.9/onvif_python.egg-info → onvif_python-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onvif-python
-Version: 0.0.9
+Version: 0.1.0
 Summary: A comprehensive and developer-friendly Python library for working with ONVIF-compliant devices
 Author-email: Nirsimetri Technologies® <open@nirsimetri.com>
 Maintainer: Kaburagi
@@ -40,9 +40,9 @@ Dynamic: license-file
 
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-file)
 [![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.0.9-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.1.0-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.0.9-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.0-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=PyPI%20Downloads)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 
 **This project provides a comprehensive and developer-friendly Python library for working with ONVIF-compliant devices.** It is designed to be reliable, easy to integrate, and flexible enough to support a wide range of ONVIF profiles and services.  
@@ -93,7 +93,14 @@ Create an instance of `ONVIFClient` by providing your device's IP address, port,
 ```python
 from onvif import ONVIFClient
 
+# Basic connection
 client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123")
+
+# With custom WSDL directory (optional)
+client = ONVIFClient(
+    "192.168.1.17", 8000, "admin", "admin123",
+    wsdl_dir="/path/to/custom/wsdl"  # Use custom WSDL files in this path
+)
 ```
 
 **2. Create Service Instance**
@@ -186,8 +193,9 @@ The `ONVIFClient` class provides various configuration options to customize the
 
 | Parameter | Type | Required | Default | Description |
 |-----------|------|----------|---------|-------------|
-| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening |
-| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses |
+| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening, applied at (>= [`v0.0.4`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.4)) |
+| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses, applied at (>= [`v0.0.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.6)) |
+| `wsdl_dir`    | `str`  | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`), applied at (>= [`v0.1.0`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.0)) |
 
 </details>
 
@@ -317,6 +325,33 @@ if client.xml_plugin:
 > - `save_to_file(request_file, response_file)` - Save XML to files
 > - `clear_history()` - Clear captured history
 
+**Custom WSDL Directory:**
+```python
+from onvif import ONVIFClient
+
+# Use custom WSDL files instead of built-in ones
+client = ONVIFClient(
+    "192.168.1.17", 
+    80, 
+    "admin", 
+    "password",
+    wsdl_dir="/path/to/custom/wsdl"  # Custom WSDL directory
+)
+
+# All services will automatically use custom WSDL files
+device = client.devicemgmt()
+media = client.media()
+ptz = client.ptz()
+
+# The custom WSDL directory should have a flat structure:
+# /path/to/custom/wsdl/
+# ├── devicemgmt.wsdl
+# ├── media.wsdl
+# ├── ptz.wsdl
+# ├── imaging.wsdl
+# └── ... (other WSDL files)
+```
+
 </details>
 
 <details>
@@ -336,7 +371,8 @@ client = ONVIFClient(
     use_https=True,             # Secure communication
     verify_ssl=True,            # Verify certificates (default)
     apply_patch=True,           # Enhanced parsing (default)
-    capture_xml=False           # Disable debug mode (default)
+    capture_xml=False,          # Disable debug mode (default)
+    wsdl_dir=None               # Use built-in WSDL files (default)
 )
 ```
 </details>
@@ -346,6 +382,7 @@ client = ONVIFClient(
 - **Authentication:** This library uses **WS-UsernameToken with Digest** authentication by default, which is the standard for ONVIF devices.
 - **Patching:** The `apply_patch=True` (default) enables custom zeep patching that improves `xsd:any` field parsing. This is recommended for better compatibility with ONVIF responses.
 - **XML Capture:** Only use `capture_xml=True` during development/debugging as it increases memory usage and may expose sensitive data in logs.
+- **Custom WSDL:** Use `wsdl_dir` parameter to specify a custom directory containing WSDL files. The directory should have a flat structure with WSDL files directly in the root (e.g., `/path/to/custom/wsdl/devicemgmt.wsdl`, `/path/to/custom/wsdl/media.wsdl`, etc.).
 - **Cache Location:** Disk cache (when using `CacheMode.DB` or `CacheMode.ALL`) is stored in `~/.onvif-python/onvif_zeep_cache.sqlite`.
 
 ## Service Discovery: Understanding Device Capabilities
@@ -592,10 +629,10 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
 
 ## Future Improvements (Stay tuned and star ⭐ this repo)
 
-- [x] Add debugging mode with raw xml on SOAP requests and responses. ([c258162](https://github.com/nirsimetri/onvif-python/commit/c258162))
-- [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.
-- [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
+- [x] ~~Add debugging mode with raw xml on SOAP requests and responses.~~ ([c258162](https://github.com/nirsimetri/onvif-python/commit/c258162))
+- [x] ~~Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` service.~~ ([65f2570](https://github.com/nirsimetri/onvif-python/commit/65f257092e4c9daa23dd0d00825ed38a45d23b70))
 - [ ] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.
+- [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
 - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata).
 - [ ] Integrate [xmltodict](https://github.com/martinblech/xmltodict) for simplified XML parsing and conversion.
 - [ ] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)).

{onvif_python-0.0.9 → onvif_python-0.1.0}/README.md

@@ -2,9 +2,9 @@
 
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/nirsimetri/onvif-python?tab=MIT-1-ov-file)
 [![DeepWiki](https://img.shields.io/badge/DeepWiki-AI%20Wiki-orange)](https://deepwiki.com/nirsimetri/onvif-python)
-[![Release](https://img.shields.io/badge/Release-v0.0.9-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
+[![Release](https://img.shields.io/badge/Release-v0.1.0-red?logo=archive)](https://github.com/nirsimetri/onvif-python/releases)
 <br>
-[![PyPI](https://img.shields.io/badge/PyPI-0.0.9-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
+[![PyPI](https://img.shields.io/badge/PyPI-0.1.0-yellow?logo=archive)](https://pypi.org/project/onvif-python/)
 [![Downloads](https://img.shields.io/pypi/dm/onvif-python?label=PyPI%20Downloads)](https://clickpy.clickhouse.com/dashboard/onvif-python)
 
 **This project provides a comprehensive and developer-friendly Python library for working with ONVIF-compliant devices.** It is designed to be reliable, easy to integrate, and flexible enough to support a wide range of ONVIF profiles and services.  
@@ -55,7 +55,14 @@ Create an instance of `ONVIFClient` by providing your device's IP address, port,
 ```python
 from onvif import ONVIFClient
 
+# Basic connection
 client = ONVIFClient("192.168.1.17", 8000, "admin", "admin123")
+
+# With custom WSDL directory (optional)
+client = ONVIFClient(
+    "192.168.1.17", 8000, "admin", "admin123",
+    wsdl_dir="/path/to/custom/wsdl"  # Use custom WSDL files in this path
+)
 ```
 
 **2. Create Service Instance**
@@ -148,8 +155,9 @@ The `ONVIFClient` class provides various configuration options to customize the
 
 | Parameter | Type | Required | Default | Description |
 |-----------|------|----------|---------|-------------|
-| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening |
-| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses |
+| `apply_patch` | `bool` | ❌ No | `True` | Enable zeep patching for better `xsd:any` field parsing and automatic flattening, applied at (>= [`v0.0.4`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.4)) |
+| `capture_xml` | `bool` | ❌ No | `False` | Enable XML capture plugin for debugging SOAP requests/responses, applied at (>= [`v0.0.6`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.0.6)) |
+| `wsdl_dir`    | `str`  | ❌ No | `None` | Custom WSDL directory path for using external WSDL files instead of built-in ones (e.g., `/path/to/custom/wsdl`), applied at (>= [`v0.1.0`](https://github.com/nirsimetri/onvif-python/releases/tag/v0.1.0)) |
 
 </details>
 
@@ -279,6 +287,33 @@ if client.xml_plugin:
 > - `save_to_file(request_file, response_file)` - Save XML to files
 > - `clear_history()` - Clear captured history
 
+**Custom WSDL Directory:**
+```python
+from onvif import ONVIFClient
+
+# Use custom WSDL files instead of built-in ones
+client = ONVIFClient(
+    "192.168.1.17", 
+    80, 
+    "admin", 
+    "password",
+    wsdl_dir="/path/to/custom/wsdl"  # Custom WSDL directory
+)
+
+# All services will automatically use custom WSDL files
+device = client.devicemgmt()
+media = client.media()
+ptz = client.ptz()
+
+# The custom WSDL directory should have a flat structure:
+# /path/to/custom/wsdl/
+# ├── devicemgmt.wsdl
+# ├── media.wsdl
+# ├── ptz.wsdl
+# ├── imaging.wsdl
+# └── ... (other WSDL files)
+```
+
 </details>
 
 <details>
@@ -298,7 +333,8 @@ client = ONVIFClient(
     use_https=True,             # Secure communication
     verify_ssl=True,            # Verify certificates (default)
     apply_patch=True,           # Enhanced parsing (default)
-    capture_xml=False           # Disable debug mode (default)
+    capture_xml=False,          # Disable debug mode (default)
+    wsdl_dir=None               # Use built-in WSDL files (default)
 )
 ```
 </details>
@@ -308,6 +344,7 @@ client = ONVIFClient(
 - **Authentication:** This library uses **WS-UsernameToken with Digest** authentication by default, which is the standard for ONVIF devices.
 - **Patching:** The `apply_patch=True` (default) enables custom zeep patching that improves `xsd:any` field parsing. This is recommended for better compatibility with ONVIF responses.
 - **XML Capture:** Only use `capture_xml=True` during development/debugging as it increases memory usage and may expose sensitive data in logs.
+- **Custom WSDL:** Use `wsdl_dir` parameter to specify a custom directory containing WSDL files. The directory should have a flat structure with WSDL files directly in the root (e.g., `/path/to/custom/wsdl/devicemgmt.wsdl`, `/path/to/custom/wsdl/media.wsdl`, etc.).
 - **Cache Location:** Disk cache (when using `CacheMode.DB` or `CacheMode.ALL`) is stored in `~/.onvif-python/onvif_zeep_cache.sqlite`.
 
 ## Service Discovery: Understanding Device Capabilities
@@ -554,10 +591,10 @@ Some ONVIF services have multiple bindings in the same WSDL. These typically inc
 
 ## Future Improvements (Stay tuned and star ⭐ this repo)
 
-- [x] Add debugging mode with raw xml on SOAP requests and responses. ([c258162](https://github.com/nirsimetri/onvif-python/commit/c258162))
-- [ ] Add functionality for `ONVIFClient` to accept a custom `wsdl_path` service.
-- [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
+- [x] ~~Add debugging mode with raw xml on SOAP requests and responses.~~ ([c258162](https://github.com/nirsimetri/onvif-python/commit/c258162))
+- [x] ~~Add functionality for `ONVIFClient` to accept a custom `wsdl_dir` service.~~ ([65f2570](https://github.com/nirsimetri/onvif-python/commit/65f257092e4c9daa23dd0d00825ed38a45d23b70))
 - [ ] Add `ONVIF CLI` program to interact directly with ONVIF devices via terminal.
+- [ ] Add asynchronous (async/await) support for non-blocking ONVIF operations and concurrent device communication.
 - [ ] Implement structured data models for ONVIF Schemas using [xsdata](https://github.com/tefra/xsdata).
 - [ ] Integrate [xmltodict](https://github.com/martinblech/xmltodict) for simplified XML parsing and conversion.
 - [ ] Enhance documentation with API references and diagrams (not from [AI Wiki](https://deepwiki.com/nirsimetri/onvif-python)).

{onvif_python-0.0.9 → onvif_python-0.1.0}/onvif/client.py

@@ -57,6 +57,7 @@ class ONVIFClient:
         verify_ssl=True,
         apply_patch=True,
         capture_xml=False,
+        wsdl_dir=None,
     ):
         # Apply or remove zeep patch based on user preference
         if apply_patch:
@@ -69,6 +70,11 @@ class ONVIFClient:
         if capture_xml:
             self.xml_plugin = XMLCapturePlugin()
 
+        # Store custom WSDL directory if provided
+        self.wsdl_dir = wsdl_dir
+        if wsdl_dir:
+            ONVIFWSDL.set_custom_wsdl_dir(wsdl_dir)
+
         # Pass to ONVIFOperator
         self.common_args = {
             "host": host,
@@ -114,9 +120,9 @@ class ONVIFClient:
         # Lazy init for other services
 
         self._events = None
-        self._pullpoint = None
+        self._pullpoints = {}  # Dictionary for multiple PullPoint instances
         self._notification = None
-        self._subscription = None
+        self._subscriptions = {}  # Dictionary for multiple Subscription instances
 
         self._imaging = None
 
@@ -286,24 +292,27 @@ class ONVIFClient:
         return self._events
 
     def pullpoint(self, SubscriptionRef):
-        if self._pullpoint is None:
-            xaddr = None
-            try:
-                addr_obj = SubscriptionRef["SubscriptionReference"]["Address"]
-                if isinstance(addr_obj, dict) and "_value_1" in addr_obj:
-                    xaddr = addr_obj["_value_1"]
-                elif hasattr(addr_obj, "_value_1"):
-                    xaddr = addr_obj._value_1
-            except Exception:
-                pass
-
-            if not xaddr:
-                raise RuntimeError(
-                    "SubscriptionReference.Address missing in subscription response"
-                )
+        xaddr = None
+        try:
+            addr_obj = SubscriptionRef["SubscriptionReference"]["Address"]
+            if isinstance(addr_obj, dict) and "_value_1" in addr_obj:
+                xaddr = addr_obj["_value_1"]
+            elif hasattr(addr_obj, "_value_1"):
+                xaddr = addr_obj._value_1
+            
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
+        except Exception:
+            pass
 
-            self._pullpoint = PullPoint(xaddr=xaddr, **self.common_args)
-        return self._pullpoint
+        if not xaddr:
+            raise RuntimeError(
+                "SubscriptionReference.Address missing in subscription response"
+            )
+        
+        if xaddr not in self._pullpoints:
+            self._pullpoints[xaddr] = PullPoint(xaddr=xaddr, **self.common_args)
+        
+        return self._pullpoints[xaddr]
 
     def notification(self):
         if self._notification is None:
@@ -313,24 +322,27 @@ class ONVIFClient:
         return self._notification
 
     def subscription(self, SubscriptionRef):
-        if self._subscription is None:
-            xaddr = None
-            try:
-                addr_obj = SubscriptionRef["SubscriptionReference"]["Address"]
-                if isinstance(addr_obj, dict) and "_value_1" in addr_obj:
-                    xaddr = addr_obj["_value_1"]
-                elif hasattr(addr_obj, "_value_1"):
-                    xaddr = addr_obj._value_1
-            except Exception:
-                pass
-
-            if not xaddr:
-                raise RuntimeError(
-                    "SubscriptionReference.Address missing in subscription response"
-                )
+        xaddr = None
+        try:
+            addr_obj = SubscriptionRef["SubscriptionReference"]["Address"]
+            if isinstance(addr_obj, dict) and "_value_1" in addr_obj:
+                xaddr = addr_obj["_value_1"]
+            elif hasattr(addr_obj, "_value_1"):
+                xaddr = addr_obj._value_1
+            
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
+        except Exception:
+            pass
 
-            self._subscription = Subscription(xaddr=xaddr, **self.common_args)
-        return self._subscription
+        if not xaddr:
+            raise RuntimeError(
+                "SubscriptionReference.Address missing in subscription response"
+            )
+        
+        if xaddr not in self._subscriptions:
+            self._subscriptions[xaddr] = Subscription(xaddr=xaddr, **self.common_args)
+        
+        return self._subscriptions[xaddr]
 
     # Imaging
 
@@ -566,26 +578,31 @@ class ONVIFClient:
 
     def jwt(self, xaddr):
         if self._jwt is None:
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
             self._jwt = JWT(xaddr=xaddr, **self.common_args)
         return self._jwt
 
     def keystore(self, xaddr):
         if self._keystore is None:
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
             self._keystore = Keystore(xaddr=xaddr, **self.common_args)
         return self._keystore
 
     def tlsserver(self, xaddr):
         if self._tlsserver is None:
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
             self._tlsserver = TLSServer(xaddr=xaddr, **self.common_args)
         return self._tlsserver
 
     def dot1x(self, xaddr):
         if self._dot1x is None:
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
             self._dot1x = Dot1X(xaddr=xaddr, **self.common_args)
         return self._dot1x
 
     def authorizationserver(self, xaddr):
         if self._authorizationserver is None:
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
             self._authorizationserver = AuthorizationServer(
                 xaddr=xaddr, **self.common_args
             )
@@ -593,5 +610,6 @@ class ONVIFClient:
 
     def mediasigning(self, xaddr):
         if self._mediasigning is None:
+            xaddr = self._rewrite_xaddr_if_needed(xaddr)
             self._mediasigning = MediaSigning(xaddr=xaddr, **self.common_args)
         return self._mediasigning