firebase
Update support for type hints
This pull request introduces comprehensive type annotations to the firebase_admin codebase using PEP 484 standards. All changes have been validated with Pyright in strict mode to enforce consistency and catch potential type errors early.
Goals
- Enhance developer experience with precise autocomplete and type hints.
- Catch type-related bugs upfront via static analysis.
Tools
- Pyright in strict mode for robust type-checking.
- Manual review of ambiguous or potentially problematic sections.
Configuration Additions
-
pyrightconfig.json: config file created to declare strict-mode settings. -
firebase_admin/_typing.py: A new central module that defines all custom type aliases, TypedDicts, and Protocols. By consolidating these shared types in one place, we simplify extension and reuse across the package and avoid circular-import issues.
@jamesdaniels @lahirumaramba Could someone please assign a reviewer to this PR? The previous one was completely ignored, and I closed it because it conflicted with the new Firebase version.
This feature requires PR https://github.com/firebase/firebase-admin-python/pull/713 to be approved before linters can take advantage of it.
tests/test_db.py:907 creates a firebase_admin.db.Reference instance without client.
In this class, the methods assume that client will never be None.
Can you help me here? Should I add a line that creates an instance when it's None? Or should I add validations in each part where it's referenced?
Note: you probably won't have to worry about 3.8 compatibility issues as we plan to drop 3.8 in the upcoming major release. See: https://github.com/firebase/firebase-admin-python/pull/892
I don't know why the 3.9 test fails, could you check it?
You can ignore that specific task queue test. That test has been flaky locally, I'll add a fix for that separately.
Hey @ViktorSky, thanks again for working on this. As a heads up we are working towards a v7 major release which could have some conflicts with this PR. The current plan is for this PR to not be included in that major release since this is not currently prioritized on our roadmap. Additionally, because of the size and scope of the changes we will review this PR module by module. Please note that this will take some time as this was not something currently on our roadmap.
Let's do that or edit the base of this PR onto the v7 branch. When the v7 changes are eventually merged to master we'll rebase your PR back to master. PR's against v7 branch will also ignore python 3.7 and 3.8 and have an updated pylint version so we wouldn't need to worry about compatibility for those.