Merge pull request #19 from nens/shapely-support

daanvaningen · web-flow · commit 12e8b9ea11e1 · 2025-04-11T16:35:27.000+02:00
add shapely support
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -6,12 +6,20 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: "3.10"
 
-      - name: Run black, flake8 and isort
-        uses: pre-commit/action@v2.0.3
+      - name: Get changed files
+        id: changed_files
+        uses: tj-actions/changed-files@bab30c2299617f6615ec02a68b9a40d10bd21366 # v45.0.5
+        with:
+          files_ignore: "**/migrations/*"
+
+      - name: Run pre-commit checks
+        uses: pre-commit/action@576ff52938d158a24ac7e009dfa94b1455e7df99 # v3.0.1
+        with:
+          extra_args: --files ${{ steps.changed_files.outputs.all_changed_files }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,44 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Upload Github release
+      uses: softprops/action-gh-release@v2
+      with:
+        files: dist/*
+        body: "Release for ${{ github.ref }}"
+
+    - name: Test install built package
+      run: |
+        pip install dist/*.whl
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_UPLOAD_TOKEN }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -29,10 +29,6 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - display_name: "2020"
-            python: 3.9
-            os: ubuntu-22.04
-            pins: ""
           - display_name: "2021"
             python: '3.10'
             os: ubuntu-22.04
@@ -64,8 +60,8 @@ jobs:
       - name: Install python dependencies
         shell: bash
         run: |
-          pip install --disable-pip-version-check --upgrade pip setuptools wheel
-          pip install -e .[numpy,test] ${{ matrix.pins }} ipython pytest pytest-asyncio flake8 
+          pip install --disable-pip-version-check --upgrade pip
+          pip install -e .[numpy,shapely,test] ${{ matrix.pins }}
           pip list
 
       - name: Run tests
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,19 +1,11 @@
 default_language_version:
   python: python3
 repos:
-- repo: https://github.com/pycqa/isort
-  rev: '5.13.2'
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.7.3
   hooks:
-  - id: isort
-    exclude: 'settings'
-- repo: https://github.com/psf/black
-  rev: '23.12.0'
-  hooks:
-  - id: black
-    exclude: 'migrations*|urls*|settings*|setup.py'
-- repo: https://github.com/pycqa/flake8
-  rev: '6.1.0'
-  hooks:
-  - id: flake8
-    # NB The "exclude" setting in setup.cfg is ignored by pre-commit
-    exclude: 'migrations*|urls*|settings*'
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff  # isort
+      args: ["check", "--select", "I", "--fix"]
+    - id: ruff-format
diff --git a/Dockerfile b/Dockerfile
@@ -1,10 +1,10 @@
-FROM python:3.8
+FROM python:3.10
 
 LABEL maintainer='jelle.prins <jelle.prins@nelen-schuurmans.nl>'
-LABEL py_version='3.8'
+LABEL py_version='3.10'
 
 # Change the date to force rebuilding the whole image.
-ENV REFRESHED_AT 2023-12-19
+ENV REFRESHED_AT 2025-04-11
 
 WORKDIR /code
 COPY requirements.txt /code/
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,7 +1,7 @@
 0.2.1 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Add Shapely Geometry support.
 
 
 0.2.0 (2024-01-02)
diff --git a/README.rst b/README.rst
@@ -23,7 +23,7 @@ Overview
 Features
 --------
  - Asyncio RPC client/server
- - Msgpack serialization with option to use own dataclasses (Python 3.8)
+ - Msgpack serialization with option to use own dataclasses (Python 3.10)
  - Redis communication layer
  - Other serialization methods and communication layers can be added
 
@@ -40,4 +40,4 @@ The examples can be run from this directory, for the dataclass example
 
 Testing
 -------
-    >>> docker-compose run pytest --cov=asyncio_rpc --cov-report=html
+    >>> docker compose run asyncio_rpc pytest --cov=asyncio_rpc --cov-report=html
diff --git a/asyncio_rpc/commlayers/redis.py b/asyncio_rpc/commlayers/redis.py
@@ -3,7 +3,7 @@
 
 import redis.asyncio as async_redis
 
-from ..models import RPCBase, RPCResult, RPCStack, SERIALIZABLE_MODELS
+from ..models import SERIALIZABLE_MODELS, RPCBase, RPCResult, RPCStack
 from .base import AbstractRPCCommLayer
 
 RESULT_EXPIRE_TIME = 300  # seconds
diff --git a/asyncio_rpc/serialization/base.py b/asyncio_rpc/serialization/base.py
@@ -0,0 +1,21 @@
+from abc import ABC, abstractmethod
+from typing import Any
+
+
+class AbstractHandler(ABC):
+    ext_type: int = None  # Unique int
+    obj_type: Any = None  # Unique object type
+
+    @classmethod
+    @abstractmethod
+    def packb(cls, instance: Any) -> bytes:
+        """
+        Pack the instance into bytes
+        """
+
+    @classmethod
+    @abstractmethod
+    def unpackb(cls, data: bytes) -> Any:
+        """
+        Unpack the data back into an instance
+        """
diff --git a/asyncio_rpc/serialization/msgpack.py b/asyncio_rpc/serialization/msgpack.py
@@ -1,5 +1,4 @@
 import dataclasses
-from abc import ABC, abstractmethod
 from datetime import datetime
 from io import BytesIO
 from typing import Any
@@ -8,6 +7,8 @@
 from lz4.frame import compress as lz4_compress
 from lz4.frame import decompress as lz4_decompress
 
+from asyncio_rpc.serialization.base import AbstractHandler
+
 try:
     import numpy as np
 except ImportError:
@@ -49,25 +50,6 @@ def register(obj_def):
         REGISTRY["ext_types"][obj_def.ext_type] = obj_def
 
 
-class AbstractHandler(ABC):
-    ext_type: int = None  # Unique int
-    obj_type: Any = None  # Unique object type
-
-    @classmethod
-    @abstractmethod
-    def packb(cls, instance: Any) -> bytes:
-        """
-        Pack the instance into bytes
-        """
-
-    @classmethod
-    @abstractmethod
-    def unpackb(cls, data: bytes) -> Any:
-        """
-        Unpack the data back into an instance
-        """
-
-
 if np is not None:
 
     class NumpyArrayHandler(AbstractHandler):
@@ -202,11 +184,6 @@ def unpackb(cls, data):
         return slice(*loadb(data))
 
 
-# Register custom handlers
-register(DatetimeHandler)
-register(SliceHandler)
-
-
 def default(obj: Any):
     """
     Serialize (dumpb) hook for obj types that msgpack does not
@@ -277,3 +254,33 @@ def loadb(
         raw=raw,
         strict_map_key=strict_map_key,
     )
+
+
+# Register custom handlers
+register(DatetimeHandler)
+register(SliceHandler)
+
+
+try:
+    from asyncio_rpc.serialization.shapely_models import (
+        GeometryCollectionHandler,
+        LinearRingHandler,
+        LineStringHandler,
+        MultiLineStringHandler,
+        MultiPointHandler,
+        MultiPolygonHandler,
+        PointHandler,
+        PolygonHandler,
+    )
+
+    register(PointHandler)
+    register(LineStringHandler)
+    register(LinearRingHandler)
+    register(PolygonHandler)
+    register(MultiPointHandler)
+    register(MultiLineStringHandler)
+    register(MultiPolygonHandler)
+    register(GeometryCollectionHandler)
+except ImportError:
+    # Shapely is not installed, skip shapely handlers
+    pass
diff --git a/asyncio_rpc/serialization/shapely_models.py b/asyncio_rpc/serialization/shapely_models.py
@@ -0,0 +1,87 @@
+try:
+    import shapely as shp
+    from shapely.geometry import (
+        GeometryCollection,
+        LinearRing,
+        LineString,
+        MultiLineString,
+        MultiPoint,
+        MultiPolygon,
+        Point,
+        Polygon,
+    )
+    from shapely.geometry.base import BaseGeometry
+    from shapely.wkb import dumps, loads
+
+    from asyncio_rpc.serialization.base import AbstractHandler
+except ImportError:
+    shp = None
+
+
+if shp is not None:
+
+    class ShapelyBaseHandler(AbstractHandler):
+        """
+        Base handler for all Shapely geometry objects.
+        Uses WKB (Well-Known Binary) format for serialization.
+        """
+
+        ext_type = 100  # Starting ext_type for Shapely objects
+
+        @classmethod
+        def packb(cls, geom: BaseGeometry) -> bytes:
+            """Pack a shapely geometry into bytes using WKB format"""
+            return dumps(geom)
+
+        @classmethod
+        def unpackb(cls, data: bytes):
+            """Unpack bytes into a shapely geometry using WKB format"""
+            return loads(data)
+
+    class PointHandler(ShapelyBaseHandler):
+        """Handler for Shapely Point objects"""
+
+        ext_type = 101
+        obj_type = Point
+
+    class LineStringHandler(ShapelyBaseHandler):
+        """Handler for Shapely LineString objects"""
+
+        ext_type = 102
+        obj_type = LineString
+
+    class LinearRingHandler(ShapelyBaseHandler):
+        """Handler for Shapely LinearRing objects"""
+
+        ext_type = 103
+        obj_type = LinearRing
+
+    class PolygonHandler(ShapelyBaseHandler):
+        """Handler for Shapely Polygon objects"""
+
+        ext_type = 104
+        obj_type = Polygon
+
+    class MultiPointHandler(ShapelyBaseHandler):
+        """Handler for Shapely MultiPoint objects"""
+
+        ext_type = 105
+        obj_type = MultiPoint
+
+    class MultiLineStringHandler(ShapelyBaseHandler):
+        """Handler for Shapely MultiLineString objects"""
+
+        ext_type = 106
+        obj_type = MultiLineString
+
+    class MultiPolygonHandler(ShapelyBaseHandler):
+        """Handler for Shapely MultiPolygon objects"""
+
+        ext_type = 107
+        obj_type = MultiPolygon
+
+    class GeometryCollectionHandler(ShapelyBaseHandler):
+        """Handler for Shapely GeometryCollection objects"""
+
+        ext_type = 108
+        obj_type = GeometryCollection
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -4,6 +4,11 @@
 Installation
 ============
 
+Requirements
+-----------
+
+asyncio-rpc requires Python 3.10 or higher.
+
 Stable release
 --------------
 
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements.in b/requirements.in
diff --git a/requirements.txt b/requirements.txt
diff --git a/setup.py b/setup.py
diff --git a/tests/test_shapely_serialization.py b/tests/test_shapely_serialization.py
