Add proper typing to recognize _Element

Author: mxamin

src/xmlsec/template.py

@@ -1,4 +1,6 @@
 import ctypes
+from collections.abc import Sequence
+from typing import Any
 
 from lxml.etree import _Element
 
@@ -37,7 +39,7 @@ def add_encrypted_key(
     c_recipient = ctypes.c_char_p(recipient.encode('utf-8') if recipient else None)
 
     # Call the C function
-    result = libxmlsec.PyXmlSec_TemplateAddEncryptedKey(node, method, c_id, c_type, c_recipient)
+    result: _Element = libxmlsec.PyXmlSec_TemplateAddEncryptedKey(node, method, c_id, c_type, c_recipient)
 
     if not result:
         raise RuntimeError('Failed to add encrypted key')
@@ -54,7 +56,7 @@ def add_key_name(node: _Element, name: str | None = None) -> _Element:
     :return: The modified XML node.
     """
     c_name = ctypes.c_char_p(name.encode('utf-8') if name else None)
-    result = libxmlsec.PyXmlSec_TemplateAddKeyName(node, c_name)
+    result: _Element = libxmlsec.PyXmlSec_TemplateAddKeyName(node, c_name)
 
     if not result:
         raise RuntimeError('Failed to add key name')
@@ -69,7 +71,7 @@ def add_key_value(node: _Element) -> _Element:
     :param node: The XML node to which the key value will be added.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateAddKeyValue(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateAddKeyValue(node)
 
     if not result:
         raise RuntimeError('Failed to add key value')
@@ -94,7 +96,7 @@ def add_reference(
     c_uri = ctypes.c_char_p(uri.encode('utf-8') if uri else None)
     c_type = ctypes.c_char_p(type.encode('utf-8') if type else None)
 
-    result = libxmlsec.PyXmlSec_TemplateAddReference(node, digest_method, c_id, c_uri, c_type)
+    result: _Element = libxmlsec.PyXmlSec_TemplateAddReference(node, digest_method, c_id, c_uri, c_type)
 
     if not result:
         raise RuntimeError('Failed to add reference')
@@ -110,7 +112,7 @@ def add_transform(node: _Element, transform: Transform) -> Any:
     :param transform: The transform to add.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateAddTransform(node, transform)
+    result: _Element = libxmlsec.PyXmlSec_TemplateAddTransform(node, transform)
 
     if not result:
         raise RuntimeError('Failed to add transform')
@@ -125,7 +127,7 @@ def add_x509_data(node: _Element) -> _Element:
     :param node: The XML node to which the X509 data will be added.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateAddX509Data(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateAddX509Data(node)
 
     if not result:
         raise RuntimeError('Failed to add X509 data')
@@ -142,7 +144,7 @@ def create(node: _Element, c14n_method: Transform, sign_method: Transform) -> _E
     :param sign_method: The signature method.
     :return: The created XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateCreate(node, c14n_method, sign_method)
+    result: _Element = libxmlsec.PyXmlSec_TemplateCreate(node, c14n_method, sign_method)
 
     if not result:
         raise RuntimeError('Failed to create template')
@@ -177,7 +179,7 @@ def encrypted_data_create(
     c_encoding = ctypes.c_char_p(encoding.encode('utf-8') if encoding else None)
     c_ns = ctypes.c_char_p(ns.encode('utf-8') if ns else None)
 
-    result = libxmlsec.PyXmlSec_TemplateEncryptedDataCreate(node, method, c_id, c_type, c_mime_type, c_encoding, c_ns)
+    result: _Element = libxmlsec.PyXmlSec_TemplateEncryptedDataCreate(node, method, c_id, c_type, c_mime_type, c_encoding, c_ns)
 
     if not result:
         raise RuntimeError('Failed to create encrypted data')
@@ -192,7 +194,7 @@ def encrypted_data_ensure_cipher_value(node: _Element) -> _Element:
     :param node: The XML node to ensure cipher value for.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateEncryptedDataEnsureCipherValue(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateEncryptedDataEnsureCipherValue(node)
 
     if not result:
         raise RuntimeError('Failed to ensure cipher value')
@@ -212,7 +214,7 @@ def encrypted_data_ensure_key_info(node: _Element, id: str | None = None, ns: st
     c_id = ctypes.c_char_p(id.encode('utf-8') if id else None)
     c_ns = ctypes.c_char_p(ns.encode('utf-8') if ns else None)
 
-    result = libxmlsec.PyXmlSec_TemplateEncryptedDataEnsureKeyInfo(node, c_id, c_ns)
+    result: _Element = libxmlsec.PyXmlSec_TemplateEncryptedDataEnsureKeyInfo(node, c_id, c_ns)
 
     if not result:
         raise RuntimeError('Failed to ensure key info')
@@ -230,7 +232,7 @@ def ensure_key_info(node: _Element, id: str | None = None) -> _Element:
     """
     c_id = ctypes.c_char_p(id.encode('utf-8') if id else None)
 
-    result = libxmlsec.PyXmlSec_TemplateEnsureKeyInfo(node, c_id)
+    result: _Element = libxmlsec.PyXmlSec_TemplateEnsureKeyInfo(node, c_id)
 
     if not result:
         raise RuntimeError('Failed to ensure key info')
@@ -250,7 +252,7 @@ def transform_add_c14n_inclusive_namespaces(node: _Element, prefixes: str | Sequ
 
     c_prefixes = (ctypes.c_char_p * len(prefixes))(*[p.encode('utf-8') for p in prefixes])
 
-    result = libxmlsec.PyXmlSec_TemplateTransformAddC14NInclusiveNamespaces(node, c_prefixes)
+    result: _Element = libxmlsec.PyXmlSec_TemplateTransformAddC14NInclusiveNamespaces(node, c_prefixes)
 
     if not result:
         raise RuntimeError('Failed to add inclusive namespaces')
@@ -263,7 +265,7 @@ def x509_data_add_certificate(node: _Element) -> _Element:
     :param node: The XML node to add the certificate to.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateX509DataAddCertificate(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509DataAddCertificate(node)
 
     if not result:
         raise RuntimeError('Failed to add certificate')
@@ -278,7 +280,7 @@ def x509_data_add_crl(node: _Element) -> _Element:
     :param node: The XML node to add the CRL to.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateX509DataAddCRL(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509DataAddCRL(node)
 
     if not result:
         raise RuntimeError('Failed to add CRL')
@@ -293,7 +295,7 @@ def x509_data_add_issuer_serial(node: _Element) -> _Element:
     :param node: The XML node to add the issuer serial to.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateX509DataAddIssuerSerial(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509DataAddIssuerSerial(node)
 
     if not result:
         raise RuntimeError('Failed to add issuer serial')
@@ -308,7 +310,7 @@ def x509_data_add_ski(node: _Element) -> _Element:
     :param node: The XML node to add the SKI to.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateX509DataAddSKI(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509DataAddSKI(node)
 
     if not result:
         raise RuntimeError('Failed to add SKI')
@@ -323,7 +325,7 @@ def x509_data_add_subject_name(node: _Element) -> _Element:
     :param node: The XML node to add the subject name to.
     :return: The modified XML node.
     """
-    result = libxmlsec.PyXmlSec_TemplateX509DataAddSubjectName(node)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509DataAddSubjectName(node)
 
     if not result:
         raise RuntimeError('Failed to add subject name')
@@ -341,7 +343,7 @@ def x509_issuer_serial_add_issuer_name(node: _Element, name: str | None = None)
     """
     c_name = ctypes.c_char_p(name.encode('utf-8') if name else None)
 
-    result = libxmlsec.PyXmlSec_TemplateX509IssuerSerialAddIssuerName(node, c_name)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509IssuerSerialAddIssuerName(node, c_name)
 
     if not result:
         raise RuntimeError('Failed to add issuer name')
@@ -359,7 +361,7 @@ def x509_issuer_serial_add_serial_number(node: _Element, serial: str | None = No
     """
     c_serial = ctypes.c_char_p(serial.encode('utf-8') if serial else None)
 
-    result = libxmlsec.PyXmlSec_TemplateX509IssuerSerialAddSerialNumber(node, c_serial)
+    result: _Element = libxmlsec.PyXmlSec_TemplateX509IssuerSerialAddSerialNumber(node, c_serial)
 
     if not result:
         raise RuntimeError('Failed to add serial number')