Summary

Enhance typing for KeyValueForm.

Review Request #14437 — Created May 14, 2025 and submitted June 10, 2025, 9:43 p.m.

Information

Owner

david

Repository

Djblets

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This change makes it so KeyValueForm is typed as a generic, allowing us
to specify the type of the instance member which is operated on. The
default implementations of get and set assume a dict-like interface, so
I've additionally added some runtime-checkable protocols for those.

Testing Done


Ran unit tests.
Verified that type checkers were happy when creating KeyValueForm

  subclasses.

Commits

Summary	ID
Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	5198a036e8c4a39c7dc0e9ff6d5917f15106f6a1

Summary

Enhance typing for KeyValueForm.

This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.

5198a036e8c4a39c7dc0e9ff6d5917f15106f6a1

Issues

Description	From	Last Updated
I think this can live in TYPE_CHECKING.	chipx86	May 15, 2025, 2:33 p.m.
This needs a Version Added and a Version Changed in __init__.	chipx86	May 15, 2025, 2:37 p.m.
Do we want parens in the returns? We've been doing without in this form.	chipx86	May 15, 2025, 2:38 p.m.
While here, we can move request into the function definition after *args.	chipx86	May 23, 2025, 4:32 p.m.
These should be swapped.	chipx86	May 23, 2025, 4:31 p.m.
Missing , optional.	chipx86	May 23, 2025, 4:31 p.m.

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

djblets/forms/forms/key_value_form.py (Diff revision 1)
The issue has been dropped. Show all issues
```
I think this can live in TYPE_CHECKING.
```
1. david May 15, 2025, 2:39 p.m.
  KeyValueForm inherits from Generic[_T]

djblets/siteconfig/forms.py (Diff revision 1)

The issue has been resolved. Show all issues

This needs a Version Added and a Version Changed in __init__.

david May 15, 2025, 2:39 p.m.

This has always been part of the kwargs, but I'll add a version changed blurb about the removal of the default.

djblets/siteconfig/forms.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Do we want parens in the returns? We've been doing without in this form.
```
1. david May 15, 2025, 2:39 p.m.
  Nope, just a copy/paste-o.

Commits:

	Summary	ID
	Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	abebbed7cfb4ff23940c84b8b850a81d39c194cb
	Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	97a611feae2ea8969aadad0f0c2ac23b45907d16

Diff:

Revision 2 (+340 -106)

Show changes

	djblets/extensions/forms.py
	djblets/forms/forms/key_value_form.py
	djblets/integrations/forms.py
	djblets/siteconfig/forms.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Make the request parameter for SiteSettingsForm not-required again (there are subclasses and other places that don't always pass it).
Put Generic as the last parent class instead of the first (I'll have another change doing this for everywhere else, with reasons).

Commits:

	Summary	ID
	Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	97a611feae2ea8969aadad0f0c2ac23b45907d16
	Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	0f1b47e7c005ef5967703aa1dc2d470f69e1e035

Diff:

Revision 3 (+338 -108)

Show changes

	djblets/extensions/forms.py
	djblets/forms/forms/key_value_form.py
	djblets/integrations/forms.py
	djblets/siteconfig/forms.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/extensions/forms.py (Diff revision 3)
The issue has been resolved. Show all issues
```
While here, we can move request into the function definition after *args.
```
djblets/integrations/forms.py (Diff revision 3)
The issue has been resolved. Show all issues
```
These should be swapped.
```
djblets/siteconfig/forms.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing , optional.
```

Commits:

	Summary	ID
	Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	0f1b47e7c005ef5967703aa1dc2d470f69e1e035
	Enhance typing for KeyValueForm. This change makes it so KeyValueForm is typed as a generic, allowing us to specify the type of the `instance` member which is operated on. The default implementations of get and set assume a dict-like interface, so I've additionally added some runtime-checkable protocols for those. Testing Done: - Ran unit tests. - Verified that type checkers were happy when creating KeyValueForm subclasses.	5198a036e8c4a39c7dc0e9ff6d5917f15106f6a1

Diff:

Revision 4 (+354 -112)

Show changes

	djblets/extensions/forms.py
	djblets/forms/forms/key_value_form.py
	djblets/integrations/forms.py
	djblets/siteconfig/forms.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-6.x (90d53c8)