Skip to content

fix(jwk): handle KeySet equality with unrelated types #106

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
janmrow wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −1
Open

fix(jwk): handle KeySet equality with unrelated types #106

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
3 changes: 2 additions & 1 deletion src/joserfc/_keys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ def __bool__(self) -> bool:
return bool(self.keys)

def __eq__(self, other: t.Any) -> bool:
assert isinstance(other, KeySet)
if not isinstance(other, KeySet):
return NotImplemented

@lepture lepture Sep 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not just return False

@janmrow janmrow Sep 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered False, but switched to NotImplemented, because that follows Python's equality protocol and allows the other operand's __eq__ to handle the comparison if appropriate.

But for KeySet that extra behavior probably isn't needed.

Looks likeFalse is simpler here and matches BaseKey.__eq__, so I suppose that fits better to the project. Happy to change it.

return self.keys == other.keys

def as_dict(self, private: bool = False, **params: t.Any) -> KeySetSerialization:
Expand Down
13 changes: 13 additions & 0 deletions tests/jwk/test_jwk_set.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,16 @@ def test_key_eq_with_new_keys(self):
key_set2 = KeySet([RSAKey.import_key(k.as_dict(private=True)) for k in key_set1])
self.assertIsNot(key_set1, key_set2)
self.assertEqual(key_set1, key_set2)

def test_key_set_eq_with_unrelated_type(self):
key_set = KeySet.generate_key_set("oct", 8, count=1)
self.assertFalse(key_set == "foo")
self.assertNotEqual(key_set, "foo")

def test_key_set_eq_uses_reflected_comparison(self):
class EqualToKeySet:
def __eq__(self, other):
return isinstance(other, KeySet)

key_set = KeySet.generate_key_set("oct", 8, count=1)
self.assertTrue(key_set == EqualToKeySet())