rastr 0.1.0__tar.gz → 0.2.0__tar.gz

{rastr-0.1.0 → rastr-0.2.0}/.pre-commit-config.yaml

@@ -121,6 +121,15 @@ repos:
         language: python
         always_run: true
         pass_filenames: false
+  - repo: local
+    hooks:
+      - id: import-linter
+        name: import-linter
+        always_run: true
+        entry: uv run --frozen --offline lint-imports
+        language: system
+        pass_filenames: false
+        require_serial: true
   - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:

{rastr-0.1.0 → rastr-0.2.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: rastr
-Version: 0.1.0
+Version: 0.2.0
 Summary: Geospatial Raster datatype library for Python.
 Project-URL: Source Code, https://github.com/tonkintaylor/rastr
 Project-URL: Bug Tracker, https://github.com/tonkintaylor/rastr/issues
 Project-URL: Releases, https://github.com/tonkintaylor/rastr/releases
-Project-URL: Source Archive, https://github.com/tonkintaylor/rastr/archive/ac9cfaefef4030485d30ce79b97a000821338bd2.zip
-Author-email: Tonkin & Taylor Limited <Sub-DisciplineData+AnalyticsStaff@tonkintaylor.co.nz>, Nathan McDougall <nmcdougall@tonkintaylor.co.nz>
+Project-URL: Source Archive, https://github.com/tonkintaylor/rastr/archive/551d36604b84f947fffbe328e9e877732c9e35fb.zip
+Author-email: Tonkin & Taylor Limited <Sub-DisciplineData+AnalyticsStaff@tonkintaylor.co.nz>, Nathan McDougall <nmcdougall@tonkintaylor.co.nz>, Ben Karl <bkarl@tonkintaylor.co.nz>
 License-Expression: MIT
 License-File: LICENSE
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -41,4 +41,4 @@ Description-Content-Type: text/markdown
 
 Geospatial Raster datatype library for Python.
 
-Currently, only single-banded rasters with square cells are supported.
+Currently, only single-banded, in-memory rasters with square cells are supported.

{rastr-0.1.0 → rastr-0.2.0}/README.md

@@ -7,4 +7,4 @@
 
 Geospatial Raster datatype library for Python.
 
-Currently, only single-banded rasters with square cells are supported.
+Currently, only single-banded, in-memory rasters with square cells are supported.

{rastr-0.1.0 → rastr-0.2.0}/pyproject.toml

@@ -20,6 +20,7 @@ license-files = [ "LICENSE" ]
 authors = [
   { name = "Tonkin & Taylor Limited", email = "Sub-DisciplineData+AnalyticsStaff@tonkintaylor.co.nz" },
   { name = "Nathan McDougall", email = "nmcdougall@tonkintaylor.co.nz" },
+  { name = "Ben Karl", email = "bkarl@tonkintaylor.co.nz" },
 ]
 requires-python = ">=3.10"
 classifiers = [
@@ -53,6 +54,7 @@ dev = [
   "build>=1.2.2.post1",
   "deptry>=0.23.0",
   "folium>=0.20.0",
+  "import-linter>=2.3",
   "ipykernel>=6.30.0",
   "ipython>=8.37.0",
   "ipywidgets>=8.1.7",
@@ -177,6 +179,7 @@ lint.per-file-ignores."src/{scripts,notebooks}/**" = [
   "S101",    # Asserts fine in scripts and notebooks
   "T201",    # Prints fine in scripts and notebooks
 ]
+lint.per-file-ignores."tests/**" = [ "INP" ]
 lint.per-file-ignores."tests/**/*.py" = [
   "ANN",     # We don't need annotations in tests
   "D",       # We don't need docstrings in tests
@@ -245,3 +248,19 @@ output = "test-reports/coverage.xml"
 default-groups = [ "dev", "test", "doc" ]
 required-version = "==0.8.3"              # sync with .pre-commit-config.yaml and release.yml
 link-mode = "symlink"
+
+[tool.importlinter]
+root_packages = [ "rastr" ]
+
+[[tool.importlinter.contracts]]
+name = "rastr"
+type = "layers"
+layers = [
+  "create | io",
+  "raster",
+  "meta",
+  "arr | gis",
+  "_version",
+]
+containers = [ "rastr" ]
+exhaustive = true

{rastr-0.1.0 → rastr-0.2.0}/src/rastr/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.2.0'
+__version_tuple__ = version_tuple = (0, 2, 0)

{rastr-0.1.0 → rastr-0.2.0}/src/rastr/io.py

@@ -9,7 +9,7 @@ from rastr.meta import RasterMeta
 from rastr.raster import RasterModel
 
 
-def read_raster_inmem(raster_path: Path, crs: CRS | None = None) -> RasterModel:
+def read_raster_inmem(raster_path: Path | str, crs: CRS | None = None) -> RasterModel:
     """Read raster data from a file and return an in-memory Raster object."""
     with rasterio.open(raster_path, mode="r") as dst:
         # Read the entire array

{rastr-0.1.0 → rastr-0.2.0}/src/rastr/meta.py

@@ -11,6 +11,8 @@ class RasterMeta(BaseModel, extra="forbid"):
     Attributes:
         cell_size: Cell size in meters.
         crs: Coordinate reference system.
+        transform: The affine transformation associated with the raster. This is based
+                   on the CRS, the cell size, as well as the offset/origin.
     """
 
     cell_size: float

{rastr-0.1.0 → rastr-0.2.0}/src/rastr/raster.py

@@ -74,9 +74,10 @@ class RasterModel(BaseModel):
     __hash__ = BaseModel.__hash__
 
     def __add__(self, other: float | Self) -> Self:
+        cls = self.__class__
         if isinstance(other, float | int):
             new_arr = self.arr + other
-            return RasterModel(arr=new_arr, raster_meta=self.raster_meta)
+            return cls(arr=new_arr, raster_meta=self.raster_meta)
         elif isinstance(other, RasterModel):
             if self.raster_meta != other.raster_meta:
                 msg = (
@@ -91,7 +92,7 @@ class RasterModel(BaseModel):
                 )
                 raise ValueError(msg)
             new_arr = self.arr + other.arr
-            return RasterModel(arr=new_arr, raster_meta=self.raster_meta)
+            return cls(arr=new_arr, raster_meta=self.raster_meta)
         else:
             return NotImplemented
 
@@ -99,9 +100,10 @@ class RasterModel(BaseModel):
         return self + other
 
     def __mul__(self, other: float | Self) -> Self:
+        cls = self.__class__
         if isinstance(other, float | int):
             new_arr = self.arr * other
-            return RasterModel(arr=new_arr, raster_meta=self.raster_meta)
+            return cls(arr=new_arr, raster_meta=self.raster_meta)
         elif isinstance(other, RasterModel):
             if self.raster_meta != other.raster_meta:
                 msg = (
@@ -113,7 +115,7 @@ class RasterModel(BaseModel):
                 msg = "Rasters must have the same shape to be multiplied"
                 raise ValueError(msg)
             new_arr = self.arr * other.arr
-            return RasterModel(arr=new_arr, raster_meta=self.raster_meta)
+            return cls(arr=new_arr, raster_meta=self.raster_meta)
         else:
             return NotImplemented
 
@@ -121,9 +123,10 @@ class RasterModel(BaseModel):
         return self * other
 
     def __truediv__(self, other: float | Self) -> Self:
+        cls = self.__class__
         if isinstance(other, float | int):
             new_arr = self.arr / other
-            return RasterModel(arr=new_arr, raster_meta=self.raster_meta)
+            return cls(arr=new_arr, raster_meta=self.raster_meta)
         elif isinstance(other, RasterModel):
             if self.raster_meta != other.raster_meta:
                 msg = (
@@ -135,7 +138,7 @@ class RasterModel(BaseModel):
                 msg = "Rasters must have the same shape to be divided"
                 raise ValueError(msg)
             new_arr = self.arr / other.arr
-            return RasterModel(arr=new_arr, raster_meta=self.raster_meta)
+            return cls(arr=new_arr, raster_meta=self.raster_meta)
         else:
             return NotImplemented
 
@@ -149,7 +152,8 @@ class RasterModel(BaseModel):
         return -self + other
 
     def __neg__(self) -> Self:
-        return RasterModel(arr=-self.arr, raster_meta=self.raster_meta)
+        cls = self.__class__
+        return cls(arr=-self.arr, raster_meta=self.raster_meta)
 
     @property
     def cell_centre_coords(self) -> NDArray[np.float64]:
@@ -422,9 +426,11 @@ class RasterModel(BaseModel):
 
         return raster_gdf
 
-    def to_file(self, path: Path) -> None:
+    def to_file(self, path: Path | str) -> None:
         """Write the raster to a GeoTIFF file."""
 
+        path = Path(path)
+
         suffix = path.suffix.lower()
         if suffix in (".tif", ".tiff"):
             driver = "GTiff"
@@ -455,8 +461,9 @@ class RasterModel(BaseModel):
                 raise OSError(msg) from err
 
     def __str__(self) -> str:
+        cls = self.__class__
         mean = np.nanmean(self.arr)
-        return f"RasterModel(shape={self.arr.shape}, {mean=})"
+        return f"{cls.__name__}(shape={self.arr.shape}, {mean=})"
 
     def __repr__(self) -> str:
         return str(self)
@@ -619,6 +626,7 @@ class RasterModel(BaseModel):
 
         factor = self.raster_meta.cell_size / new_cell_size
 
+        cls = self.__class__
         # Use the rasterio dataset with proper context management
         with self.to_rasterio_dataset() as dataset:
             # N.B. the new height and width may increase slightly.
@@ -642,7 +650,7 @@ class RasterModel(BaseModel):
                 cell_size=new_cell_size,
             )
 
-            return RasterModel(arr=new_arr, raster_meta=new_raster_meta)
+            return cls(arr=new_arr, raster_meta=new_raster_meta)
 
     @field_validator("arr")
     @classmethod

{rastr-0.1.0 → rastr-0.2.0}/tests/rastr/test_raster.py

@@ -155,6 +155,31 @@ class TestRasterModel:
             # Assert
             np.testing.assert_array_equal(result.arr, np.array([[6, 8], [10, 12]]))
 
+        def test_add_subclass_return_type(self):
+            # Arrange
+            class MyRaster(RasterModel):
+                pass
+
+            raster_meta = RasterMeta(
+                cell_size=1.0,
+                crs=CRS.from_epsg(2193),
+                transform=Affine(1.0, 0.0, 0.0, 0.0, 1.0, 0.0),
+            )
+            raster1 = MyRaster(
+                arr=np.array([[1, 2], [3, 4]]),
+                raster_meta=raster_meta,
+            )
+            raster2 = MyRaster(
+                arr=np.array([[5, 6], [7, 8]]),
+                raster_meta=raster_meta,
+            )
+
+            # Act
+            result = raster1 + raster2
+
+            # Assert
+            assert isinstance(result, MyRaster)
+
         def test_crs_mismatch(self):
             # Arrange
             raster_meta1 = RasterMeta(
@@ -511,6 +536,16 @@ class TestRasterModel:
             # Assert
             assert filename.exists()
 
+        def test_string_as_path(self, tmp_path: Path, example_raster: RasterModel):
+            # Arrange
+            filename = tmp_path / "test_raster.tif"
+
+            # Act
+            example_raster.to_file(filename.as_posix())
+
+            # Assert
+            assert filename.exists()
+
     class TestPlot:
         def test_cell_array_unchanged(self, example_raster_with_zeros: RasterModel):
             # Arrange

{rastr-0.1.0 → rastr-0.2.0}/uv.lock

@@ -889,6 +889,21 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/cb/bd/b394387b598ed84d8d0fa90611a90bee0adc2021820ad5729f7ced74a8e2/imageio-2.37.0-py3-none-any.whl", hash = "sha256:11efa15b87bc7871b61590326b2d635439acc321cf7f8ce996f812543ce10eed", size = 315796, upload-time = "2025-01-20T02:42:34.931Z" },
 ]
 
+[[package]]
+name = "import-linter"
+version = "2.3"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "click" },
+    { name = "grimp" },
+    { name = "tomli", marker = "python_full_version < '3.11'" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/6e/f4/a3a4110b5b34cdb8553be7c60d66b0169624923bb0597d3fe6f655848a36/import_linter-2.3.tar.gz", hash = "sha256:863646106d52ee5489965670f97a2a78f2c8c68d2d20392322bf0d7cc0111aa7", size = 29321, upload-time = "2025-03-11T09:11:36.002Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/15/62/de70aac73cc7112fd9e582b92dd300d9152a6d40a1d6aad290198ebdb183/import_linter-2.3-py3-none-any.whl", hash = "sha256:5b851776782048ff1be214f1e407ef2e3d30dcb23194e8b852772941811a1258", size = 41584, upload-time = "2025-03-11T09:11:35.07Z" },
+]
+
 [[package]]
 name = "importlib-metadata"
 version = "8.7.0"
@@ -2542,6 +2557,7 @@ dev = [
     { name = "build" },
     { name = "deptry" },
     { name = "folium" },
+    { name = "import-linter" },
     { name = "ipykernel" },
     { name = "ipython", version = "8.37.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" },
     { name = "ipython", version = "9.4.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" },
@@ -2592,6 +2608,7 @@ dev = [
     { name = "build", specifier = ">=1.2.2.post1" },
     { name = "deptry", specifier = ">=0.23.0" },
     { name = "folium", specifier = ">=0.20.0" },
+    { name = "import-linter", specifier = ">=2.3" },
     { name = "ipykernel", specifier = ">=6.30.0" },
     { name = "ipython", specifier = ">=8.37.0" },
     { name = "ipywidgets", specifier = ">=8.1.7" },