Skip to content

Drop deprecated auto-self-downcasts #213

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

Merged
inducer merged 3 commits into from
Aug 12, 2026
+32 −293
Merged

Drop deprecated auto-self-downcasts #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9c1fa9
Drop deprecated auto-self-downcasts
inducer Jul 14, 2026
8223842
Update baseline
inducer Aug 12, 2026
f18f39d
Bump version to 2026.2
inducer Aug 12, 2026
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
184 changes: 0 additions & 184 deletions .basedpyright/baseline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,197 +379,13 @@
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportIncompatibleMethodOverride",
"range": {
"startColumn": 8,
"endColumn": 14,
"lineCount": 1
}
},
{
"code": "reportIncompatibleMethodOverride",
"range": {
"startColumn": 8,
"endColumn": 14,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 19,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 38,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 37,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 37,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 36,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 23,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 22,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 38,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 37,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 37,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 36,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 23,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 22,
"lineCount": 1
}
},
{
"code": "reportOverlappingOverload",
"range": {
"startColumn": 8,
"endColumn": 12,
"lineCount": 1
}
}
],
"./islpy/_monkeypatch.py": [
Expand Down
35 changes: 0 additions & 35 deletions gen_wrap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1468,41 +1468,6 @@ def write_exposer(
f' isl::handle_isl_error(ctx, "isl_{meth.cls}_read_from_str");'
'}, py::arg("s"), py::arg("context").none(true)=py::none());\n')

# Handle auto-self-downcasts. These are deprecated.
if not meth.is_static:
for basic_cls in AUTO_DOWNCASTS.get(meth.cls, []):
basic_overloads = meth_to_overloads.setdefault((basic_cls, meth.name), [])
if any(basic_meth
for basic_meth in basic_overloads
if (basic_meth.is_static
or meth.arg_types()[1:] == basic_meth.arg_types()[1:])
):
continue

# These are high-traffic APIs that are manually implemented
# and not subject to deprecation.
if basic_cls == "basic_set":
if meth.name in ["is_params", "get_hash"]:
continue
elif basic_cls == "basic_map" and meth.name in ["get_hash"]:
continue

basic_overloads.append(meth)

downcast_doc_str = (f"{doc_str}\n\nDowncast from "
f":class:`{to_py_class(basic_cls)}` to "
f":class:`{to_py_class(meth.cls)}`.")
escaped_doc_str = downcast_doc_str.replace(newline, escaped_newline)
outf.write(f"// automatic downcast to {meth.cls}\n")
outf.write(f'wrap_{basic_cls}.def('
# Do not be tempted to pass 'arg_str' here, it will
# prevent implicit conversion.
# https://github.com/wjakob/nanobind/issues/1061
f'"{py_name}", {func_name}'
f', py::sig("def {py_name}{type_sig}")'
f', "{py_name}{type_sig}\\n{escaped_doc_str}"'
');\n')

# }}}


Expand Down
85 changes: 21 additions & 64 deletions islpy/_monkeypatch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import os
import re
from collections.abc import Callable, Collection, Iterable, Mapping, Sequence
from functools import update_wrapper
Expand All @@ -14,7 +13,6 @@
TypeVar,
cast,
)
from warnings import warn


if TYPE_CHECKING:
Expand Down Expand Up @@ -68,13 +66,10 @@
SetOrMapT = TypeVar("SetOrMapT", _isl.BasicSet, _isl.Set, _isl.BasicMap, _isl.Map)

HasDimNames: TypeAlias = (
_isl.Space
| _isl.Constraint
_isl.Constraint
| _isl.LocalSpace
| _isl.Aff
| _isl.MultiAff
| _isl.PwAff
| _isl.PwMultiAff
| _isl.BasicMap
| _isl.BasicSet
| _isl.Set
Expand Down Expand Up @@ -141,7 +136,6 @@ def wrapper(obj: T, *args: P.args, **kwargs: P.kwargs) -> ResultT:
def clear_cache(obj: object):
object.__delattr__(obj, cache_dict_name)

from functools import update_wrapper
new_wrapper = update_wrapper(wrapper, function)

# type-ignore because mypy has a point here, stuffing random attributes
Expand Down Expand Up @@ -854,45 +848,62 @@ def obj_eq(self: IslObject, other: object) -> bool:
return self.is_equal(other)


def obj_ne(self: object, other: object) -> bool:
return not self.__eq__(other)
def no_eq(_self: IslObject, _other: object) -> bool:
raise TypeError("equality not available; use manual downcast or try plain_is_equal")


for cls in ALL_CLASSES:
if hasattr(cls, "is_equal"):
cls.__eq__ = obj_eq
cls.__ne__ = obj_ne
else:
cls.__eq__ = no_eq


def set_lt(self: _isl.BasicSet | _isl.Set, other: _isl.BasicSet | _isl.Set) -> bool:
if isinstance(self, _isl.BasicSet):
self = self.to_set()
return self.is_strict_subset(other)


def set_le(self: _isl.BasicSet | _isl.Set, other: _isl.BasicSet | _isl.Set) -> bool:
if isinstance(self, _isl.BasicSet):
self = self.to_set()
return self.is_subset(other)


def set_gt(self: _isl.BasicSet | _isl.Set, other: _isl.BasicSet | _isl.Set) -> bool:
if isinstance(other, _isl.BasicSet):
other = other.to_set()
return other.is_strict_subset(self)


def set_ge(self: _isl.BasicSet | _isl.Set, other: _isl.BasicSet | _isl.Set) -> bool:
if isinstance(other, _isl.BasicSet):
other = other.to_set()
return other.is_subset(self)


def map_lt(self: _isl.BasicMap | _isl.Map, other: _isl.BasicMap | _isl.Map) -> bool:
if isinstance(self, _isl.BasicMap):
self = self.to_map()
return self.is_strict_subset(other)


def map_le(self: _isl.BasicMap | _isl.Map, other: _isl.BasicMap | _isl.Map) -> bool:
if isinstance(self, _isl.BasicMap):
self = self.to_map()
return self.is_subset(other)


def map_gt(self: _isl.BasicMap | _isl.Map, other: _isl.BasicMap | _isl.Map) -> bool:
if isinstance(other, _isl.BasicMap):
other = other.to_map()
return other.is_strict_subset(self)


def map_ge(self: _isl.BasicMap | _isl.Map, other: _isl.BasicMap | _isl.Map) -> bool:
if isinstance(other, _isl.BasicMap):
other = other.to_map()
return other.is_subset(self)


Expand Down Expand Up @@ -1216,57 +1227,3 @@ def _add_functionality() -> None:
"Map": "to_map",
"UnionMap": "to_union_map",
}


def _depr_downcast_wrapper(
f: Callable[Concatenate[object, P], ResultT],
) -> Callable[Concatenate[object, P], ResultT]:
doc = f.__doc__
assert doc is not None
m = _DOWNCAST_RE.search(doc)
assert m, doc
basic_cls_name = intern(m.group(1))
tgt_cls_name = m.group(2)

tgt_cls = cast("type", getattr(_isl, tgt_cls_name))
is_overload = "Overloaded function" in doc
msg = (f"{basic_cls_name}.{f.__name__} "
f"with implicit conversion of self to {tgt_cls_name} is deprecated "
"and will stop working in 2026. "
f"Explicitly convert to {tgt_cls_name}, "
f"using .{_TO_METHODS[tgt_cls_name]}().")

if is_overload:
def wrapper(self: object, *args: P.args, **kwargs: P.kwargs) -> ResultT:
# "Try to" detect bad invocations of, e.g., Set.union, which is
# an overload of normal union and UnionSet.union.
if (
any(isinstance(arg, tgt_cls) for arg in args)
or
any(isinstance(arg, tgt_cls) for arg in kwargs.values())
):
warn(msg, DeprecationWarning, stacklevel=2)

return f(self, *args, **kwargs)
else:
def wrapper(self: object, *args: P.args, **kwargs: P.kwargs) -> ResultT:
warn(msg, DeprecationWarning, stacklevel=2)

return f(self, *args, **kwargs)
update_wrapper(wrapper, f)
return wrapper


def _monkeypatch_self_downcast_deprecation():
for cls in ALL_CLASSES:
for attr_name in dir(cls):
val = cast("object", getattr(cls, attr_name))
doc = getattr(val, "__doc__", None)
if doc and "\nDowncast from " in doc:
setattr(cls, attr_name, _depr_downcast_wrapper(
cast("Callable", val), # pyright: ignore[reportMissingTypeArgument]
))


if not os.environ.get("ISLPY_NO_DOWNCAST_DEPRECATION", None):
_monkeypatch_self_downcast_deprecation()
Loading
Loading