python: add stubs

This has been generated by https://github.com/Jij-Inc/pyo3-stub-gen

However, there is a chain of dependencies that makes it hard to include the build process in this commit.

That is why we offer for now a static file (as suggested in https://pyo3.rs/v0.16.4/python_typing_hints.html)

Signed-off-by: Tristram Gräbener <[email protected]>

Author: Tristramg

python/liblrs_python.pyi

@@ -0,0 +1,148 @@
+# This file is automatically generated by pyo3_stub_gen
+# ruff: noqa: E501, F401
+
+import typing
+
+class Anchor:
+    r"""
+    An `Anchor` is a reference point for a given [`Curve`].
+    It can be a milestone, a bridge…
+    """
+    name: str
+    position: typing.Optional[Point]
+    curve_position: float
+    scale_position: float
+
+class AnchorOnLrm:
+    r"""
+    The linear position of an anchor doesn’t always match the measured distance
+    For example if a road was transformed into a bypass, resulting in a longer road,
+    but measurements are kept the same
+    The start of the curve might also be different from the `0` of the LRM
+    """
+    def __new__(cls,anchor_index:int, distance_along_lrm:float): ...
+    ...
+
+class Builder:
+    def __new__(cls,): ...
+    def add_node(self, id:str, coord:Point, properties:typing.Mapping[str, str]) -> int:
+        ...
+
+    def add_anchor(self, id,coord,properties,name = ...) -> int:
+        ...
+
+    def add_projected_anchor(self, id,position_on_curve,properties,name = ...) -> int:
+        ...
+
+    def add_segment(self, id:str, geometry:typing.Sequence[Point], start_node_index:int, end_node_index:int) -> int:
+        ...
+
+    def add_traversal(self, traversal_id:str, segments:typing.Sequence[SegmentOfTraversal]) -> None:
+        ...
+
+    def add_lrm_with_distances(self, id:str, traversal_index:int, anchors:typing.Sequence[AnchorOnLrm], properties:typing.Mapping[str, str]) -> None:
+        ...
+
+    def add_lrm_with_distances_with_orientation(self, id:str, traversal_index:int, reference_traversal_index:int, anchors:typing.Sequence[AnchorOnLrm], properties:typing.Mapping[str, str]) -> None:
+        ...
+
+    def get_traversal_indexes(self) -> dict[str, int]:
+        ...
+
+    def read_from_osm(self, input_osm_file:str, lrm_tag:str, required:typing.Sequence[tuple[str, str]], to_reject:typing.Sequence[tuple[str, str]]) -> None:
+        ...
+
+    def save(self, out_file:str, properties:typing.Mapping[str, str]) -> None:
+        ...
+
+    def euclidean_distance(self, lrm_index_a:int, lrm_index_b:int) -> float:
+        ...
+
+    def get_nodes_of_traversal(self, lrm_index:int) -> list[int]:
+        ...
+
+    def get_node_coord(self, node_index:int) -> Point:
+        ...
+
+    def reverse(self, lrm_index:int) -> None:
+        ...
+
+
+class LrmScaleMeasure:
+    r"""
+    Represent a position on an [`LrmScale`] relative as an `offset` to an [`Anchor`].
+    """
+    anchor_name: str
+    scale_offset: float
+    def __new__(cls,anchor_name:str, scale_offset:float): ...
+
+class Lrs:
+    r"""
+    Holds the whole Linear Referencing System.
+    """
+    def __new__(cls,data:bytes): ...
+    def lrm_len(self) -> int:
+        r"""
+        How many LRMs compose the LRS.
+        """
+        ...
+
+    def get_lrm_geom(self, index:int) -> list[Point]:
+        r"""
+        Return the geometry of the LRM.
+        """
+        ...
+
+    def get_lrm_scale_id(self, index:int) -> str:
+        r"""
+         `id` of the [`LrmScale`].
+        """
+        ...
+
+    def get_anchors(self, lrm_index:int) -> list[Anchor]:
+        r"""
+        All the [`Anchor`]s of a LRM.
+        """
+        ...
+
+    def resolve(self, lrm_index:int, measure:LrmScaleMeasure) -> Point:
+        r"""
+        Get the position given a [`LrmScaleMeasure`].
+        """
+        ...
+
+    def locate_point(self, lrm_index:int, measure:LrmScaleMeasure) -> float:
+        r"""
+        Get the positon along the curve given a [`LrmScaleMeasure`]
+        The value will be between 0.0 and 1.0, both included
+        """
+        ...
+
+    def resolve_range(self, lrm_index:int, from:LrmScaleMeasure, to:LrmScaleMeasure) -> list[Point]:
+        r"""
+        Given two [`LrmScaleMeasure`]s, return a range of [`Point`] that represent a line string.
+        """
+        ...
+
+    def find_lrm(self, lrm_id:str) -> typing.Optional[int]:
+        r"""
+        Given a ID returns the corresponding lrs index (or None if not found)
+        """
+        ...
+
+
+class Point:
+    r"""
+    A geographical [`Point`], it can be either a projected or spherical coordinates.
+    """
+    x: float
+    y: float
+    def __new__(cls,x:float, y:float): ...
+
+class SegmentOfTraversal:
+    r"""
+    A traversal is composed by segments
+    """
+    def __new__(cls,segment_index:int, reversed:bool): ...
+    ...
+