geojson-msgspec 1.0.0__py3-none-any.whl

geojson_msgspec/__init__.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from typing import Optional, Union
+
+import msgspec
+
+Position = tuple[float, float]
+
+
+# Define the 7 standard Geometry types.
+# All types set `tag=True`, meaning that they'll make use of a `type` field to
+# disambiguate between types when decoding.
+class Point(msgspec.Struct, tag=True):
+    coordinates: Position
+
+
+class MultiPoint(msgspec.Struct, tag=True):
+    coordinates: list[Position]
+
+
+class LineString(msgspec.Struct, tag=True):
+    coordinates: list[Position]
+
+
+class MultiLineString(msgspec.Struct, tag=True):
+    coordinates: list[list[Position]]
+
+
+class Polygon(msgspec.Struct, tag=True):
+    coordinates: list[list[Position]]
+
+
+class MultiPolygon(msgspec.Struct, tag=True):
+    coordinates: list[list[list[Position]]]
+
+
+class GeometryCollection(msgspec.Struct, tag=True):
+    geometries: list[Geometry]
+
+
+Geometry = Union[
+    Point,
+    MultiPoint,
+    LineString,
+    MultiLineString,
+    Polygon,
+    MultiPolygon,
+    GeometryCollection,
+]
+
+
+# Define the two Feature types
+class Feature(msgspec.Struct, tag=True):
+    geometry: Optional[Geometry] = None
+    properties: Optional[dict] = None
+    id: Union[str, int, None] = None
+
+
+class FeatureCollection(msgspec.Struct, tag=True):
+    features: list[Feature]
+
+
+# A union of all 9 GeoJSON types
+GeoJSON = Union[Geometry, Feature, FeatureCollection]
+
+
+# Create a decoder and an encoder to use for decoding & encoding GeoJSON types
+loads = msgspec.json.Decoder(GeoJSON).decode
+dumps = msgspec.json.Encoder().encode

geojson_msgspec-1.0.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: geojson-msgspec
+Version: 1.0.0
+Summary: msgspec GeoJSON model
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: msgspec<0.20,>=0.19
+Description-Content-Type: text/x-rst
+
+This project contains code published as an example in the `msgspec project <https://jcristharif.com/msgspec/>`
+backported to python 3.8.
+
+GeoJSON
+=======
+
+`GeoJSON <https://geojson.org>`__ is a popular format for encoding geographic
+data. Its specification_ describes nine different types a message may take
+(seven "geometry" types, plus two "feature" types). Here we provide one way of
+implementing that specification using ``msgspec`` to handle the parsing and
+validation.
+
+The ``loads`` and ``dumps`` methods defined below work similar to the
+standard library's ``json.loads``/``json.dumps``, but:
+
+- Will result in high-level `msgspec.Struct` objects representing GeoJSON types
+- Will error nicely if a field is missing or the wrong type
+- Will fill in default values for optional fields
+- Decodes and encodes *significantly faster* than the `json` module (as well as
+  most other ``json`` implementations in Python).
+
+This example makes use `msgspec.Struct` types to define the different GeoJSON
+types, and `struct-tagged-unions`_ to differentiate between them. See the
+relevant docs for more information.
+
+The original source code can be found `here
+<https://github.com/jcrist/msgspec/blob/main/examples/geojson>`__.
+
+Here we use the ``loads`` method defined above to read some `example GeoJSON`_.
+
+.. code-block:: ipython3
+
+    In [1]: import msgspec_geojson
+
+    In [2]: with open("canada.json", "rb") as f:
+       ...:     data = f.read()
+
+    In [3]: canada = msgspec_geojson.loads(data)
+
+    In [4]: type(canada)  # loaded as high-level, validated object
+    Out[4]: msgspec_geojson.FeatureCollection
+
+    In [5]: canada.features[0].properties
+    Out[5]: {'name': 'Canada'}
+
+Comparing performance to:
+
+- orjson_
+- `json`
+- geojson_ (another validating Python implementation)
+
+.. code-block:: ipython3
+
+   In [6]: %timeit msgspec_geojson.loads(data)  # benchmark msgspec
+   6.15 ms ± 13.8 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
+
+   In [7]: %timeit orjson.loads(data)  # benchmark orjson
+   8.67 ms ± 20.8 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
+
+   In [8]: %timeit json.loads(data)  # benchmark json
+   27.6 ms ± 102 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)
+
+   In [9]: %timeit geojson.loads(data)  # benchmark geojson
+   93.9 ms ± 88.1 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)
+
+
+This shows that the readable ``msgspec`` implementation above is 1.4x faster
+than `orjson` (on this data), while also ensuring the loaded data is valid
+GeoJSON.  Compared to geojson_ (another validating geojson library for python),
+loading the data using ``msgspec`` was **15.3x faster**.
+
+.. _specification: https://datatracker.ietf.org/doc/html/rfc7946
+.. _example GeoJSON: https://github.com/jcrist/msgspec/blob/main/examples/geojson/canada.json
+.. _orjson: https://github.com/ijl/orjson
+.. _geojson: https://github.com/jazzband/geojson
+.. _struct-tagged-unions: https://jcristharif.com/msgspec/structs.html#tagged-unions

geojson_msgspec-1.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+geojson_msgspec/__init__.py,sha256=hDml1Az1-gYSE4sq17RPeZ_nYq-FiTdmcF1VhYfaino,1516
+geojson_msgspec/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geojson_msgspec-1.0.0.dist-info/METADATA,sha256=a5H_4sswy30SK6LHoxN5Nk9R8l0NqrUV_lVSzLuyBFk,3201
+geojson_msgspec-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+geojson_msgspec-1.0.0.dist-info/licenses/LICENSE,sha256=_nsuUQimpd3yN3sWXGdZazApGxJJvfgAproYa-LATfA,1548
+geojson_msgspec-1.0.0.dist-info/RECORD,,

geojson_msgspec-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

geojson_msgspec-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2021, Jim Crist-Harif
+Copyright (c) 2024, Rafał Krupiński, öKlo GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.