pysnapping 0.2.3__tar.gz → 0.2.4__tar.gz

{pysnapping-0.2.3 → pysnapping-0.2.4}/.gitignore

@@ -1,6 +1,5 @@
 # Configuration
 /*.ini
-uv.lock
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -75,9 +74,6 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# pyenv
-.python-version
-
 # celery beat schedule file
 celerybeat-schedule
 

pysnapping-0.2.4/.gitlab-ci.yml

@@ -0,0 +1,71 @@
+image: registry.geops.com/geops/gitlab-ci-dockerfiles/trixie-python:latest
+
+stages:
+  - test
+
+variables:
+  # Fail instead of updating uv.lock if it is out of sync with pyproject.toml.
+  UV_LOCKED: "1"
+  UV_NO_EDITABLE: "1"
+  # use uv python to get more recent patch releases than from the debian image
+  UV_PYTHON_PREFERENCE: "only-managed"
+  XDG_CACHE_HOME: "${CI_PROJECT_DIR}/.cache/"
+  # keep managed pythons in the cached directory (uv stores them outside its cache by default)
+  UV_PYTHON_INSTALL_DIR: "${XDG_CACHE_HOME}/uv-python"
+  LC_ALL: "C.UTF-8"
+  LANG: "C.UTF-8"
+  # for printing version
+  PACKAGE_NAME: pysnapping
+
+cache:
+  # key just that cache does not grow unbounded
+  key:
+    files:
+      - uv.lock
+      - .pre-commit-config.yaml
+  paths:
+    - .cache
+
+default:
+  before_script:
+    - eval $(ssh-agent -s)
+    - mkdir -p ~/.ssh
+    - echo -e "Host *\nStrictHostKeyChecking no\n\n" > ~/.ssh/config
+    - echo "$GITLAB_PIPELINES_KEY" | tr -d '\r' | ssh-add - > /dev/null
+    - uv --version
+    - uv cache dir
+    - uv --preview-features=cache-size cache size --human
+    # upgrade cached python to latest patch release (if not cached, other uv commands
+    # will install the latest patch release and cache it)
+    - uv python upgrade
+    # install package and print the version (as seen be the CI) that is actually used in
+    # the job (might come from uv cache) for debugging possible cache issues
+    - uv run python -c "from importlib.metadata import version; print('${PACKAGE_NAME} version as seen by CI (might miss tags that have not been pulled):', version('${PACKAGE_NAME}'))"
+
+  after_script:
+    - eval "$(ssh-agent -k)" # to stop ssh-agent from running forever
+
+run_tests:
+  stage: test
+  needs: []
+  script:
+    - uv run pytest -s -vvv --log-cli-level INFO --cov=pysnapping --cov-report term --cov-report xml:cobertura_coverage.xml --cov-fail-under=85 --junitxml=junit_coverage.xml pysnapping
+  coverage: '/^TOTAL.+?(\d+\%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: cobertura_coverage.xml
+      junit: junit_coverage.xml
+
+run_pre_commit_checks:
+  stage: test
+  needs: []
+  script:
+    # We have to uv run here since we still have a system mypy hook that needs installed
+    # dependencies. Could be fixed by using ty and calling it without installing
+    # anything since ty can handle dependencies on its own (mypy and pyright can't do
+    # that).
+    - uv run pre-commit run --all-files
+  except:
+    - master

pysnapping-0.2.4/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+fail_fast: true
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+    - id: no-commit-to-branch
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: mixed-line-ending
+      args: ['--fix=no']
+    - id: check-ast
+    - id: check-builtin-literals
+    - id: check-case-conflict
+    - id: check-docstring-first
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.17.4
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format
+- repo: https://github.com/astral-sh/uv-pre-commit
+  rev: 0.13.7
+  hooks:
+    - id: uv-lock
+      files: ^pyproject.toml|uv.lock$
+- repo: local
+  hooks:
+    - id: mypy
+      name: mypy
+      # gitlab job syncs explicitly without building extensions
+      # and for local dev we assume synced
+      entry: uv run --no-sync mypy
+      # We need installed dependencies for mypy, so we can't use an isolated env. This
+      # could be fixed by using ty instead which is capable of resolving dependencies on
+      # its own (mypy and pyright can't do that).
+      language: system
+      # don't pass file names, so we detect errors in B when only A changed but B
+      # imports A
+      pass_filenames: false
+      # always run instead of a python file filter, so we detect errors in B when A gets
+      # deleted but B imports A
+      always_run: true
+      args: ["-p", "pysnapping"]

pysnapping-0.2.4/.python-version

@@ -0,0 +1 @@
+3.13

{pysnapping-0.2.3 → pysnapping-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysnapping
-Version: 0.2.3
+Version: 0.2.4
 Summary: Snap points to a line string keeping a given order or spacing intact
 Author-email: Alexander Held | geOps <alexander.held@geops.com>
 Maintainer-email: Alexander Held | geOps <alexander.held@geops.com>
@@ -36,7 +36,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Scientific/Engineering :: GIS
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: shapely
@@ -66,10 +66,10 @@ those that respect the order and minimum spacing between points.
 
 ## Installation
 
-Install the latest stable release from PyPI with pip:
+Add the latest stable release from PyPI to your project with uv:
 
 ```bash
-pip install pysnapping
+uv add pysnapping
 ```
 
 ## Modules
@@ -126,31 +126,25 @@ See [our GitHub page](https://github.com/geops) for contact details.
 
 ### Editable Installation
 
-Clone this repo and enter the corresponding directory.
-Create a virtual environment, then install frozen requirements, dev-requirements
-and this library in editable mode:
+Clone this repo and enter the corresponding directory. Then run:
 
 ```bash
-python3.9 -m venv env
-. env/bin/activate
-pip install -U pip
-pip install -r requirements.txt -r dev-requirements.txt -e .
+uv sync
 ```
 
-Keep env activated for all following instructions.
 
 ### Pre-Commit Hooks
 
 Enable pre-commit hooks:
 
 ```bash
-pre-commit install
+uv run pre-commit install
 ```
 
 From time to time (not automated yet) run
 
 ```bash
-pre-commit autoupdate
+uv run pre-commit autoupdate
 ```
 
 to update frozen revs.
@@ -160,7 +154,23 @@ to update frozen revs.
 Run tests and analyze code coverage:
 
 ```bash
-pytest --cov=pysnapping --cov-report term --cov-fail-under=85 pysnapping
+uv run pytest --cov=pysnapping --cov-report term --cov-fail-under=85 pysnapping
+```
+
+### Build release for PyPI
+
+Make sure to add a git tag first and push it to geOps gitlab and github.
+
+Install `build` once:
+
+```bash
+uv tool install build
+```
+
+Then run
+
+```bash
+pyproject-build
 ```
 
 ## Changelog

{pysnapping-0.2.3 → pysnapping-0.2.4}/README.md

@@ -20,10 +20,10 @@ those that respect the order and minimum spacing between points.
 
 ## Installation
 
-Install the latest stable release from PyPI with pip:
+Add the latest stable release from PyPI to your project with uv:
 
 ```bash
-pip install pysnapping
+uv add pysnapping
 ```
 
 ## Modules
@@ -80,31 +80,25 @@ See [our GitHub page](https://github.com/geops) for contact details.
 
 ### Editable Installation
 
-Clone this repo and enter the corresponding directory.
-Create a virtual environment, then install frozen requirements, dev-requirements
-and this library in editable mode:
+Clone this repo and enter the corresponding directory. Then run:
 
 ```bash
-python3.9 -m venv env
-. env/bin/activate
-pip install -U pip
-pip install -r requirements.txt -r dev-requirements.txt -e .
+uv sync
 ```
 
-Keep env activated for all following instructions.
 
 ### Pre-Commit Hooks
 
 Enable pre-commit hooks:
 
 ```bash
-pre-commit install
+uv run pre-commit install
 ```
 
 From time to time (not automated yet) run
 
 ```bash
-pre-commit autoupdate
+uv run pre-commit autoupdate
 ```
 
 to update frozen revs.
@@ -114,7 +108,23 @@ to update frozen revs.
 Run tests and analyze code coverage:
 
 ```bash
-pytest --cov=pysnapping --cov-report term --cov-fail-under=85 pysnapping
+uv run pytest --cov=pysnapping --cov-report term --cov-fail-under=85 pysnapping
+```
+
+### Build release for PyPI
+
+Make sure to add a git tag first and push it to geOps gitlab and github.
+
+Install `build` once:
+
+```bash
+uv tool install build
+```
+
+Then run
+
+```bash
+pyproject-build
 ```
 
 ## Changelog

{pysnapping-0.2.3 → pysnapping-0.2.4}/pyproject.toml

@@ -7,7 +7,7 @@ dependencies = [
   "numpy~=2.0",  # for vectorized operations
   "pyproj>=3.2.0",  # for defining custom CRS
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 license = {file = "LICENSE"}
 authors = [{name = "Alexander Held | geOps", email = "alexander.held@geops.com"}]
 maintainers = [{name = "Alexander Held | geOps", email = "alexander.held@geops.com"}]
@@ -34,6 +34,14 @@ classifiers = [
 ]
 dynamic = ["version"]
 
+[dependency-groups]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "pre-commit",
+    "mypy",
+]
+
 [project.urls]
 homepage = "https://github.com/geops/pysnapping"
 geOps = "https://geops.com/en"
@@ -47,6 +55,15 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools.packages.find]
 include = ["pysnapping", "pysnapping.*"]
 
+[tool.uv]
+cache-keys = [
+    # default
+    { file = "pyproject.toml"},
+    # for non-editable installs (dynamic setuptools_scm versioning)
+    { git = { commit = true } },
+]
+environments = ["sys_platform == 'linux'"]
+
 [tool.ruff.lint]
 select = [
     "F", # pyflakes
@@ -61,10 +78,12 @@ select = [
     "SLOT",   # str, tuple, namedtuple subclasses need __slots__
     "FIX003",  # line contains XXX
     "NPY201",  # numpy 2.0 deprecations
+    "SIM",  # flake8-simplify
+    "I",  # sort imports
+    "T100",  # breakpoints
 ]
 ignore = [
     "E501",  # line too long
-    "UP038",  # see https://github.com/astral-sh/ruff/issues/7871
 ]
 
 [tool.ruff.lint.mccabe]
@@ -72,8 +91,13 @@ max-complexity = 12
 
 [tool.mypy]
 ignore_missing_imports = true
-install_types = true
-non_interactive = true
+# If we allow to install types, mypy will use pip to alter the venv with unpinned extra
+# type stubs. We are on a pure uv setup and don't have pip. Also we want everything
+# pinned. Thus all missing type stubs have to go to dev dependencies.
+install_types = false
+non_interactive = false
+
+[tool.pytest]
 
 [tool.coverage.run]
 branch = true

{pysnapping-0.2.3 → pysnapping-0.2.4}/pysnapping/linear_referencing.py

@@ -9,7 +9,6 @@ Consider using np.moveaxis if your data is shaped differently.
 This module is rather low-level without sanity checks and conversion of array-like to array.
 """
 
-import typing
 from math import floor
 
 import numpy as np
@@ -318,7 +317,7 @@ class LineFractions:
         head_fraction: float = 0.0,
         tail_segment: int = -1,
         tail_fraction: float = 1.0,
-        out: typing.Optional[ProjectedPoints] = None,
+        out: ProjectedPoints | None = None,
     ) -> ProjectedPoints:
         """Project points to the linestring or a substring thereof.
 
@@ -372,8 +371,8 @@ class LineFractions:
         segment_starts = self.target.segment_starts[np.newaxis, segment_slice, :]
         del self  # protection against using unsliced data
 
-        low: typing.Union[float, np.ndarray]
-        high: typing.Union[float, np.ndarray]
+        low: float | np.ndarray
+        high: float | np.ndarray
         # different cases only for speeding up the default
         if head_fraction != 0.0:
             low = np.zeros((1, fractions.shape[1], 1))
@@ -430,7 +429,7 @@ class LineFractions:
         d_to: float,
         distances: np.ndarray,
         extrapolate: bool = False,
-        out: typing.Optional[ProjectedPoints] = None,
+        out: ProjectedPoints | None = None,
     ) -> ProjectedPoints:
         """Convenience method to project between two distances.
 

{pysnapping-0.2.3 → pysnapping-0.2.4}/pysnapping/snap.py

@@ -1,40 +1,39 @@
+import logging
 import typing
-from functools import partial
 from bisect import bisect_right
+from functools import partial
 from operator import itemgetter
-import logging
 
-import pyproj
 import numpy as np
+import pyproj
 from numpy.typing import ArrayLike
 
+from . import (
+    EPSG4326,
+    EPSG4978,
+    BadShortestDistances,
+    ExtrapolationError,
+    SnappingError,
+    SnappingMethod,
+)
 from .linear_referencing import (
+    LineFractions,
     Locations,
-    substrings,
-    locate,
-    interpolate,
-    ProjectionTarget,
     ProjectedPoints,
-    LineFractions,
+    ProjectionTarget,
+    interpolate,
+    locate,
     resample,
+    substrings,
 )
 from .util import (
-    get_trafo,
-    transform_coords,
     array_chk,
-    simplify_2d_keep_rest,
     cumulative_min_and_argmin,
-)
-from . import (
-    SnappingError,
-    BadShortestDistances,
-    ExtrapolationError,
-    EPSG4326,
-    EPSG4978,
-    SnappingMethod,
+    get_trafo,
+    simplify_2d_keep_rest,
+    transform_coords,
 )
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -207,7 +206,7 @@ class DubiousTrajectory(XYZDMixin):
         xyzd: ArrayLike,
         crs: pyproj.CRS = EPSG4326,
         strict_axis_order: bool = False,
-        simplify_tolerance: typing.Optional[float] = None,
+        simplify_tolerance: float | None = None,
     ) -> None:
         """Initialize DubiousTrajectory.
 
@@ -223,9 +222,7 @@ class DubiousTrajectory(XYZDMixin):
             raise ValueError("coords have to be finite")
 
     @classmethod
-    def from_xyd_and_z(
-        cls, xyd: ArrayLike, z: typing.Union[float, ArrayLike] = 0.0, **kwargs
-    ):
+    def from_xyd_and_z(cls, xyd: ArrayLike, z: float | ArrayLike = 0.0, **kwargs):
         xyd_arr = np.asarray(xyd, dtype=float)
         xyzd = np.empty((xyd_arr.shape[0], 4))
         xyzd[:, :2] = xyd_arr[:, :2]
@@ -329,7 +326,7 @@ class Trajectory(XYZDMixin):
     __slots__ = ("_target",)
 
     # lazy data calculated when first needed
-    _target: typing.Optional[ProjectionTarget]
+    _target: ProjectionTarget | None
 
     def __init__(self, xyz: ArrayLike) -> None:
         xyz = array_chk(xyz, ((2, None), 3), chk_finite=True, dtype=float, copy=False)
@@ -410,8 +407,8 @@ class TrajectoryTrip(XYZDMixin):
     trajectory: Trajectory
 
     # lazy data calculated when first needed
-    _line_fractions: typing.Optional[LineFractions]
-    _projected_points: typing.Optional[ProjectedPoints]
+    _line_fractions: LineFractions | None
+    _projected_points: ProjectedPoints | None
 
     def __init__(self, trajectory: Trajectory, xyzd: ArrayLike) -> None:
         self.trajectory = trajectory
@@ -490,7 +487,7 @@ class TrajectoryTrip(XYZDMixin):
         # list of (ppoints, cost, reverse_order) tuples for forward and backward
         # solution
         results: list[tuple[ProjectedPoints, float, bool]] = []
-        forward_error: typing.Optional[SnappingError] = None
+        forward_error: SnappingError | None = None
         try:
             forward_result = self.route_candidates(params, ppoints_list) + (False,)
         except SnappingError as error:
@@ -531,9 +528,7 @@ class TrajectoryTrip(XYZDMixin):
             reverse_order=reverse_order,
         )
 
-    def snap_trusted(
-        self, params: SnappingParams
-    ) -> list[typing.Optional[ProjectedPoints]]:
+    def snap_trusted(self, params: SnappingParams) -> list[ProjectedPoints | None]:
         """Determine which points are trusted and snap them to the trajectory.
 
         See `SnappingParams` for an explanation of trusted/untrusted. The list contains
@@ -546,7 +541,7 @@ class TrajectoryTrip(XYZDMixin):
             d_max=self.trajectory.d_max,
             consider_sampling_accuracy=True,
         )
-        ppoints_list: list[typing.Optional[ProjectedPoints]] = [None] * len(self)
+        ppoints_list: list[ProjectedPoints | None] = [None] * len(self)
         if traj_spacing_ok(self.dists):
             trusted_mask = np.logical_not(np.isnan(self.dists))
             n_non_nan = trusted_mask.sum()
@@ -606,7 +601,7 @@ class TrajectoryTrip(XYZDMixin):
     def set_untrusted_candidates_inplace(
         self,
         params: SnappingParams,
-        ppoints_list: list[typing.Optional[ProjectedPoints]],
+        ppoints_list: list[ProjectedPoints | None],
     ) -> list[ProjectedPoints]:
         """Set untrusted snapping candidates inplace.
 
@@ -707,7 +702,7 @@ class TrajectoryTrip(XYZDMixin):
         reachable_costs = [[0.0]]
         # index into the lists from the previous layer for every entry in the current
         # layer for shortest path reconstruction
-        reachable_predecessors: list[list[typing.Optional[int]]] = [[None]]
+        reachable_predecessors: list[list[int | None]] = [[None]]
 
         # artificial end layer connected to all reachable candidates of the real last
         # layer
@@ -767,7 +762,7 @@ class TrajectoryTrip(XYZDMixin):
         self,
         ppoints_list: list[ProjectedPoints],
         reachable_candidates: list[list[int]],
-        reachable_predecessors: list[list[typing.Optional[int]]],
+        reachable_predecessors: list[list[int | None]],
     ) -> ProjectedPoints:
         winner_indices: list[int] = [-1] * len(ppoints_list)
         predecessor = 0
@@ -799,7 +794,7 @@ class SnappedTripPoints:
         snapped_points: ProjectedPoints,
         methods: ArrayLike,
         reverse_order: bool,
-        distances: typing.Optional[np.ndarray] = None,
+        distances: np.ndarray | None = None,
     ):
         if len(snapped_points) != len(trip):
             raise ValueError("wrong number of snapped points for trip")

{pysnapping-0.2.3 → pysnapping-0.2.4}/pysnapping/test/test_snap.py

@@ -1,24 +1,24 @@
+import json
+import os
 import typing
+from functools import partial
+from itertools import product
+
 import numpy as np
-from numpy.testing import assert_allclose
-import pytest
 import pyproj
-from itertools import product
-from functools import partial
-import os
-import json
+import pytest
+from numpy.testing import assert_allclose
 
+from pysnapping import EPSG4326, EPSG4978
+from pysnapping.linear_referencing import interpolate, locate, resample
 from pysnapping.snap import (
     DubiousTrajectory,
     DubiousTrajectoryTrip,
     SnappingMethod,
     SnappingParams,
 )
-from pysnapping.linear_referencing import locate, interpolate, resample
 from pysnapping.stats import SnappingStats
 from pysnapping.util import get_trafo, transform_coords
-from pysnapping import EPSG4326, EPSG4978
-
 
 if typing.TYPE_CHECKING:
     from numpy.typing import ArrayLike

{pysnapping-0.2.3 → pysnapping-0.2.4}/pysnapping/test/test_util.py

@@ -1,7 +1,7 @@
 import numpy as np
 from numpy.testing import assert_equal
 
-from pysnapping.util import simplify_2d_keep_rest, cumulative_min_and_argmin
+from pysnapping.util import cumulative_min_and_argmin, simplify_2d_keep_rest
 
 
 def test_simplify() -> None:

{pysnapping-0.2.3 → pysnapping-0.2.4}/pysnapping/util.py

@@ -1,15 +1,14 @@
-import typing
 import logging
+import typing
 from functools import lru_cache
 
 import numpy as np
+import pyproj
 from numpy.typing import ArrayLike
 from shapely.geometry import LineString
-import pyproj
 
 from . import EPSG4978
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -33,7 +32,7 @@ def transform_coords(
         [np.ndarray, np.ndarray, np.ndarray],
         tuple[np.ndarray, np.ndarray, np.ndarray],
     ],
-    out: typing.Optional[np.ndarray] = None,
+    out: np.ndarray | None = None,
     skip_z_output: bool = False,
 ) -> np.ndarray:
     coords_arr = np.asarray(coords, dtype=float)
@@ -86,7 +85,7 @@ def simplify_2d_keep_rest(coords: ArrayLike, tolerance) -> np.ndarray:
 def array_chk(
     data: ArrayLike,
     shape_template: tuple[
-        typing.Union[None, int, tuple[typing.Optional[int], typing.Optional[int]]],
+        None | int | tuple[int | None, int | None],
         ...,
     ],
     chk_finite: bool = False,
@@ -112,11 +111,10 @@ def array_chk(
                     raise ValueError(
                         f"axis {i} has wrong length (expected at least {n_min}, got {n})"
                     )
-            elif n_max is not None:
-                if n > n_max:
-                    raise ValueError(
-                        f"axis {i} has wrong length (expected at most {n_max}, got {n})"
-                    )
+            elif n_max is not None and n > n_max:
+                raise ValueError(
+                    f"axis {i} has wrong length (expected at most {n_max}, got {n})"
+                )
     if chk_finite and not np.all(np.isfinite(arr)):
         raise ValueError("input not finite")
     return arr