refactor: replace optional typing usages with | None

Author: Salakar

src/firebase_functions/https_fn.py

@@ -233,7 +233,7 @@ class HttpsError(Exception):
     determines the HTTP status code of the response.
     """
 
-    details: _typing.Optional[_typing.Any] = None
+    details: _typing.Any | None = None
     """
     Extra data to be converted to JSON and included in the error response.
     """
@@ -247,7 +247,7 @@ def __init__(
         self,
         code: FunctionsErrorCode,
         message: str,
-        details: _typing.Optional[_typing.Any] = None,
+        details: _typing.Any | None = None,
     ):
         self.code = code
         self.message = message
@@ -326,17 +326,17 @@ class CallableRequest(_typing.Generic[_core.T]):
     The raw request handled by the callable.
     """
 
-    app: _typing.Optional[AppCheckData] = None
+    app: AppCheckData | None = None
     """
     The result of decoding and verifying a Firebase AppCheck token.
     """
 
-    auth: _typing.Optional[AuthData] = None
+    auth: AuthData | None = None
     """"
     The result of decoding and verifying a Firebase Auth ID token.
     """
 
-    instance_id_token: _typing.Optional[str] = None
+    instance_id_token: str | None = None
     """
     An unverified token for a Firebase Instance ID.
     """

src/firebase_functions/options.py

@@ -325,7 +325,7 @@ class PubSubOptions(RuntimeOptions):
     Internal use only.
     """
 
-    retry: _typing.Optional[bool] = None
+    retry: bool | None = None
     """
     Whether failed executions should be delivered again.
     """
@@ -364,7 +364,7 @@ class StorageOptions(RuntimeOptions):
     Internal use only.
     """
 
-    bucket: _typing.Optional[str] = None
+    bucket: str | None = None
     """
     The name of the bucket to watch for Storage events.
     """
@@ -416,7 +416,7 @@ class DatabaseOptions(RuntimeOptions):
     Examples: '/foo/bar', '/foo/{bar}'
     """
 
-    instance: _typing.Optional[str] = None
+    instance: str | None = None
     """
     Specify the handler to trigger on a database instance(s).
     If present, this value can either be a single instance or a pattern.
@@ -471,7 +471,7 @@ class HttpsOptions(RuntimeOptions):
     Invoker to set access control on https functions.
     """
 
-    cors: _typing.Optional[CorsOptions] = None
+    cors: CorsOptions | None = None
     """
     Optionally set CORS options for Https functions.
     """

src/firebase_functions/params.py

@@ -104,7 +104,7 @@ class SelectOptions(_typing.Generic[_T]):
     value: _T
     """The value of the option."""
 
-    label: _typing.Optional[str] = None
+    label: str | None = None
     """The displayed label for the option."""
 
 
@@ -127,18 +127,18 @@ class TextInput:
     validation_regex, if present, will be retried.
     """
 
-    example: _typing.Optional[str] = None
+    example: str | None = None
     """
     An example of the input required that will be displayed alongside the input prompt.
     """
 
-    validation_regex: _typing.Optional[str] = None
+    validation_regex: str | None = None
     """
     Validation regex for the input.
     Input that does not match this regex, if present, will be retried.
     """
 
-    validation_error_message: _typing.Optional[str] = None
+    validation_error_message: str | None = None
     """
     An error message that is displayed to the user if validation_regex fails.
     """
@@ -169,22 +169,22 @@ class Param(Expression[_T]):
     The environment variable of this parameter. Must be upper case.
     """
 
-    default: _typing.Optional[_T] = None
+    default: _T | None = None
     """
     The default value to assign to this param if none provided.
     """
 
-    label: _typing.Optional[str] = None
+    label: str | None = None
     """
     A label that is displayed to the user for this param.
     """
 
-    description: _typing.Optional[str] = None
+    description: str | None = None
     """
     Description of this param that is displayed to the user.
     """
 
-    immutable: _typing.Optional[bool] = None
+    immutable: bool | None = None
     """
     Whether the value of this parameter can change between function
     deployments.
@@ -233,17 +233,17 @@ class SecretParam(Expression[str]):
     The environment variable of this parameter. Must be upper case.
     """
 
-    label: _typing.Optional[str] = None
+    label: str | None = None
     """
     A label that is displayed to the user for this param.
     """
 
-    description: _typing.Optional[str] = None
+    description: str | None = None
     """
     Description of this param that is displayed to the user.
     """
 
-    immutable: _typing.Optional[bool] = None
+    immutable: bool | None = None
     """
     Whether the value of this parameter can change between function
     deployments.

src/firebase_functions/private/manifest.py

@@ -94,29 +94,28 @@ class VpcSettings(_typing.TypedDict):
 class ManifestEndpoint:
     """A definition of a function as appears in the Manifest."""
 
-    entryPoint: _typing.Optional[str] = None
-    region: _typing.Optional[list[str]] = _dataclasses.field(
-        default_factory=list[str])
-    platform: _typing.Optional[str] = "gcfv2"
+    entryPoint: str | None = None
+    region: list[str] | None = _dataclasses.field(default_factory=list[str])
+    platform: str | None = "gcfv2"
     availableMemoryMb: int | _params.Expression[
         int] | _util.Sentinel | None = None
     maxInstances: int | _params.Expression[int] | _util.Sentinel | None = None
     minInstances: int | _params.Expression[int] | _util.Sentinel | None = None
     concurrency: int | _params.Expression[int] | _util.Sentinel | None = None
-    serviceAccountEmail: _typing.Optional[str | _util.Sentinel] = None
+    serviceAccountEmail: str | _util.Sentinel | None = None
     timeoutSeconds: int | _params.Expression[int] | _util.Sentinel | None = None
     cpu: int | str | _util.Sentinel | None = None
-    vpc: _typing.Optional[VpcSettings] = None
-    labels: _typing.Optional[dict[str, str]] = None
-    ingressSettings: _typing.Optional[str] | _util.Sentinel = None
-    secretEnvironmentVariables: _typing.Optional[
-        list[SecretEnvironmentVariable] | _util.Sentinel] = _dataclasses.field(
+    vpc: VpcSettings | None = None
+    labels: dict[str, str] | None = None
+    ingressSettings: str | None | _util.Sentinel = None
+    secretEnvironmentVariables: list[
+        SecretEnvironmentVariable] | _util.Sentinel | None = _dataclasses.field(
             default_factory=list[SecretEnvironmentVariable])
-    httpsTrigger: _typing.Optional[HttpsTrigger] = None
-    callableTrigger: _typing.Optional[CallableTrigger] = None
-    eventTrigger: _typing.Optional[EventTrigger] = None
-    scheduleTrigger: _typing.Optional[ScheduleTrigger] = None
-    blockingTrigger: _typing.Optional[BlockingTrigger] = None
+    httpsTrigger: HttpsTrigger | None = None
+    callableTrigger: CallableTrigger | None = None
+    eventTrigger: EventTrigger | None = None
+    scheduleTrigger: ScheduleTrigger | None = None
+    blockingTrigger: BlockingTrigger | None = None
 
 
 class ManifestRequiredApi(_typing.TypedDict):

src/firebase_functions/private/util.py

@@ -108,7 +108,7 @@ def _on_call_valid_method(request: _Request) -> bool:
 
 def _on_call_valid_content_type(request: _Request) -> bool:
     """Validate content"""
-    content_type: _typing.Optional[str] = request.headers.get("Content-Type")
+    content_type: str | None = request.headers.get("Content-Type")
 
     if content_type is None:
         _logging.warning("Request is missing Content-Type.", content_type)
@@ -159,9 +159,9 @@ class _OnCallTokenVerification:
     """
 
     app: OnCallTokenState = OnCallTokenState.INVALID
-    app_token: _typing.Optional[dict[str, _typing.Any]] = None
+    app_token: dict[str, _typing.Any] | None = None
     auth: OnCallTokenState = OnCallTokenState.INVALID
-    auth_token: _typing.Optional[dict] = None
+    auth_token: dict | None = None
 
     def as_dict(self) -> dict:
         """Set dictionary"""
@@ -256,7 +256,7 @@ class FirebaseConfig():
     initialize a firebase App.
     """
 
-    storage_bucket: _typing.Optional[str]
+    storage_bucket: str | None
     """
     The name of the Google Cloud Storage bucket used for storing application data.
     This is the bucket name without any prefixes or additions (without "gs://").

src/firebase_functions/pubsub_fn.py

@@ -61,7 +61,7 @@ class Message(_typing.Generic[T]):
     """
 
     @property
-    def json(self) -> _typing.Optional[T]:
+    def json(self) -> T | None:
         try:
             if self.data is not None:
                 return _json.loads(_base64.b64decode(self.data).decode("utf-8"))

src/firebase_functions/storage_fn.py

@@ -60,57 +60,57 @@ class StorageObjectData:
     The name of the bucket containing this object.
     """
 
-    cache_control: _typing.Optional[str]
+    cache_control: str | None
     """
     Cache-Control directive for the object data,
     matching [RFC 7234 §5.2]([https://tools.ietf.org/html/rfc7234#section-5.2"]).
     """
 
-    component_count: _typing.Optional[int]
+    component_count: int | None
     """
     Number of underlying components that make up this object.
     Components are accumulated by compose operations.
     """
 
-    content_disposition: _typing.Optional[str]
+    content_disposition: str | None
     """
     Content-Disposition of the object data,
     matching [RFC 6266]([https://tools.ietf.org/html/rfc6266"]).
     """
 
-    content_encoding: _typing.Optional[str]
+    content_encoding: str | None
     """
     Content-Encoding of the object data,
     matching [RFC 7231 §3.1.2.2](https://tools.ietf.org/html/rfc7231#section-3.1.2.2)
     """
 
-    content_language: _typing.Optional[str]
+    content_language: str | None
     """
     Content-Language of the object data,
     matching [RFC 7231 §3.1.3.2](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
     """
 
-    content_type: _typing.Optional[str]
+    content_type: str | None
     """
     Content-Type of the object data, matching
     [RFC 7231 §3.1.1.5](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
     If an object is stored without a Content-Type, it is served as
     `application/octet-stream`.
     """
 
-    crc32c: _typing.Optional[str]
+    crc32c: str | None
     """
     CRC32c checksum. For more information about using the CRC32c checksum, see
     [Hashes and ETags: Best Practices](https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI).
     """
 
-    customer_encryption: _typing.Optional[CustomerEncryption]
+    customer_encryption: CustomerEncryption | None
     """
     Metadata of customer-supplied encryption key, if the object is encrypted by
     such a key.
     """
 
-    etag: _typing.Optional[str]
+    etag: str | None
     """
     HTTP 1.1 Entity tag for the object.
     """
@@ -126,22 +126,22 @@ class StorageObjectData:
     generation number.
     """
 
-    kind: _typing.Optional[str]
+    kind: str | None
     """
     The kind of item this is. For objects, this is always `storage#object`.
     """
 
-    md5_hash: _typing.Optional[str]
+    md5_hash: str | None
     """
     MD5 hash of the data; encoded using base64.
     """
 
-    media_link: _typing.Optional[str]
+    media_link: str | None
     """
     Media download link.
     """
 
-    metadata: _typing.Optional[dict[str, str]]
+    metadata: dict[str, str] | None
     """
     User-provided metadata, in key/value pairs.
     """
@@ -159,7 +159,7 @@ class StorageObjectData:
     The name of the object.
     """
 
-    self_link: _typing.Optional[str]
+    self_link: str | None
     """
     The link to this object.
     """
@@ -174,22 +174,22 @@ class StorageObjectData:
     Storage class of the object.
     """
 
-    time_created: _typing.Optional[str]
+    time_created: str | None
     """
     The creation time of the object.
     """
 
-    time_deleted: _typing.Optional[str]
+    time_deleted: str | None
     """
     The deletion time of the object.
     """
 
-    time_storage_class_updated: _typing.Optional[str]
+    time_storage_class_updated: str | None
     """
     The time at which the object's storage class was last changed.
     """
 
-    updated: _typing.Optional[str]
+    updated: str | None
     """
     The modification time of the object metadata.
     """