This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.
Before approving this request, I must warn you that I cannot use pylint, because the configured version of astroid can only be used on versions lower than py3.11. I also left some comments in the code about potential runtime issues.
firebase_admin._messaging_encoder._Validators Why not @staticmethod? Perhaps there were past issues or subclassing considerations?
firebase_admin.remote_config._ConditionEvaluator.evaluate_conditions You probably need to change condition.get('name') to condition['name']
firebase_admin.remote_config._ConditionEvaluator._compare_semantic_versions bad docstring
firebase_admin.remote_config._ConditionEvaluator.evaluate parameter_value_wrapper.get('value') is only valid if None is a valid argument to _Value
firebase_admin.functions.TaskQueue._update_task_payload service_account_email is accessed on a type that might not have that attribute
To upload to pypi you must approve #713, because linters like mypy will ignore it since it is not marked as safe
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces comprehensive type annotations to the
firebase_admincodebase using PEP 484 standards. All changes have been validated with Pyright in strict mode to enforce consistency and catch potential type errors early.Goals
Tools
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.