msgspec-geojson 0.1.0__tar.gz

msgspec_geojson-0.1.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.3
+Name: msgspec-geojson
+Version: 0.1.0
+Summary: GeoJSON types for msgspec
+Author: Stanis Trendelenburg
+Author-email: Stanis Trendelenburg <st@trendels.name>
+Requires-Dist: msgspec>=0.20.1
+Requires-Python: >=3.13
+Project-URL: Source, https://github.com/trendels/msgspec-geojson
+Description-Content-Type: text/markdown
+
+# msgspec-geojson
+
+A collection of [GeoJSON] types for [msgspec].
+
+Inspired by the [msgspec GeoJSON example code][geojson_example] and [geojson-pydantic].
+
+[GeoJSON]: https://geojson.org
+[msgspec]: https://msgspec.dev/
+[geojson_example]: https://jcristharif.com/msgspec/examples/geojson.html
+[geojson-pydantic]: https://pypi.org/project/geojson-pydantic/
+
+This lets you parse GeoJSON into type-safe objects, including propeties, and
+serialize those objects back to GeoJSON:
+
+~~~python
+>>> import msgspec.json
+>>> from msgspec import Struct
+>>> from msgspec_geojson import Feature, Point
+
+>>> class PoiProperties(Struct):
+...    name: str
+...    kind: str
+
+>>> type PoiFeature = Feature[Point, PoiProperties]
+
+>>> obj = msgspec.json.decode("""
+...     {"type": "Feature", "id": 1,
+...      "properties": {"name": "Zoo Zürich", "kind": "tourism/zoo"},
+...      "geometry": {"type": "Point", "coordinates": [8.574695, 47.384510]}}
+... """, type=PoiFeature)
+
+>>> obj.id
+1
+>>> obj.geometry
+Point(coordinates=(8.574695, 47.38451))
+>>> obj.properties
+PoiProperties(name='Zoo Zürich', kind='tourism/zoo')
+
+>>> feature = Feature(
+...     Point(coordinates=(7.5823576, 47.5489249)),
+...     PoiProperties(name="Zoo Basel", kind="tourism/zoo"),
+... )
+>>> msgspec.json.encode(feature)
+b'{"type":"Feature","geometry":{"type":"Point","coordinates":[7.5823576,47.5489249]},"properties":{"name":"Zoo Basel","kind":"tourism/zoo"}}'
+
+~~~
+

msgspec_geojson-0.1.0/README.md

@@ -0,0 +1,47 @@
+# msgspec-geojson
+
+A collection of [GeoJSON] types for [msgspec].
+
+Inspired by the [msgspec GeoJSON example code][geojson_example] and [geojson-pydantic].
+
+[GeoJSON]: https://geojson.org
+[msgspec]: https://msgspec.dev/
+[geojson_example]: https://jcristharif.com/msgspec/examples/geojson.html
+[geojson-pydantic]: https://pypi.org/project/geojson-pydantic/
+
+This lets you parse GeoJSON into type-safe objects, including propeties, and
+serialize those objects back to GeoJSON:
+
+~~~python
+>>> import msgspec.json
+>>> from msgspec import Struct
+>>> from msgspec_geojson import Feature, Point
+
+>>> class PoiProperties(Struct):
+...    name: str
+...    kind: str
+
+>>> type PoiFeature = Feature[Point, PoiProperties]
+
+>>> obj = msgspec.json.decode("""
+...     {"type": "Feature", "id": 1,
+...      "properties": {"name": "Zoo Zürich", "kind": "tourism/zoo"},
+...      "geometry": {"type": "Point", "coordinates": [8.574695, 47.384510]}}
+... """, type=PoiFeature)
+
+>>> obj.id
+1
+>>> obj.geometry
+Point(coordinates=(8.574695, 47.38451))
+>>> obj.properties
+PoiProperties(name='Zoo Zürich', kind='tourism/zoo')
+
+>>> feature = Feature(
+...     Point(coordinates=(7.5823576, 47.5489249)),
+...     PoiProperties(name="Zoo Basel", kind="tourism/zoo"),
+... )
+>>> msgspec.json.encode(feature)
+b'{"type":"Feature","geometry":{"type":"Point","coordinates":[7.5823576,47.5489249]},"properties":{"name":"Zoo Basel","kind":"tourism/zoo"}}'
+
+~~~
+

msgspec_geojson-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "msgspec-geojson"
+version = "0.1.0"
+description = "GeoJSON types for msgspec"
+readme = "README.md"
+authors = [
+    { name = "Stanis Trendelenburg", email = "st@trendels.name" }
+]
+requires-python = ">=3.13"
+dependencies = [
+    "msgspec>=0.20.1",
+]
+
+[project.urls]
+Source = "https://github.com/trendels/msgspec-geojson"
+
+[build-system]
+requires = ["uv_build>=0.11.32,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "coverage>=7.15.3",
+    "pyright>=1.1.411",
+    "pytest>=9.0.0",
+    "ruff>=0.16.0",
+]
+
+[tool.ruff]
+include = [
+    "pyproject.toml",
+    "src/**/*.py",
+    "tests/**/*.py",
+    "examples/**/*.py",
+]
+
+[tool.ruff.format]
+preview = true
+
+[tool.ruff.lint]
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
+include = ["src", "tests", "examples"]
+strict = ["src", "tests", "examples"]
+reportUnnecessaryTypeIgnoreComment = true
+
+[tool.coverage.run]
+branch = true
+source = ["src"]
+
+[tool.coverage.report]
+exclude_also = [
+    "@overload$",
+    "raise NotImplementedError",
+]
+
+[tool.pytest]
+testpaths = ["tests"]
+verbosity_assertions = "2"
+addopts = ["--import-mode=importlib"]

msgspec_geojson-0.1.0/src/msgspec_geojson/__init__.py

@@ -0,0 +1,29 @@
+from ._types import (
+    Feature,
+    FeatureCollection,
+    GeoJSON,
+    Geometry,
+    GeometryCollection,
+    LineString,
+    MultiLineString,
+    MultiPoint,
+    MultiPolygon,
+    Point,
+    Polygon,
+    Position,
+)
+
+__all__ = [
+    "Feature",
+    "FeatureCollection",
+    "GeoJSON",
+    "Geometry",
+    "GeometryCollection",
+    "LineString",
+    "MultiLineString",
+    "MultiPoint",
+    "MultiPolygon",
+    "Point",
+    "Polygon",
+    "Position",
+]

msgspec_geojson-0.1.0/src/msgspec_geojson/_types.py

@@ -0,0 +1,77 @@
+from typing import Any
+
+from msgspec import UNSET, Struct, UnsetType
+
+type Position = tuple[float, float]
+
+
+class Point(Struct, tag=True):
+    """A GeoJSON Point Geometry"""
+
+    coordinates: Position
+
+
+class MultiPoint(Struct, tag=True):
+    """A GeoJSON MultiPoint Geometry"""
+
+    coordinates: list[Position]
+
+
+class LineString(Struct, tag=True):
+    """A GeoJSON LineString Geometry"""
+
+    coordinates: list[Position]
+
+
+class MultiLineString(Struct, tag=True):
+    """A GeoJSON MultiLineString Geometry"""
+
+    coordinates: list[list[Position]]
+
+
+class Polygon(Struct, tag=True):
+    """A GeoJSON Polygon Geometry"""
+
+    coordinates: list[list[Position]]
+
+
+class MultiPolygon(Struct, tag=True):
+    """A GeoJSON MultiPolygon Geometry"""
+
+    coordinates: list[list[list[Position]]]
+
+
+class GeometryCollection(Struct, tag=True):
+    """A GeoJSON GeometryCollection"""
+
+    geometries: list["Geometry"]
+
+
+type Geometry = (
+    Point
+    | MultiPoint
+    | LineString
+    | MultiLineString
+    | Polygon
+    | MultiPolygon
+    | GeometryCollection
+)
+
+
+class Feature[G: Geometry | None, T](Struct, tag=True):
+    """A GeoJSON Feature"""
+
+    geometry: G | None = None
+    properties: T | None = None
+    id: str | int | UnsetType = UNSET
+    bbox: tuple[float, float, float, float] | UnsetType = UNSET
+
+
+class FeatureCollection[G: Geometry | None, T](Struct, tag=True):
+    """A GeoJSON FeatureCollection"""
+
+    features: list[Feature[G, T]]
+    bbox: tuple[float, float, float, float] | UnsetType = UNSET
+
+
+type GeoJSON = Geometry | Feature[Geometry, Any] | FeatureCollection[Geometry, Any]