Maintenance

Author: loicgasser

.github/workflows/main.yml

@@ -12,37 +12,44 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
+          cache: "pip"
 
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
 
       - name: Install dependencies
         run: |
           sudo apt-get update -y
-          sudo apt-get install -y python-dev libgeos-dev
-          pip install -U pip setuptools
-          pip install -r dev-requirements.txt
+          sudo apt-get install -y python-dev-is-python3 libgeos-dev
+          pip install -e ".[dev]"
 
       - name: Lint
-        run: flake8
+        run: ruff check ./quantized_mesh_tile ./tests ./scripts
 
-      - name: Isort
-        run: isort --check-only --diff .
+      - name: "Lint Code (pylint)"
+        run: |
+          pylint quantized_mesh_tile tests
+      - name: Benchmark
+        run: |
+          python scripts/qmt_bench.py --vertices 50000 --triangles 100000 --iters 100
 
-      - name: Test
-        run: coverage run --source=quantized_mesh_tile setup.py test
+      - name: Test with pytest
+        run: |
+          echo "[run]
+          relative_files = True" > .coveragerc
+          pytest --cov-report term-missing --cov=. tests/
 
       - name: Coveralls
         uses: AndreMiras/coveralls-python-action@develop

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release to PyPI
+
+on:
+  ## when a release is published (not drafts)
+  release:
+    types: [published]
+
+# Permission can be added at job level or workflow level
+permissions:
+  id-token: write # This is required for requesting the JWT
+  contents: read # This is required for actions/checkout
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Build package
+        run: |
+          pip install build twine
+          python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_SECRET_KEY }}
+        run: |
+          twine upload dist/*

.gitignore

@@ -10,3 +10,8 @@ doc/build/
 .coverage
 .vscode
 .eggs
+.egg-info
+.ruff_cache
+.pytest_cache
+.vscode
+

CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.7.0] - 2025-02-05
+
+### Added
+
+- Custom exception classes for better error handling: `TerrainTileError`, `InvalidGeometryError`, `MissingDimensionError`
+- Benchmark script (`scripts/qmt_bench.py`) for performance testing encode/decode operations
+- Type hints in `bbsphere.py`
+- PyPI long description from README.md
+- Pip caching in CI workflow
+
+### Changed
+
+- **BREAKING**: Minimum Python version is now 3.9 (dropped support for Python 3.5-3.8)
+- **BREAKING**: Minimum dependency versions: `numpy>=2.0.0`, `shapely>=2.0.0`
+- Migrated from `setup.py` to `pyproject.toml` (PEP 517/518)
+- Replaced flake8/isort with ruff for linting
+- Updated GitHub Actions from v2 to v5
+- Switched test runner from nose to pytest
+- Improved vertex lookup performance by using tuples instead of string keys in `TerrainTopology`
+- Code style updates: double quotes, trailing commas, improved multi-line formatting
+
+### Fixed
+
+- Edge indices metadata incorrectly used `indexData32` instead of `EdgeIndices32` for 32-bit tiles
+- `BYTESPLIT` constant typo (was 65636, now correctly 65536)
+- Mutable default arguments in `encode()` function
+- Shadowing of `type` builtin in `utils.py`
+
+### Removed
+
+- Shapely speedups import (deprecated in Shapely 2.0, now always enabled)
+- Legacy `setup.py`, `setup.cfg`, `dev-requirements.txt`, and `requirements.txt` files
+
+## [0.6.1] - Previous release
+
+See [GitHub releases](https://github.com/loicgasser/quantized-mesh-tile/releases) for earlier versions.
+
+[Unreleased]: https://github.com/loicgasser/quantized-mesh-tile/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/loicgasser/quantized-mesh-tile/compare/v0.6.1...v0.7.0
+[0.6.1]: https://github.com/loicgasser/quantized-mesh-tile/releases/tag/v0.6.1

README.md

@@ -8,3 +8,7 @@ quantized-mesh-tile
 [Quantized-mesh-tile](https://github.com/AnalyticalGraphicsInc/quantized-mesh) is a Python encoder/decoder and topology builder for terrain tiles.
 
 Doc is hosted on Readthedocs: https://quantized-mesh-tile.readthedocs.io/en/latest/
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.

dev-requirements.txt

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=40.6.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quantized-mesh-tile"
+version = "0.7.0"
+description = "Quantized-Mesh format reader and writer"
+readme = "README.md"
+authors = [{ name = "Loïc Gasser", email = "loicgasser4@gmail.com" }]
+license = { text = "MIT" }
+classifiers = [
+  "Development Status :: Beta",
+  "Environment :: Plugins",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Intended Audience :: Information Technology",
+  "License :: OSI Approved :: MIT License",
+  "Topic :: Scientific/Engineering :: GIS",
+]
+requires-python = ">=3.9,<4.0"
+dependencies = ["numpy>=2.0.0", "shapely>=2.0.0"]
+
+[project.optional-dependencies]
+dev = [
+    "coveralls",
+    "mock",
+    "pylint",
+    "sphinx",
+    "sphinx_rtd_theme",
+    "sphinx-autobuild",
+    "ruff",
+    "pytest",
+    "pytest-cov",
+]
+
+[tool.ruff]
+src = ["quantized_mesh_tile", "tests", "scripts"]
+exclude = [
+  ".egg",
+  ".git",
+  ".tox",
+  ".venv",
+  "venv",
+  "_build",
+  "buck-out",
+  "build",
+  "dist",
+  "migrations",
+]
+line-length = 90
+
+[tool.pylint.messages_control]
+# W0511: Used when a warning note as FIXME or XXX is detected.
+disable = ['C', 'R', 'W0511']

pyproject.toml

@@ -5,19 +5,17 @@
 ---------
 """
 
-# Enable Shapely "speedups" if available
-# http://toblerity.org/shapely/manual.html#performance
-from shapely import speedups
-
 from .terrain import TerrainTile
 from .topology import TerrainTopology
 
-if speedups.available:
-    speedups.enable()
-
 
-def encode(geometries, bounds=[], autocorrectGeometries=False, hasLighting=False,
-           watermask=[]):
+def encode(
+    geometries,
+    bounds=None,
+    autocorrectGeometries=False,
+    hasLighting=False,
+    watermask=None,
+):
     """
     Function to convert geometries into a
     :class:`quantized_mesh_tile.terrain.TerrainTile` instance.
@@ -65,14 +63,26 @@ def encode(geometries, bounds=[], autocorrectGeometries=False, hasLighting=False
         Default is `[]`.
 
     """
-    topology = TerrainTopology(geometries=geometries,
-                               autocorrectGeometries=autocorrectGeometries,
-                               hasLighting=hasLighting)
+    if bounds is None:
+        bounds = []
+    if watermask is None:
+        watermask = []
+
+    topology = TerrainTopology(
+        geometries=geometries,
+        autocorrectGeometries=autocorrectGeometries,
+        hasLighting=hasLighting,
+    )
     if len(bounds) == 4:
         west, south, east, north = bounds
-        tile = TerrainTile(topology=topology,
-                           watermask=watermask,
-                           west=west, south=south, east=east, north=north)
+        tile = TerrainTile(
+            topology=topology,
+            watermask=watermask,
+            west=west,
+            south=south,
+            east=east,
+            north=north,
+        )
     else:
         tile = TerrainTile(topology=topology, watermask=watermask)
     return tile
@@ -109,5 +119,6 @@ def decode(filePath, bounds, hasLighting=False, hasWatermask=False, gzipped=Fals
     west, south, east, north = bounds
     tile = TerrainTile(west=west, south=south, east=east, north=north)
     tile.fromFile(
-        filePath, hasLighting=hasLighting, hasWatermask=hasWatermask, gzipped=gzipped)
+        filePath, hasLighting=hasLighting, hasWatermask=hasWatermask, gzipped=gzipped
+    )
     return tile

quantized_mesh_tile/__init__.py

@@ -1,17 +1,20 @@
 # -*- coding: utf-8 -*-
 
 import math
+from typing import List
+
+from quantized_mesh_tile.exceptions import TerrainTileError
 
 from . import cartesian3d as c3d
 
 
 class BoundingSphere(object):
-    def __init__(self, *args, **kwargs):
-        MAX = float('infinity')
-        MIN = float('-infinity')
+    def __init__(self, *_, **kwargs):
+        MAX = float("infinity")
+        MIN = float("-infinity")
 
-        self.center = kwargs.get('center', [])
-        self.radius = kwargs.get('radius', 0)
+        self.center = kwargs.get("center", [])
+        self.radius = kwargs.get("radius", 0)
         self.minPointX = [MAX, MAX, MAX]
         self.minPointY = [MAX, MAX, MAX]
         self.minPointZ = [MAX, MAX, MAX]
@@ -20,11 +23,10 @@ def __init__(self, *args, **kwargs):
         self.maxPointZ = [MIN, MIN, MIN]
 
     # Based on Ritter's algorithm
-    def fromPoints(self, points):
-
+    def fromPoints(self, points: List):
         nbPositions = len(points)
         if nbPositions < 2:
-            raise Exception('Your list of points must contain at least 2 points')
+            raise TerrainTileError("Your list of points must contain at least 2 points")
 
         for i in range(0, nbPositions):
             point = points[i]
@@ -69,7 +71,7 @@ def fromPoints(self, points):
         ritterCenter = [
             (diameter1[0] + diameter2[0]) * 0.5,
             (diameter1[1] + diameter2[1]) * 0.5,
-            (diameter1[2] + diameter2[2]) * 0.5
+            (diameter1[2] + diameter2[2]) * 0.5,
         ]
 
         radiusSquared = c3d.magnitudeSquared(c3d.subtract(diameter2, ritterCenter))
@@ -99,12 +101,12 @@ def fromPoints(self, points):
                 # Calculate center of new Ritter sphere
                 oldToNew = oldCenterToPoint - ritterRadius
                 ritterCenter = [
-                    (ritterRadius * ritterCenter[0] +
-                     oldToNew * currentP[0]) / oldCenterToPoint,
-                    (ritterRadius * ritterCenter[1] +
-                     oldToNew * currentP[1]) / oldCenterToPoint,
-                    (ritterRadius * ritterCenter[2] +
-                     oldToNew * currentP[2]) / oldCenterToPoint
+                    (ritterRadius * ritterCenter[0] + oldToNew * currentP[0])
+                    / oldCenterToPoint,
+                    (ritterRadius * ritterCenter[1] + oldToNew * currentP[1])
+                    / oldCenterToPoint,
+                    (ritterRadius * ritterCenter[2] + oldToNew * currentP[2])
+                    / oldCenterToPoint,
                 ]
 
         # Keep the naive sphere if smaller

quantized_mesh_tile/bbsphere.py

@@ -0,0 +1,10 @@
+class TerrainTileError(Exception):
+    """Base class for exceptions in this module."""
+
+
+class InvalidGeometryError(ValueError):
+    """Exception raised for invalid geometries."""
+
+
+class MissingDimensionError(ValueError):
+    """Exception raised for missing dimensions in geometries."""