Merge branch 'invertase-db-event-rename'

Author: taeold

.github/workflows/ci.yaml

@@ -22,11 +22,15 @@ jobs:
           python-version: ${{ matrix.python }}
       - name: Install dependencies
         run: |
-          python setup.py install
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          python3.10 -m venv venv
+          source venv/bin/activate 
+          pip3 install --upgrade pip 
+          python3.10 -m pip install -r requirements.txt
+          python3.10 setup.py install
       - name: Test with pytest & coverage
-        run: python -m pytest --cov=src --cov-report term --cov-report html --cov-report xml
+        run: |
+          source venv/bin/activate
+          python3.10 -m pytest --cov=src --cov-report term --cov-report html --cov-report xml -vv
       # TODO requires activation for this repository on codecov website first.
       # - name: Upload coverage to Codecov
       #   uses: codecov/codecov-action@v3
@@ -41,9 +45,16 @@ jobs:
           python-version: "3.10"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          python3.10 -m venv venv
+          source venv/bin/activate 
+          pip3 install --upgrade pip 
+          python3.10 -m pip install -r requirements.txt
+          python3.10 setup.py install
       - name: Lint with pylint
-        run: pylint $(git ls-files '*.py')
+        run: |
+          source venv/bin/activate
+          python3.10 -m pylint $(git ls-files '*.py')
       - name: Lint with mypy
-        run: python -m mypy .
+        run: |
+          source venv/bin/activate
+          python3.10 -m mypy .

.pylintrc

@@ -424,6 +424,6 @@ valid-metaclass-classmethod-first-arg=mcs
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=StandardError,
-                       Exception,
-                       BaseException
+overgeneral-exceptions=builtins.StandardError,
+                       builtins.Exception,
+                       builtins.BaseException

example/functions/main.py

@@ -17,22 +17,22 @@
     reference="hello",
     region=options.SupportedRegion.EUROPE_WEST1,
 )
-def on_write_example(event: db.DatabaseEvent[db.Change[object]]) -> None:
+def on_write_example(event: db.Event[db.Change[object]]) -> None:
     print("Hello from db write event:", event)
 
 
 @db.on_value_created(reference="hello/{any_thing_here}/bar")
-def on_created_example(event: db.DatabaseEvent[object]) -> None:
+def on_created_example(event: db.Event[object]) -> None:
     print("Hello from db create event:", event)
 
 
 @db.on_value_deleted(reference="hello/{any_thing_here}/bar")
-def on_deleted_example(event: db.DatabaseEvent[object]) -> None:
+def on_deleted_example(event: db.Event[object]) -> None:
     print("Hello from db delete event:", event)
 
 
 @db.on_value_updated(reference="hello")
-def on_updated_example(event: db.DatabaseEvent[db.Change[object]]) -> None:
+def on_updated_example(event: db.Event[db.Change[object]]) -> None:
     print("Hello from db updated event:", event)
 
 

mypy.ini

@@ -1,5 +1,5 @@
 [mypy]
-exclude = build|setup.py
+exclude = build|setup.py|venv
 
 # cloudevents package has no types
 ignore_missing_imports = True

samples/basic_storage/.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "python-functions-testing"
+  }
+}

samples/basic_storage/.gitignore

@@ -0,0 +1,66 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

samples/basic_storage/firebase.json

@@ -0,0 +1,8 @@
+{
+  "functions": [
+    {
+      "source": "functions",
+      "codebase": "default"
+    }
+  ]
+}

samples/basic_storage/functions/.gitignore

@@ -0,0 +1,13 @@
+# pyenv
+.python-version
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Environments
+.env
+.venv
+venv/
+venv.bak/
+__pycache__

samples/basic_storage/functions/__init__.py

@@ -0,0 +1,3 @@
+# Required to avoid a 'duplicate modules' mypy error
+# in monorepos that have multiple main.py files.
+# https://github.com/python/mypy/issues/4008

samples/basic_storage/functions/main.py

@@ -0,0 +1,41 @@
+"""
+Example Firebase Functions for Storage triggers.
+"""
+
+from firebase_functions import storage
+from firebase_functions.storage import StorageObjectData, CloudEvent
+from firebase_admin import initialize_app
+
+initialize_app()
+
+
+@storage.on_object_finalized()
+def on_object_finalized_example(event: CloudEvent[StorageObjectData]):
+    """
+    This function will be triggered when a new object is created in the bucket.
+    """
+    print(event)
+
+
+@storage.on_object_archived()
+def on_object_archived_example(event: CloudEvent[StorageObjectData]):
+    """
+    This function will be triggered when an object is archived in the bucket.
+    """
+    print(event)
+
+
+@storage.on_object_deleted()
+def on_object_deleted_example(event: CloudEvent[StorageObjectData]):
+    """
+    This function will be triggered when an object is deleted in the bucket.
+    """
+    print(event)
+
+
+@storage.on_object_metadata_updated()
+def on_object_metadata_updated_example(event: CloudEvent[StorageObjectData]):
+    """
+    This function will be triggered when an object's metadata is updated in the bucket.
+    """
+    print(event)