Skip to content

style(ruff): enable ANN202 check and add missing return type annotations #238

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
schwehr merged 1 commit into from
Sep 21, 2026
Merged

style(ruff): enable ANN202 check and add missing return type annotations #238

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
2 changes: 0 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,6 @@ target-version = "py313"
select = ["ALL"]
ignore = [
"ANN001", # missing-type-function-argument
# "ANN201", # missing-return-type-undocumented-public-function
"ANN202", # missing-return-type-private-function
"ANN401", # any-type
"B007", # unused-loop-control-variable
"B905", # zip-without-explicit-strict
Expand Down
72 changes: 36 additions & 36 deletions tests/test_benchmarks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,30 +121,30 @@ def test_bench_invert(benchmark, sample_bv1) -> None:


def test_bench_iand(benchmark, sample_bv1, sample_bv2) -> None:
def setup():
def setup() -> tuple[tuple[BitVector, BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1), sample_bv2), {}

def target(a, b):
def target(a, b) -> None:
a &= b

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_ior(benchmark, sample_bv1, sample_bv2) -> None:
def setup():
def setup() -> tuple[tuple[BitVector, BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1), sample_bv2), {}

def target(a, b):
def target(a, b) -> None:
a |= b

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_ixor(benchmark, sample_bv1, sample_bv2) -> None:
def setup():
def setup() -> tuple[tuple[BitVector, BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1), sample_bv2), {}

def target(a, b):
def target(a, b) -> None:
a ^= b

benchmark.pedantic(target, setup=setup, rounds=100)
Expand All @@ -161,10 +161,10 @@ def test_bench_add(benchmark, sample_bv1, sample_bv2) -> None:
def test_bench_iadd(benchmark, sample_bv1, sample_bv2) -> None:
# Tests __iadd__, avoiding _not_yet_ready__iadd__.
# Uses pedantic with a setup function so self is not mutated across rounds.
def setup():
def setup() -> tuple[tuple[BitVector, BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1), sample_bv2), {}

def target(a, b):
def target(a, b) -> None:
a += b

benchmark.pedantic(target, setup=setup, rounds=100)
Expand All @@ -182,31 +182,31 @@ def test_bench_shift_right(benchmark, sample_bv1) -> None:


def test_bench_ilshift(benchmark, sample_bv1) -> None:
def _run():
def _run() -> None:
bv = sample_bv1[:]
bv <<= 10

benchmark(_run)


def test_bench_irshift(benchmark, sample_bv1) -> None:
def _run():
def _run() -> None:
bv = sample_bv1[:]
bv >>= 10

benchmark(_run)


def test_bench_ilshift_multibit(benchmark, sample_bv1) -> None:
def _run():
def _run() -> None:
bv = sample_bv1[:]
bv <<= 500

benchmark(_run)


def test_bench_irshift_multibit(benchmark, sample_bv1) -> None:
def _run():
def _run() -> None:
bv = sample_bv1[:]
bv >>= 500

Expand Down Expand Up @@ -291,10 +291,10 @@ def test_bench_runs(benchmark, sample_bv1) -> None:


def test_bench_min_canonical(benchmark, sample_bv_small) -> None:
def setup():
def setup() -> tuple[tuple[()], dict[str, object]]:
return (), {}

def target():
def target() -> BitVector:
bv = copy.deepcopy(sample_bv_small)
return bv.min_canonical()

Expand Down Expand Up @@ -336,20 +336,20 @@ def test_bench_ge(benchmark, sample_bv1, sample_bv2) -> None:


def test_bench_setitem_index(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv[50] = 1

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_setitem_slice(benchmark, sample_bv1, sample_bv_small) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv[10:74] = sample_bv_small

benchmark.pedantic(target, setup=setup, rounds=100)
Expand Down Expand Up @@ -391,40 +391,40 @@ def test_bench_deepcopy(benchmark, sample_bv1) -> None:


def test_bench_shift_left_method(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.shift_left(10)

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_shift_right_method(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.shift_right(10)

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_shift_left_by_one(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.shift_left_by_one()

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_shift_right_by_one(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.shift_right_by_one()

benchmark.pedantic(target, setup=setup, rounds=100)
Expand All @@ -434,50 +434,50 @@ def target(bv):


def test_bench_pad_from_left(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.pad_from_left(10)

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_pad_from_right(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.pad_from_right(10)

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_reset(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.reset(0)

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_reverse(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.reverse()

benchmark.pedantic(target, setup=setup, rounds=100)


def test_bench_set_value(benchmark, sample_bv1) -> None:
def setup():
def setup() -> tuple[tuple[BitVector], dict[str, object]]:
return (copy.deepcopy(sample_bv1),), {}

def target(bv):
def target(bv) -> None:
bv.set_value(bitlist=[1, 0, 1, 0, 1, 1, 0, 0] * 8)

benchmark.pedantic(target, setup=setup, rounds=100)
Expand Down
Loading