Skip to content

Fix rasterio rowcol operation return type #16352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryux1 wants to merge 1 commit into
base: main
Choose a base branch
from
+79 −7
Open

Fix rasterio rowcol operation return type #16352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions stubs/rasterio/@tests/test_cases/check_transform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
from typing_extensions import assert_type

from affine import Affine
from rasterio.transform import TransformMethodsMixin, rowcol

transform = Affine.identity()

assert_type(rowcol(transform, 0.5, 0.5), tuple[int, int] | tuple[list[int], list[int]])
assert_type(rowcol(transform, 0.5, 0.5, op=lambda value: value), tuple[float, float] | tuple[list[float], list[float]])

mixin = TransformMethodsMixin()
assert_type(mixin.index(0.5, 0.5, op=lambda value: value), tuple[int, int] | tuple[list[int], list[int]])
74 changes: 67 additions & 7 deletions stubs/rasterio/rasterio/transform.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from _typeshed import ConvertibleToInt
from collections.abc import Callable, Sequence
from typing import Final, Literal, TypeAlias, overload
from typing_extensions import Self, deprecated
from typing_extensions import Self, TypeVar, deprecated

from affine import Affine as Affine
from rasterio._transform import GCPTransformerBase, RPCTransformerBase
Expand All @@ -12,7 +13,8 @@ from rasterio.rpc import RPC

_Sextuple: TypeAlias = tuple[float, float, float, float, float, float]
_OffsetOptions: TypeAlias = Literal["center", "ul", "ur", "ll", "lr"]
_RoundOperation: TypeAlias = Callable[[float], int]
_T = TypeVar("_T")
_RoundOperation: TypeAlias = Callable[[float], _T]

IDENTITY: Final[Affine]
GDAL_IDENTITY: Final[_Sextuple]
Expand All @@ -32,7 +34,7 @@ class TransformMethodsMixin:
x: float | Sequence[float],
y: float | Sequence[float],
z: float | Sequence[float] | None = None,
op: _RoundOperation | None = None,
op: _RoundOperation[ConvertibleToInt] | None = None,
precision: int | None = None,
transform_method: TransformMethod = ...,
**rpc_options: _GDALOption,
Expand All @@ -52,15 +54,39 @@ def xy(
offset: _OffsetOptions = "center",
**rpc_options: _GDALOption,
) -> tuple[float, float] | tuple[list[float], list[float]]: ...

@overload
def rowcol(
transform: Affine | Sequence[GroundControlPoint] | RPC,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None = None,
op: _RoundOperation | None = None,
op: None = None,
precision: int | None = None,
**rpc_options: _GDALOption,
) -> tuple[int, int] | tuple[list[int], list[int]]: ...
@overload
def rowcol(
transform: Affine | Sequence[GroundControlPoint] | RPC,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None,
op: _RoundOperation[_T],
precision: int | None = None,
**rpc_options: _GDALOption,
) -> tuple[_T, _T] | tuple[list[_T], list[_T]]: ...
@overload
def rowcol(
transform: Affine | Sequence[GroundControlPoint] | RPC,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None = None,
*,
op: _RoundOperation[_T],
precision: int | None = None,
**rpc_options: _GDALOption,
) -> tuple[_T, _T] | tuple[list[_T], list[_T]]: ...

def get_transformer(
transform: Affine | Sequence[GroundControlPoint] | RPC, **rpc_options: _GDALOption
) -> type[TransformerBase]: ...
Expand All @@ -77,24 +103,58 @@ class TransformerBase:
offset: _OffsetOptions = "center",
) -> tuple[float, float] | tuple[list[float], list[float]]: ...

@overload
def rowcol(
self, xs: float | Sequence[float], ys: float | Sequence[float], zs: float | Sequence[float] | None = None, op: None = None
) -> tuple[int, int] | tuple[list[int], list[int]]: ...
@overload
def rowcol(
self,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None,
op: _RoundOperation[_T],
) -> tuple[_T, _T] | tuple[list[_T], list[_T]]: ...
@overload
def rowcol(
self,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None = None,
op: _RoundOperation | None = None,
) -> tuple[int, int] | tuple[list[int], list[int]]: ...
*,
op: _RoundOperation[_T],
) -> tuple[_T, _T] | tuple[list[_T], list[_T]]: ...
@overload
@deprecated("The `precision` parameter is unused since rasterio 1.3 and will be removed in 2.0.0.")
def rowcol(
self,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None = None,
op: _RoundOperation | None = None,
op: None = None,
precision: int | None = None,
) -> tuple[int, int] | tuple[list[int], list[int]]: ...
@overload
@deprecated("The `precision` parameter is unused since rasterio 1.3 and will be removed in 2.0.0.")
def rowcol(
self,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None,
op: _RoundOperation[_T],
precision: int | None = None,
) -> tuple[_T, _T] | tuple[list[_T], list[_T]]: ...
@overload
@deprecated("The `precision` parameter is unused since rasterio 1.3 and will be removed in 2.0.0.")
def rowcol(
self,
xs: float | Sequence[float],
ys: float | Sequence[float],
zs: float | Sequence[float] | None = None,
*,
op: _RoundOperation[_T],
precision: int | None = None,
) -> tuple[_T, _T] | tuple[list[_T], list[_T]]: ...

class GDALTransformerBase(TransformerBase):
def __init__(self) -> None: ...
Expand Down