Summary:

Add type hints for IntegrationManager.

Review Request #12994 — Created April 27, 2023 and submitted June 15, 2023, 4:38 p.m.

Information
Owner:	chipx86
Repository:	Djblets
Branch:	release-3.x
Bugs:
Depends On:
Reviewers
Groups:	djblets
People:

Description

This adds type hints for IntegrationManager, helping ensure that code
interacting with an IntegrationManager passes around the right types.
These type hints also cover instance variables, letting IDEs and type
checkers show details on these attributes.

Testing Done

Unit tests, mypy, and pyright pass.

Commits

Summary
	Add type hints for IntegrationManager.

Screenshots

Issues

Description	From	Last Updated
'typing.Generic' imported but unused Column: 1 Error code: F401	reviewbot	April 27, 2023, 2:32 a.m.
The only thing we're using from weakref is WeakValueDictionary. Can we do a from weakref import WeakValueDictionary to make this …	david	June 1, 2023, 2:04 p.m.
Can we make an alias for Type[Integration]? We use it a lot.	david	June 1, 2023, 2:07 p.m.
undefined name 'Integration' Column: 39 Error code: F821	reviewbot	June 1, 2023, 2:28 p.m.
undefined name 'Integration' Column: 10 Error code: F821	reviewbot	June 1, 2023, 2:28 p.m.
undefined name 'Integration' Column: 44 Error code: F821	reviewbot	June 1, 2023, 2:28 p.m.
undefined name 'Integration' Column: 10 Error code: F821	reviewbot	June 1, 2023, 2:28 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/integrations/manager.py (Diff revision 1)

Show all issues

'typing.Generic' imported but unused

Column: 1
Error code: F401

Testing Done:

~		Unit tests pass.
	~	Unit tests, mypy, and pyright pass.

Commits:

	Summary
-		Add type hints for IntegrationManager.
+		Add type hints for IntegrationManager.

Diff:

Revision 2 (+274 -146)

Show changes

	djblets/integrations/manager.py
	djblets/integrations/tests/test_manager.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/integrations/manager.py (Diff revision 2)

Show all issues

The only thing we're using from weakref is WeakValueDictionary. Can we do a from weakref import WeakValueDictionary to make this somewhat less wordy?

djblets/integrations/manager.py (Diff revision 2)

Show all issues

Can we make an alias for Type[Integration]? We use it a lot.

Change Summary:


Simplified an import around weakref.
Added an IntegrationClassType type alias.

Commits:

	Summary
-		Add type hints for IntegrationManager.
+		Add type hints for IntegrationManager.

Diff:

Revision 3 (+294 -148)

Show changes

	djblets/integrations/integration.py
	djblets/integrations/manager.py
	djblets/integrations/tests/test_manager.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

djblets/integrations/manager.py (Diff revision 3)

Show all issues

undefined name 'Integration'

Column: 39
Error code: F821

djblets/integrations/manager.py (Diff revision 3)

Show all issues

undefined name 'Integration'

Column: 10
Error code: F821

djblets/integrations/manager.py (Diff revision 3)

Show all issues

undefined name 'Integration'

Column: 44
Error code: F821

djblets/integrations/manager.py (Diff revision 3)

Show all issues

undefined name 'Integration'

Column: 10
Error code: F821

Change Summary:

Added back the Integration typing import.

Commits:

	Summary
-		Add type hints for IntegrationManager.
+		Add type hints for IntegrationManager.

Diff:

Revision 4 (+296 -148)

Show changes

	djblets/integrations/integration.py
	djblets/integrations/manager.py
	djblets/integrations/tests/test_manager.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.x (623658e)