Merge branch 'master' into pyshp-3.0.0-mypy-strict

Author: JamesParrott

.gitignore

@@ -1,18 +1,26 @@
 shapefile_[a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9].dbf
 shapefile_[a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9].shp
 shapefile_[a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9][a-zA-Z0-9].shx
-shapefiles/test/copy.dbf
-shapefiles/test/copy.shp
-shapefiles/test/copy.shx
-shapefiles/test/geojson.dbf
-shapefiles/test/geojson.shp
-shapefiles/test/geojson.shx
-shapefiles/test/latin_as_utf8.dbf
-shapefiles/test/latin_as_utf8.shp
-shapefiles/test/latin_as_utf8.shx
-shapefiles/test/null.dbf
-shapefiles/test/null.shp
-shapefiles/test/null.shx
+shapefiles/test/testfile.*
+shapefiles/test/onlydbf.*
+shapefiles/test/contextwriter.*
+shapefiles/test/shapetype.*
+shapefiles/test/dtype.*
+shapefiles/test/null.*
+shapefiles/test/point.*
+shapefiles/test/line.*
+shapefiles/test/linem
+shapefiles/test/linez.*.*
+shapefiles/test/multipoint.*
+shapefiles/test/polygon.*
+shapefiles/test/multipatch.*
+shapefiles/test/copy.*
+shapefiles/test/balancing.*
+shapefiles/test/latin_as_utf8.*
+shapefiles/test/corrupt_too_long.*
+shapefiles/test/MyPolyZ.*
+shapefiles/test/NullTest.*
+shapefiles/test/geojson.*
 __pycache__/
 __cache__/
 build/

LICENSE.TXT

@@ -1,8 +1,8 @@
 The MIT License (MIT)
 
-Copyright � 2013 Joel Lawhead
+Copyright © 2013 Joel Lawhead
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the �Software�), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 

README.md

@@ -8,7 +8,7 @@ The Python Shapefile Library (PyShp) reads and writes ESRI Shapefiles in pure Py
 
 - **Author**: [Joel Lawhead](https://github.com/GeospatialPython)
 - **Maintainers**: [Karim Bahgat](https://github.com/karimbahgat)
-- **Version**: 3.0.0-alpha
+- **Version**: 3.0.0
 - **Date**: 3rd August, 2025
 - **License**: [MIT](https://github.com/GeospatialPython/pyshp/blob/master/LICENSE.TXT)
 
@@ -93,7 +93,7 @@ part of your geospatial project.
 
 # Version Changes
 
-## 3.0.0-alpha
+## 3.0.0
 
 ### Breaking Changes:
 - Python 2 and Python 3.8 support dropped.

changelog.txt

@@ -1,7 +1,8 @@
+VERSION Next
 	Improvements:
 	* LICENSE.TXT re-encoded in UTF-8 (@musicinmybrain)
 
-VERSION 3.0.0-alpha
+VERSION 3.0.0
 
 2025-08-03
 	Breaking Changes:

src/shapefile.py

@@ -8,7 +8,7 @@
 
 from __future__ import annotations
 
-__version__ = "3.0.0-alpha"
+__version__ = "3.0.0"
 
 import array
 import doctest
@@ -325,7 +325,10 @@ class GeoJSONFeatureCollection(TypedDict):
 
 
 class GeoJSONFeatureCollectionWithBBox(GeoJSONFeatureCollection):
-    # bbox is technically optional under the spec
+    # bbox is technically optional under the spec but this seems
+    # a very minor improvement that would require NotRequired
+    # from the typing-extensions backport for Python 3.9
+    # (PyShp's resisted having any other dependencies so far!)
     bbox: list[float]
 
 
@@ -726,6 +729,11 @@ def __init__(
         are designated by their starting index in geometry record's
         list of shapes. For MultiPatch geometry, partTypes designates
         the patch type of each of the parts.
+        Lines allows the points-lists and parts to be denoted together
+        in one argument.  It is intended for multiple point shapes
+        (polylines, polygons and multipatches) but if used as a length-1
+        nested list for a multipoint (instead of points for some reason)
+        PyShp will not complain, as multipoints only have 1 part internally.
         """
 
         # Preserve previous behaviour for anyone who set self.shapeType = None
@@ -741,7 +749,6 @@ def __init__(
         default_points: PointsT = []
         default_parts: list[int] = []
 
-        # Make sure polygon rings (parts) are closed
         if lines is not None:
             if self.shapeType in Polygon_shapeTypes:
                 lines = list(lines)
@@ -1072,7 +1079,7 @@ def __repr__(self) -> str:
 class NullShape(Shape):
     # Shape.shapeType = NULL already,
     # to preserve handling of default args in Shape.__init__
-    # Repeated for clarity.
+    # Repeated for the avoidance of doubt.
     def __init__(
         self,
         oid: Optional[int] = None,
@@ -1117,8 +1124,8 @@ def write_to_byte_stream(
 
 class _CanHaveBBox(Shape):
     """As well as setting bounding boxes, we also utilize the
-    fact that this mixin applies to all the shapes that are
-    not a single point.
+    fact that this mixin only applies to all the shapes that are
+    not a single point (polylines, polygons, multipatches and multipoints).
     """
 
     @staticmethod
@@ -1203,10 +1210,6 @@ def from_byte_stream(
                     b_io, nParts
                 )
 
-        # else:
-        #     parts = None
-        #     partTypes = None
-
         if nPoints:
             kwargs["points"] = cast(
                 PointsT, cls._read_points_from_byte_stream(b_io, nPoints)
@@ -1222,25 +1225,7 @@ def from_byte_stream(
                     b_io, nPoints, next_shape
                 )
 
-        # else:
-        #     points = None
-        #     zbox, zs = None, None
-        #     mbox, ms = None, None
-
         return ShapeClass(**kwargs)
-        # return ShapeClass(
-        #     shapeType=shapeType,
-        #     # Mypy 1.17.1 doesn't figure out that an Optional[list[Point2D]] is an Optional[list[PointT]]
-        #     points=cast(Optional[PointsT], points),
-        #     parts=parts,
-        #     partTypes=partTypes,
-        #     oid=oid,
-        #     m=ms,
-        #     z=zs,
-        #     bbox=shape_bbox,
-        #     mbox=mbox,
-        #     zbox=zbox,
-        # )
 
     @staticmethod
     def write_to_byte_stream(
@@ -1249,7 +1234,7 @@ def write_to_byte_stream(
         i: int,
     ) -> int:
         # We use static methods here and below,
-        # to support s only being an instance of a the
+        # to support s only being an instance of the
         # Shape base class (with shapeType set)
         # i.e. not necessarily one of our newer shape specific
         # sub classes.
@@ -2368,6 +2353,10 @@ def __init__(
                     # Close and delete the temporary zipfile
                     try:
                         zipfileobj.close()
+                        # TODO Does catching all possible exceptions really increase
+                        # the chances of closing the zipfile successully, or does it
+                        # just mean .close() failures will still fail, but fail
+                        # silently?
                     except:  # noqa: E722
                         pass
                     # Try to load shapefile
@@ -3610,15 +3599,16 @@ def shape(
         # Check is shape or import from geojson
         if not isinstance(s, Shape):
             if hasattr(s, "__geo_interface__"):
-                s = s.__geo_interface__  # type: ignore [assignment]
+                shape_dict = cast(dict, s.__geo_interface__)
             if isinstance(s, dict):
-                s = Shape._from_geojson(cast(GeoJSONHomogeneousGeometryObject, s))
+                shape_dict = Shape._from_geojson(cast(GeoJSONHomogeneousGeometryObject, s))
             else:
                 raise TypeError(
                     "Can only write Shape objects, GeoJSON dictionaries, "
                     "or objects with the __geo_interface__, "
                     f"not: {s}"
                 )
+            s = Shape._from_geojson(shape_dict)
         # Write to file
         offset, length = self.__shpRecord(s)
         if self.shx:
@@ -3660,7 +3650,8 @@ def __shpRecord(self, s: Shape) -> tuple[int, int]:
         # Record number, Content length place holder
         b_io.write(pack(">2i", self.shpNum, -1))
 
-        # Track number of content bytes written.  Excluding self.shpNum and length t.b.c.
+        # Track number of content bytes written, excluding
+        # self.shpNum and length (t.b.c.)
         n = 0
 
         n += b_io.write(pack("<i", s.shapeType))
@@ -4022,7 +4013,7 @@ def _filter_network_doctests(
 
 def _replace_remote_url(
     old_url: str,
-    # Default port of Python http.server and Python 2's SimpleHttpServer
+    # Default port of Python http.server
     port: int = 8000,
     scheme: str = "http",
     netloc: str = "localhost",