add a deprecation decorator

[ilia-kats]

As per the discussion in scverse/mudata#131.

Apparently it's not really possible to add arguments to the __init__ of str subclasses, so I'm using a dataclass instead.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.43%. Comparing base (2a0be55) to head (c772029).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #5      +/-   ##
==========================================
+ Coverage   96.38%   97.43%   +1.05%     
==========================================
  Files           2        3       +1     
  Lines          83      117      +34     
==========================================
+ Hits           80      114      +34     
  Misses          3        3              

Files with missing lines	Coverage Δ
src/scverse_misc/__init__.py	100.00% <100.00%> (ø)
src/scverse_misc/_deprecated.py	100.00% <100.00%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Zethson]

Could also get inspired by https://github.com/laminlabs/lamin-utils/blob/d91d959dad4c3cd8717035ce64543dfcc840d3f4/lamin_utils/_compat.py

What you're building is great though.

[Zethson]

No need for that. We're following spec-0 so we're more or less already at Python 3.12+

[ilia-kats]

but mudata 0.3.x is still on 3.10+. I'll bump it for 0.4, but for now I'd prefer to keep it.

[Zethson]

I think MuData received so many changes, it's fine to just release 0.4.0 next. The current MuData main branch can already be 3.12+.

But this is not a big problem (unless you have to adapt it again - see Phil's Generics suggestion) so whatever you think makes sense.

Thanks!

[ilia-kats]

Everything so far has been backwards compatible, so my plan currently is to release 0.3.4 after the deprecation PR has been merged, this will be the last 0.3.x release.

[flying-sheep]

Apparently it's not really possible to add arguments to the __init__ of str subclasses, so I'm using a dataclass instead.

if it’s not a str subclass, it won’t typecheck. __new__ works!

class Test(str):
    def __new__(cls, version, msg):
        obj = str.__new__(cls, f"{msg} (since {v})")
        obj.version = Version(version)
        return obj

[ilia-kats]

if it’s not a str subclass, it won’t typecheck. __new__ works!

Is it typechecked at all? I don't see deprecated in the corresponding typeshed file

[flying-sheep]

Everything in the stdlib is typechecked! I guess you have the wrong file.

[ilia-kats]

Ah, found it. However, if I'm reading this right, your version also won't typecheck, since it wants a LiteralString for message.

[ilia-kats]

@flying-sheep Exactly, it's complaining about Deprecation not being LiteralString: https://play.ty.dev/322b2994-2dbe-4e47-917f-1666a32fe432

[flying-sheep]

no problem, just do def __new__(...) -> LiteralString!

Also no from typing import TypeVar, please, just Python 3.12 generics syntax.

[ilia-kats]

no problem, just do def __new__(...) -> LiteralString!

Thanks, done.

Also no from typing import TypeVar, please, just Python 3.12 generics syntax.

As mentioned above, mudata 0.3.x is still Python 3.10+ and I'd like to avoid bumping the mudata requirements in the 0.3 series. I'll bump it for 0.4 and then also make a new scverse-misc version that is 3.12+.

[flying-sheep]

Please make the minimum version test job also run on 3.10 when you extend the support window, and simplify a bit using inspect otherwise this looks good!