saxonche-stubs 0.2.0__tar.gz

saxonche_stubs-0.2.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: saxonche-stubs
+Version: 0.2.0
+Summary: Type stubs for saxonche
+License: GPL-3.0-or-later
+Author: Bpolitycki
+Author-email: bastian.politycki@unisg.ch
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: saxonche (>=12.1.0,<13.0.0)
+Description-Content-Type: text/markdown
+
+# saxonche-stubs
+
+Type stubs for the [saxonche](https://pypi.org/project/saxonche/) python package. This package has no functionality itself, but is merely an addition to the completion within IDEs. The basis for type annotations and comments is the documentation of [the Saxon Python API](https://www.saxonica.com/saxon-c/doc11/html/saxonc.html).
+
+At the moment not all APIs are fully typed. To install the stubs just install the git repo via poetry or any other package manager.
+
+You can use `stubtest` to get an impression of untyped components:
+
+```sh
+poetry run stubtest saxonche
+```
+
+## Author / Contact
+
+- [Bastian Politycki](https://github.com/Bpolitycki) – Swiss Law Sources
+

saxonche_stubs-0.2.0/README.md

@@ -0,0 +1,15 @@
+# saxonche-stubs
+
+Type stubs for the [saxonche](https://pypi.org/project/saxonche/) python package. This package has no functionality itself, but is merely an addition to the completion within IDEs. The basis for type annotations and comments is the documentation of [the Saxon Python API](https://www.saxonica.com/saxon-c/doc11/html/saxonc.html).
+
+At the moment not all APIs are fully typed. To install the stubs just install the git repo via poetry or any other package manager.
+
+You can use `stubtest` to get an impression of untyped components:
+
+```sh
+poetry run stubtest saxonche
+```
+
+## Author / Contact
+
+- [Bastian Politycki](https://github.com/Bpolitycki) – Swiss Law Sources

saxonche_stubs-0.2.0/pyproject.toml

@@ -0,0 +1,32 @@
+[tool.poetry]
+name = "saxonche-stubs"
+version = "0.2.0"
+description = "Type stubs for saxonche"
+authors = ["Bpolitycki <bastian.politycki@unisg.ch>"]
+license = "GPL-3.0-or-later"
+readme = "README.md"
+packages = [{include = "saxonche-stubs"}]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+saxonche = "^12.1.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "^23.3.0"
+ruff = "^0.0.262"
+mypy = "^1.2.0"
+
+[tool.mypy]
+mypy_path = "saxonche-stubs"
+check_untyped_defs = true
+ignore_errors = false
+ignore_missing_imports = true
+strict_optional = true
+
+[tool.ruff]
+select = ["E", "F", "I001"]
+ignore = ["E501"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

saxonche_stubs-0.2.0/saxonche-stubs/__init__.pyi

@@ -0,0 +1,180 @@
+from typing import Any, Self, overload
+
+def __getattr__(name: str) -> Any: ...
+
+class PySaxonProcessor:
+    def __init__(self, license: bool = False) -> None:
+        """An SaxonProcessor acts as a factory for generating XQuery, XPath, Schema
+        and XSLT compilers. This class is itself the context that needs to be managed
+        (i.e. allocation & release)"""
+        ...
+    def __enter__(self) -> Self: ...
+    def __exit__(
+        self,
+        exc_type: Any,
+        exc_val: Any,
+        exc_tb: Any,
+    ) -> None: ...
+    def clear_configuration_properties(self) -> None:
+        """Clear all configuration properties that have been set"""
+        ...
+    def new_xpath_processor(self) -> PyXPathProcessor:
+        """Creates a new XPath processor, which used to evaluate XPath expressions."""
+        ...
+    @overload
+    def parse_xml(self, xml_file_name: str) -> PyXdmNode:
+        """Parse a lexical representation, source file or uri of the source document
+        and return it as an Xdm Node
+
+        Args:
+            xml_file_name (str): The file name of the source document
+
+        Returns:
+            PyXdmNode: The Xdm Node representing the source document
+        """
+        ...
+    @overload
+    def parse_xml(self, xml_text: str) -> PyXdmNode:
+        """Parse a lexical representation, source file or uri of the source document
+        and return it as an Xdm Node
+
+        Args:
+             xml_text (str): The lexical representation of the source document
+
+        Returns:
+            PyXdmNode: The Xdm Node representing the source document
+        """
+        ...
+    @overload
+    def parse_xml(self, xml_uri: str) -> PyXdmNode:
+        """Parse a lexical representation, source file or uri of the source document
+         and return it as an Xdm Node
+
+         Args:
+             xml_uri (str): The uri of the source document
+
+        Returns:
+             PyXdmNode: The Xdm Node representing the source document
+        """
+        ...
+
+class PyXPathProcessor:
+    def __init__(self) -> None: ...
+
+class PyXdmItem:
+    def __init__(self) -> None: ...
+    def get_atomic_value(self) -> PyXdmAtomicValue:
+        """Get the atomic value of this item.
+
+        Returns:
+            PyXdmAtomicValue: The atomic value of this item
+
+        Raises:
+            Exception: If the item is not an atomic value
+        """
+        ...
+    def get_map_value(self) -> PyXdmMap:
+        """Get the map value of this item.
+
+        Returns:
+            PyXdmMap: The map value of this item
+
+        Raises:
+            Exception: If the item is not a map
+        """
+        ...
+    def get_node_value(self) -> PyXdmNode:
+        """Get the node value of this item.
+
+        Returns:
+            PyXdmNode: The node value of this item
+
+        Raises:
+            Exception: If the item is not a node
+        """
+        ...
+    @property
+    def head(self) -> PyXdmItem | None:
+        """Property which returns the first item in the sequence.
+
+        Returns:
+            PyXdmItem | None: The first item in the sequence or None if the sequence is empty
+        """
+        ...
+    @property
+    def is_array(self) -> bool:
+        """Property which returns whether the item is an array.
+
+        Returns:
+            bool: True if the item is an array, False otherwise
+        """
+        ...
+    @property
+    def is_atomic(self) -> bool:
+        """Property which returns whether the item is an atomic value.
+
+        Returns:
+            bool: True if the item is an atomic value, False otherwise
+        """
+        ...
+    @property
+    def is_function(self) -> bool:
+        """Property which returns whether the item is a function.
+
+        Returns:
+            bool: True if the item is a function, False otherwise
+        """
+        ...
+    @property
+    def is_map(self) -> bool:
+        """Property which returns whether the item is a map.
+
+        Returns:
+            bool: True if the item is a map, False otherwise
+        """
+        ...
+    @property
+    def is_node(self) -> bool:
+        """Property which returns whether the item is a node.
+
+        Returns:
+            bool: True if the item is a node, False otherwise
+        """
+        ...
+    @property
+    def string_value(self) -> str:
+        """Property which returns the string value.
+
+        Returns:
+            str: The string value of the atomic value
+        """
+        ...
+
+class PyXdmAtomicValue(PyXdmItem):
+    def __init__(self) -> None:
+        """Reprensts an atomic value in the XDM data model. Atomic values are either
+        built-in atomic values (such as xs:integer or xs:date) or user-defined atomic
+        values."""
+        ...
+    @property
+    def boolean_value(self) -> bool:
+        """Property which returns the boolean value.
+
+        Returns:
+            bool: The boolean value of the atomic value
+        """
+        ...
+    @property
+    def integer_value(self) -> int:
+        """Property which returns the integer value.
+
+        Returns:
+            int: The integer value of the atomic value
+        """
+        ...
+
+class PyXdmMap(PyXdmItem):
+    def __init__(self) -> None: ...
+
+class PyXdmNode(PyXdmItem):
+    def __init__(self) -> None: ...

saxonche_stubs-0.2.0/setup.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+packages = \
+['saxonche-stubs']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['saxonche>=12.1.0,<13.0.0']
+
+setup_kwargs = {
+    'name': 'saxonche-stubs',
+    'version': '0.2.0',
+    'description': 'Type stubs for saxonche',
+    'long_description': '# saxonche-stubs\n\nType stubs for the [saxonche](https://pypi.org/project/saxonche/) python package. This package has no functionality itself, but is merely an addition to the completion within IDEs. The basis for type annotations and comments is the documentation of [the Saxon Python API](https://www.saxonica.com/saxon-c/doc11/html/saxonc.html).\n\nAt the moment not all APIs are fully typed. To install the stubs just install the git repo via poetry or any other package manager.\n\nYou can use `stubtest` to get an impression of untyped components:\n\n```sh\npoetry run stubtest saxonche\n```\n\n## Author / Contact\n\n- [Bastian Politycki](https://github.com/Bpolitycki) – Swiss Law Sources\n',
+    'author': 'Bpolitycki',
+    'author_email': 'bastian.politycki@unisg.ch',
+    'maintainer': 'None',
+    'maintainer_email': 'None',
+    'url': 'None',
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'python_requires': '>=3.8,<4.0',
+}
+
+
+setup(**setup_kwargs)