Merge pull request #40 from invertase/rename-fn-modules

refactor: rename fn modules to include `_fn` postfix

Author: taeold

docs/generate.sh

@@ -82,7 +82,7 @@ if [[ "$OUTDIR" == "" ]]; then
 fi
 
 TITLE="Firebase Python SDK for Cloud Functions"
-PY_MODULES='firebase_functions firebase_functions.core firebase_functions.https firebase_functions.params firebase_functions.db firebase_functions.options firebase_functions.pubsub firebase_functions.storage'
+PY_MODULES='firebase_functions firebase_functions.core firebase_functions.https_fn firebase_functions.params firebase_functions.db_fn firebase_functions.options firebase_functions.pubsub_fn firebase_functions.storage_fn'
 DEVSITE_PATH='/docs/reference/functions-python'
 
 #

example/functions/main.py

@@ -1,7 +1,7 @@
 """
 Example Firebase Functions written in Python
 """
-from firebase_functions import db, options, https, params, pubsub
+from firebase_functions import db_fn, https_fn, options, params, pubsub_fn
 from firebase_admin import initialize_app
 
 initialize_app()
@@ -13,49 +13,49 @@
 )
 
 
-@db.on_value_written(
+@db_fn.on_value_written(
     reference="hello",
     region=options.SupportedRegion.EUROPE_WEST1,
 )
-def onwriteexample(event: db.Event[db.Change[object]]) -> None:
+def onwriteexample(event: db_fn.Event[db_fn.Change[object]]) -> None:
     print("Hello from db write event:", event)
 
 
-@db.on_value_created(reference="hello/{any_thing_here}/bar")
-def oncreatedexample(event: db.Event[object]) -> None:
+@db_fn.on_value_created(reference="hello/{any_thing_here}/bar")
+def oncreatedexample(event: db_fn.Event[object]) -> None:
     print("Hello from db create event:", event)
 
 
-@db.on_value_deleted(reference="hello/{any_thing_here}/bar")
-def ondeletedexample(event: db.Event[object]) -> None:
+@db_fn.on_value_deleted(reference="hello/{any_thing_here}/bar")
+def ondeletedexample(event: db_fn.Event[object]) -> None:
     print("Hello from db delete event:", event)
 
 
-@db.on_value_updated(reference="hello")
-def onupdatedexample(event: db.Event[db.Change[object]]) -> None:
+@db_fn.on_value_updated(reference="hello")
+def onupdatedexample(event: db_fn.Event[db_fn.Change[object]]) -> None:
     print("Hello from db updated event:", event)
 
 
-@https.on_request()
-def onrequestexample(req: https.Request) -> https.Response:
+@https_fn.on_request()
+def onrequestexample(req: https_fn.Request) -> https_fn.Response:
     print("on request function data:", req.data)
-    return https.Response("Hello from https on request function example")
+    return https_fn.Response("Hello from https on request function example")
 
 
-@https.on_call()
-def oncallexample(req: https.CallableRequest):
+@https_fn.on_call()
+def oncallexample(req: https_fn.CallableRequest):
     print("on call function data:", req)
     if req.data == "error_test":
-        raise https.HttpsError(
-            https.FunctionsErrorCode.INVALID_ARGUMENT,
+        raise https_fn.HttpsError(
+            https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
             "This is a test",
             "This is some details of the test",
         )
     return "Hello from https on call function example"
 
 
-@pubsub.on_message_published(
+@pubsub_fn.on_message_published(
     topic="hello",)
 def onmessagepublishedexample(
-        event: pubsub.CloudEvent[pubsub.MessagePublishedData]) -> None:
+        event: pubsub_fn.CloudEvent[pubsub_fn.MessagePublishedData]) -> None:
     print("Hello from pubsub event:", event)

samples/basic_storage/functions/main.py

@@ -2,38 +2,38 @@
 Example Firebase Functions for Storage triggers.
 """
 
-from firebase_functions import storage
-from firebase_functions.storage import StorageObjectData, CloudEvent
+from firebase_functions import storage_fn
+from firebase_functions.storage_fn import StorageObjectData, CloudEvent
 from firebase_admin import initialize_app
 
 initialize_app()
 
 
-@storage.on_object_finalized()
+@storage_fn.on_object_finalized()
 def onobjectfinalizedexample(event: CloudEvent[StorageObjectData]):
     """
     This function will be triggered when a new object is created in the bucket.
     """
     print(event)
 
 
-@storage.on_object_archived()
+@storage_fn.on_object_archived()
 def onobjectarchivedexample(event: CloudEvent[StorageObjectData]):
     """
     This function will be triggered when an object is archived in the bucket.
     """
     print(event)
 
 
-@storage.on_object_deleted()
+@storage_fn.on_object_deleted()
 def onobjectdeletedexample(event: CloudEvent[StorageObjectData]):
     """
     This function will be triggered when an object is deleted in the bucket.
     """
     print(event)
 
 
-@storage.on_object_metadata_updated()
+@storage_fn.on_object_metadata_updated()
 def onobjectmetadataupdatedexample(event: CloudEvent[StorageObjectData]):
     """
     This function will be triggered when an object's metadata is updated in the bucket.