robotframework-xmlvalidator 2.1.0__tar.gz → 2.1.1__tar.gz

{robotframework_xmlvalidator-2.1.0 → robotframework_xmlvalidator-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-xmlvalidator
-Version: 2.1.0
+Version: 2.1.1
 Summary: A Robot Framework test library for validating XML files against XSD schemas
 License: Apache-2.0
 License-File: LICENSE
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Testing
-Requires-Dist: lxml (>=5.1.0,<6.0.0)
+Requires-Dist: lxml (>=6.1.0,<7.0.0)
 Requires-Dist: pandas (>=2.2.0,<3.0.0)
 Requires-Dist: robotframework (>=7.0.0,<8.0.0)
 Requires-Dist: xmlschema (>=3.4.3,<4.0.0)
@@ -27,10 +27,9 @@ Project-URL: Homepage, https://github.com/MichaelHallik/robotframework-xmlvalida
 Project-URL: Repository, https://github.com/MichaelHallik/robotframework-xmlvalidator
 Description-Content-Type: text/markdown
 
-| Version | License | Tests | Downloads |
-|---------|---------|-------|-----------|
-| [![PyPI version](https://img.shields.io/pypi/v/robotframework-xmlvalidator)](https://pypi.org/project/robotframework-xmlvalidator/) | [![License](https://img.shields.io/github/license/MichaelHallik/robotframework-xmlvalidator)](LICENSE) | [![Tests](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions/workflows/test.yml/badge.svg)](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions) | [![Downloads](https://img.shields.io/pepy/dt/robotframework-xmlvalidator)](https://pepy.tech/project/robotframework-xmlvalidator) |
-
+| Version | License | Tests | Downloads - total | Downloads - last 30 days |
+|---------|---------|-------|-------------------|--------------------------|
+| [![PyPI version](https://img.shields.io/pypi/v/robotframework-xmlvalidator)](https://pypi.org/project/robotframework-xmlvalidator/) | [![License](https://img.shields.io/github/license/MichaelHallik/robotframework-xmlvalidator)](LICENSE) | [![Tests](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions/workflows/test.yml/badge.svg)](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions) | [![Downloads](https://img.shields.io/pepy/dt/robotframework-xmlvalidator)](https://pepy.tech/project/robotframework-xmlvalidator) | [![PyPI Downloads](https://static.pepy.tech/personalized-badge/robotframework-xmlvalidator?period=monthly&units=ABBREVIATION&left_color=BLACK&right_color=GREEN&left_text=downloads%2Fmonth)](https://pepy.tech/projects/robotframework-xmlvalidator)
 
 <details>
 <summary><strong>📚 Table of Contents</strong></summary>
@@ -844,3 +843,4 @@ Licensed under the Apache License 2.0. See [LICENSE](LICENSE).
 ## Author
 
 [Michael Hallik](https://www.linkedin.com/in/michaelhallik/)
+

{robotframework_xmlvalidator-2.1.0 → robotframework_xmlvalidator-2.1.1}/README.md

@@ -1,7 +1,6 @@
-| Version | License | Tests | Downloads |
-|---------|---------|-------|-----------|
-| [![PyPI version](https://img.shields.io/pypi/v/robotframework-xmlvalidator)](https://pypi.org/project/robotframework-xmlvalidator/) | [![License](https://img.shields.io/github/license/MichaelHallik/robotframework-xmlvalidator)](LICENSE) | [![Tests](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions/workflows/test.yml/badge.svg)](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions) | [![Downloads](https://img.shields.io/pepy/dt/robotframework-xmlvalidator)](https://pepy.tech/project/robotframework-xmlvalidator) |
-
+| Version | License | Tests | Downloads - total | Downloads - last 30 days |
+|---------|---------|-------|-------------------|--------------------------|
+| [![PyPI version](https://img.shields.io/pypi/v/robotframework-xmlvalidator)](https://pypi.org/project/robotframework-xmlvalidator/) | [![License](https://img.shields.io/github/license/MichaelHallik/robotframework-xmlvalidator)](LICENSE) | [![Tests](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions/workflows/test.yml/badge.svg)](https://github.com/MichaelHallik/robotframework-xmlvalidator/actions) | [![Downloads](https://img.shields.io/pepy/dt/robotframework-xmlvalidator)](https://pepy.tech/project/robotframework-xmlvalidator) | [![PyPI Downloads](https://static.pepy.tech/personalized-badge/robotframework-xmlvalidator?period=monthly&units=ABBREVIATION&left_color=BLACK&right_color=GREEN&left_text=downloads%2Fmonth)](https://pepy.tech/projects/robotframework-xmlvalidator)
 
 <details>
 <summary><strong>📚 Table of Contents</strong></summary>
@@ -814,4 +813,4 @@ Licensed under the Apache License 2.0. See [LICENSE](LICENSE).
 
 ## Author
 
-[Michael Hallik](https://www.linkedin.com/in/michaelhallik/)
+[Michael Hallik](https://www.linkedin.com/in/michaelhallik/)

{robotframework_xmlvalidator-2.1.0 → robotframework_xmlvalidator-2.1.1}/pyproject.toml

@@ -1,7 +1,7 @@
 # General.
 [tool.poetry]
 name = "robotframework-xmlvalidator"
-version = "2.1.0"
+version = "2.1.1"
 description = "A Robot Framework test library for validating XML files against XSD schemas"
 authors = ["Michael Hallik <hallik.michael@gmail.com>"]
 license = "Apache-2.0"
@@ -24,17 +24,17 @@ classifiers = [
 # Package installation dependencies.
 [tool.poetry.dependencies]
 python = ">=3.10"
-lxml = "^5.1.0"
+lxml = "^6.1.0"
 pandas = "^2.2.0"
 robotframework = "^7.0.0"
 xmlschema = "^3.4.3"
 
 # Development dependencies (not installed during normal package installation).
 [tool.poetry.group.dev.dependencies]
-black = "^25.1.0"
+black = "^26.3.1"
 pylint = "^3.1.0"
 pyright = "^1.1.357"
-pytest = "^8.3.1" # Needed for unit testing.
+pytest = "^9.0.3" # Needed for unit testing.
 pytest-mock = "^3.12.0" # Needed for mocking in tests.
 pytest-cov = "^4.1.0"
 
@@ -47,4 +47,4 @@ build-backend = "poetry.core.masonry.api" # The Poetry module which handles pack
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "-ra --strict-markers"
-testpaths = ["test/unit"]
+testpaths = ["test/unit"]

{robotframework_xmlvalidator-2.1.0 → robotframework_xmlvalidator-2.1.1}/src/xmlvalidator/XmlValidator.py

@@ -16,12 +16,12 @@
 
 
 """
-This module defines the `XmlValidator` class — a Robot Framework test 
-library for validating XML files against XSD schemas using the 
+This module defines the `XmlValidator` class — a Robot Framework test
+library for validating XML files against XSD schemas using the
 `xmlschema` library.
 
-The validator supports both individual and batch validation workflows, 
-with comprehensive error reporting and optional export to structured 
+The validator supports both individual and batch validation workflows,
+with comprehensive error reporting and optional export to structured
 CSV files.
 
 Key Features:
@@ -35,7 +35,7 @@ Key Features:
 - Graceful handling of malformed XML or XSD files.
 - Optional export of all collected errors to a CSV file.
 
-This module is intended to be imported by Robot Framework test suites 
+This module is intended to be imported by Robot Framework test suites
 or executed as a Python module via a direct call.
 """
 
@@ -43,42 +43,47 @@ or executed as a Python module via a direct call.
 # pylint: disable=C0103:invalid-name   # On account of the module name, that is not snake-cased (required by Robot Framework).
 # pylint: disable=C0302:too-many-lines # On account of the extensive docstrings and annotations.
 # pylint: disable=C0301:line-too-long  # On account of tables in docstrings.
-
+# ruff: noqa: W291                     # Temporary: needs to be fixed.
+# ruff: noqa: W293                     # Temporary: needs to be fixed.
+# ruff: noqa: E501                     # Temporary: needs to be fixed.
 
 # Standard library imports.
 from pathlib import Path
-from typing import Any, Dict, List, Literal, Optional, Tuple
+from typing import Any, Literal
+
 # Third party library imports.
 from lxml import etree
 from robot.api import Failure, logger
 from robot.api.deco import keyword, library
 from xmlschema import XMLSchema
+
 # Local application imports.
-from .xml_validator_results import ValidatorResultRecorder, ValidatorResult
+from ._version import __version__
+from .xml_validator_results import ValidatorResult, ValidatorResultRecorder
 from .xml_validator_utils import ValidatorUtils
 
 
-@library(scope='GLOBAL')
+@library(scope='GLOBAL', version=__version__, doc_format="REST")
 class XmlValidator:
     """
-    XmlValidator is a `Robot Framework <https://robotframework.org/>`_ 
+    XmlValidator is a `Robot Framework <https://robotframework.org/>`_
     test library for validating XML files against XSD schemas.
 
-    The library leverages the power of the 
-    `xmlschema library <https://pypi.org/project/xmlschema/>`_ and is 
+    The library leverages the power of the
+    `xmlschema library <https://pypi.org/project/xmlschema/>`_ and is
     designed for both single-file and batch XML validation workflows.
 
-    It provides structured and detailed reporting of XML parse errors 
-    (malformed XML content) and XSD violations, schema auto-detection 
+    It provides structured and detailed reporting of XML parse errors
+    (malformed XML content) and XSD violations, schema auto-detection
     and CSV exports of collected errors.
 
-    Features are described in detail on the `project repo's landing page. 
+    Features are described in detail on the `project repo's landing page.
     <https://github.com/MichaelHallik/robotframework-xmlvalidator>`_.
 
     **Overview**
-    
+
     The main keyword is ``Validate Xml Files``.
-    
+
     The other keywords are convenience/helper functions, e.g. ``Reset 
     Error Facets``.
 
@@ -393,15 +398,13 @@ class XmlValidator:
 
     """
 
-    __version__ = '2.1.0'
-    ROBOT_LIBRARY_DOC_FORMAT = 'reST'
     nr_instances = 0
 
     def __init__(
         self,
         xsd_path: str | Path | None = None,
         base_url: str | None = None,
-        error_facets: List[str] | None = None,
+        error_facets: list[str] | None = None,
         fail_on_errors: bool = True,
     ) -> None:
         """
@@ -595,13 +598,11 @@ class XmlValidator:
 
     def _determine_validations(
         self,
-        xml_paths: List[Path],
-        xsd_path: Optional[str|Path] = None,
-        xsd_search_strategy: Optional[
-                Literal['by_namespace', 'by_file_name']
-                ] = None,
-        base_url: Optional[str] = None
-        ) -> Dict[Path, Path | None]:
+        xml_paths: list[Path],
+        xsd_path: str | Path | None = None,
+        xsd_search_strategy: Literal['by_namespace', 'by_file_name'] | None = None,
+        base_url: str | None = None
+        ) -> dict[Path, Path | None]:
         """
         Constructs a mapping between XML files and the XSD schemas to 
         use for their validation.
@@ -714,10 +715,10 @@ class XmlValidator:
                         f"Loading of schema failed: {result.error}."
                         )
                 # Ensure downstream schema loading will be skipped.
-                xsd_file_paths: List[Path|None] = [None] * len(xml_paths)
+                xsd_file_paths: list[Path | None] = [None] * len(xml_paths)
                 # Create the XML/XSD map.
                 validations = dict(
-                    zip( xml_paths, xsd_file_paths )
+                    zip( xml_paths, xsd_file_paths, strict=True )
                     )
             # We got a set of XSDs, that need to be dynamically mapped to XMLs.
             else:
@@ -733,17 +734,17 @@ class XmlValidator:
             # Ensure default schema is loaded; raises exception otherwise.
             result = self._ensure_schema(None, None)
             # Ensure downstream schema loading will now be skipped.
-            xsd_file_paths: List[Path|None] = [None] * len(xml_paths)
+            xsd_file_paths: list[Path | None] = [None] * len(xml_paths)
             # Create the XML/XSD map.
             validations = dict(
-                zip( xml_paths, xsd_file_paths )
+                zip( xml_paths, xsd_file_paths, strict=True )
                 )
         return validations
 
     def _ensure_schema(
         self,
-        xsd_path: Optional[Path] = None,
-        base_url: Optional[str] = None
+        xsd_path: Path | None = None,
+        base_url: str | None = None
         ) -> ValidatorResult:
         """
         Ensures that a schema is available for validation.
@@ -827,11 +828,11 @@ class XmlValidator:
 
     def _find_schemas(
         self,
-        xml_file_paths: List[Path],
-        xsd_file_paths: List[Path],
+        xml_file_paths: list[Path],
+        xsd_file_paths: list[Path],
         search_by: Literal['by_namespace', 'by_file_name'] = 'by_namespace',
-        base_url: Optional[str] = None
-        ) -> Dict[ Path, Path | None ]:
+        base_url: str | None = None
+        ) -> dict[Path, Path | None]:
         """
         Finds matching XSD schemas for XML files using the specified 
         search strategy.
@@ -886,7 +887,7 @@ class XmlValidator:
             to loading or parsing errors.
         
         Notes:
-        										 
+
         - This method does not perform validation — it only establishes 
           schema associations, which are later consumed by 
           `_validate_xml()`.
@@ -978,7 +979,7 @@ class XmlValidator:
     def _load_schema(
         self,
         xsd_path: Path,
-        base_url: Optional[str] = None
+        base_url: str | None = None
         ) -> ValidatorResult:
         """
         This method is responsible for initializing a schema object, 
@@ -1032,8 +1033,8 @@ class XmlValidator:
 
     def _try_load_initial_schema(
         self,
-        xsd_path: Optional[str|Path] = None,
-        base_url: Optional[str] = None
+        xsd_path: str | Path | None = None,
+        base_url: str | None = None
         ) -> None:
         """
         Attempts to resolve, validate, and load a single XSD schema from 
@@ -1112,13 +1113,13 @@ class XmlValidator:
     def _validate_xml( # pylint: disable=R0913:too-many-arguments disable=R0917:too-many-positional-arguments
         self,
         xml_file_path: Path,
-        xsd_file_path: Optional[Path] = None,
-        base_url: Optional[str] = None,
-        error_facets: Optional[ List[str] ] = None,
-        pre_parse: Optional[bool] = True
-        ) -> Tuple[
+        xsd_file_path: Path | None = None,
+        base_url: str | None = None,
+        error_facets: list[str] | None = None,
+        pre_parse: bool = True
+        ) -> tuple[
             bool,
-            Optional[List[dict[str, Any]]]
+            list[dict[str, Any]] | None
             ]:
         """
         Validates an XML file against the currently loaded or provided 
@@ -1309,7 +1310,7 @@ class XmlValidator:
         return (True, None) if len(errors) == 0 else (False, errors)
 
     @keyword
-    def get_error_facets(self) -> List[str]:
+    def get_error_facets(self) -> list[str]:
         """
         .. raw:: html
 
@@ -1333,7 +1334,7 @@ class XmlValidator:
 
     @keyword
     def get_schema(self,return_schema_name: bool = True
-        ) -> Optional[str|XMLSchema]:
+        ) -> str | XMLSchema | None:
         """
         .. raw:: html
 
@@ -1450,20 +1451,18 @@ class XmlValidator:
     def validate_xml_files( # pylint: disable=R0913:too-many-arguments disable=R0914:too-many-locals disable=R0917:too-many-positional-arguments
         self,
         xml_path: str | Path,
-        xsd_path: Optional[str | Path] = None,
-        xsd_search_strategy: Optional[
-            Literal['by_namespace', 'by_file_name']
-            ] = None,
-        base_url: Optional[str] = None,
-        error_facets: Optional[ List[str] ] = None,
-        pre_parse: Optional[bool] = True,
-        write_to_csv: Optional[bool] = True,
-        timestamped: Optional[bool] = True,
+        xsd_path: str | Path | None = None,
+        xsd_search_strategy: Literal['by_namespace', 'by_file_name'] | None = None,
+        base_url: str | None = None,
+        error_facets: list[str] | None = None,
+        pre_parse: bool = True,
+        write_to_csv: bool | None = True,
+        timestamped: bool | None = True,
         reset_errors: bool = True,
-        fail_on_errors: Optional[bool] = None,
-        error_table: Optional[bool] = True
-        ) -> Tuple[
-            List[ Dict[str, Any] ],
+        fail_on_errors: bool | None = None,
+        error_table: bool | None = True
+        ) -> tuple[
+            list[dict[str, Any]],
             str | None
             ]:
         """

robotframework_xmlvalidator-2.1.1/src/xmlvalidator/__init__.py

@@ -0,0 +1,47 @@
+# Copyright 2024-2026 Michael Hallik
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+#
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+#
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""
+Package entry point, exposing the XmlValidator class directly at
+the package level.
+
+Provides versioning metadata for use in documentation and automation.
+
+Features:
+
+- Defines the public API (__all__ + aliasing).
+- Simplifies imports by exposing XmlValidator at the top level.
+- Supports dynamic version discovery from installed metadata.
+"""
+
+
+# pylint: disable=C0103:invalid-name  # On account of the class name, which is not snake-cased (required by RF).
+
+
+# Expose the package version.
+from ._version import __version__
+
+# Expose XmlValidator class directly for cleaner imports.
+from .XmlValidator import XmlValidator
+
+# Alias (i.e. make available) 'XmlValidator' at the package level.
+xmlvalidator = XmlValidator
+
+# Define package metadata.
+__all__ = ["XmlValidator", "__version__"]
+__author__ = "Michael Hallik"

robotframework_xmlvalidator-2.1.1/src/xmlvalidator/_version.py

@@ -0,0 +1,31 @@
+# Copyright 2024-2026 Michael Hallik
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+#
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+#
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""
+Provides the package version from installed package metadata.
+"""
+
+
+import warnings
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("robotframework-xmlvalidator")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+    warnings.warn("Package metadata not found, using fallback version.")