Merge pull request #46 from nitrictech/feature/context-api

tjholm · web-flow · commit 6305ebe7d4a8 · 2021-10-10T10:44:17.000+11:00
feat: context based faas api
diff --git a/examples/documents/delete.py b/examples/documents/delete.py
@@ -1,11 +1,14 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_delete():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     document = docs.collection("products").doc("nitric")
 
     await document.delete()
+
+
 # [END snippet]
diff --git a/examples/documents/get.py b/examples/documents/get.py
@@ -1,11 +1,14 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_get():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     document = docs.collection("products").doc("nitric")
 
     product = await document.get()
+
+
 # [END snippet]
diff --git a/examples/documents/paged_results.py b/examples/documents/paged_results.py
@@ -1,8 +1,9 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_paged_results():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     query = docs.collection("Customers").query().where("active", "==", True).limit(100)
@@ -13,4 +14,6 @@ async def documents_paged_results():
     # Fetch next page
     if results.paging_token:
         results = await query.page_from(results.paging_token).fetch()
+
+
 # [END snippet]
diff --git a/examples/documents/query.py b/examples/documents/query.py
@@ -1,12 +1,15 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_query():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     query = docs.collection("Customers").query()
 
     # Execute query
     results = await query.fetch()
+
+
 # [END snippet]
diff --git a/examples/documents/query_filter.py b/examples/documents/query_filter.py
@@ -1,11 +1,14 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_query_filter():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     query = docs.collection("Customers").query().where("country", "==", "US").where("age", ">=", 21)
 
     results = await query.fetch()
+
+
 # [END snippet]
diff --git a/examples/documents/query_limits.py b/examples/documents/query_limits.py
@@ -1,11 +1,14 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_query_limits():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     query = docs.collection("Customers").query().limit(1000)
 
     results = await query.fetch()
+
+
 # [END snippet]
diff --git a/examples/documents/refs.py b/examples/documents/refs.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 def documents_refs():
-# [START snippet]
-  docs = Documents()
+    # [START snippet]
+    docs = Documents()
+
+    # create a reference to a collection named 'products'
+    products = docs.collection("products")
+
+    # create a reference to a document with the id 'nitric'
+    nitric = products.doc("nitric")
 
-  # create a reference to a collection named 'products'
-  products = docs.collection("products")
 
-  # create a reference to a document with the id 'nitric'
-  nitric = products.doc("nitric")
 # [END snippet]
diff --git a/examples/documents/set.py b/examples/documents/set.py
@@ -1,8 +1,9 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_set():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     document = docs.collection("products").doc("nitric")
@@ -16,4 +17,6 @@ async def documents_set():
             }
         )
     )
+
+
 # [END snippet]
diff --git a/examples/documents/streamed.py b/examples/documents/streamed.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_streamed():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     query = docs.collection("Customers").query()
 
     async for doc in query.stream():
         # Process doc stream...
         print(doc.content)
-# [END snippet]
+
+
+# [END snippet]
diff --git a/examples/documents/sub_col_query.py b/examples/documents/sub_col_query.py
@@ -1,13 +1,14 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_sub_col_query():
-# [START snippet]
-  docs = Documents()
+    # [START snippet]
+    docs = Documents()
+
+    query = docs.collection("Customers").collection("Orders").query()
+
+    results = await query.fetch()
 
-  query = (docs.collection("Customers")
-          .collection("Orders")
-          .query())
 
-  results = await query.fetch()
 # [END snippet]
diff --git a/examples/documents/sub_doc_query.py b/examples/documents/sub_doc_query.py
@@ -1,11 +1,14 @@
 # [START import]
 from nitric.api import Documents
+
 # [END import]
 async def documents_sub_doc_query():
-# [START snippet]
+    # [START snippet]
     docs = Documents()
 
     query = docs.collection("Customers").doc("apple").collection("Orders").query()
 
     results = await query.fetch()
+
+
 # [END snippet]
diff --git a/examples/events/event_ids.py b/examples/events/event_ids.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Events, Event
+
 # [END import]
 async def events_event_ids():
-# [START snippet]
+    # [START snippet]
     # Create a new Event Client with default settings
     topic = Events().topic("my-topic")
 
     payload = {"content": "of event"}
 
     # Publish an event to the topic 'my-topic'
     event = await topic.publish(Event(payload=payload))
+
+
 # [END snippet]
diff --git a/examples/events/publish.py b/examples/events/publish.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Events, Event
+
 # [END import]
 async def events_publish():
-# [START snippet]
+    # [START snippet]
     # Create a new Event Client with default settings
     topic = Events().topic("my-topic")
 
     payload = {"content": "of event"}
 
     # Publish an event to the topic 'my-topic'
     event = await topic.publish(Event(payload=payload))
+
+
 # [END snippet]
diff --git a/examples/queues/receive.py b/examples/queues/receive.py
@@ -1,8 +1,9 @@
 # [START import]
 from nitric.api import Queues, Task
+
 # [END import]
 async def queues_receive():
-# [START snippet]
+    # [START snippet]
     # Construct a new queue client with default settings
     queue = Queues().queue("my-queue")
 
@@ -13,4 +14,6 @@ async def queues_receive():
 
         # Complete the task if it was processed successfully
         await task.complete()
+
+
 # [END snippet]
diff --git a/examples/queues/send.py b/examples/queues/send.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Queues, Task
+
 # [END import]
 async def queues_send():
-# [START snippet]
+    # [START snippet]
     # Construct a new queue client with default settings
     queues = Queues()
 
     payload = {"content": "of task"}
 
     # Publish a task to a queue
     await queues.queue("my-queue").send(Task(payload=payload))
+
+
 # [END snippet]
diff --git a/examples/secrets/access.py b/examples/secrets/access.py
@@ -1,8 +1,9 @@
 # [START import]
 from nitric.api import Secrets
+
 # [END import]
 async def secret_access():
-# [START snippet]
+    # [START snippet]
     # Construct a new secret client
     secrets = Secrets()
 
@@ -11,4 +12,6 @@ async def secret_access():
     value = await secrets.secret("database.password").version(version).access()
 
     password = value.as_string()
+
+
 # [END snippet]
diff --git a/examples/secrets/latest.py b/examples/secrets/latest.py
@@ -1,8 +1,9 @@
 # [START import]
 from nitric.api import Secrets
+
 # [END import]
 async def secret_latest():
-# [START snippet]
+    # [START snippet]
     # Construct a new secret client
     secrets = Secrets()
 
@@ -11,4 +12,6 @@ async def secret_latest():
 
     # Access the latest secret version
     value = await latest_version.access()
+
+
 # [END snippet]
diff --git a/examples/secrets/put.py b/examples/secrets/put.py
@@ -1,8 +1,9 @@
 # [START import]
 from nitric.api import Secrets
+
 # [END import]
 async def secret_put():
-# [START snippet]
+    # [START snippet]
     # Construct a new secret client
     secrets = Secrets()
 
@@ -12,4 +13,6 @@ async def secret_put():
 
     # Access the exact version of the put secret, for future reference
     password = await new_version.access()
+
+
 # [END snippet]
diff --git a/examples/storage/delete.py b/examples/storage/delete.py
@@ -1,11 +1,14 @@
 # [START import]
 from nitric.api import Storage
+
 # [END import]
 async def storage_delete():
-# [START snippet]
+    # [START snippet]
     # Construct a new storage client with default settings
     storage = Storage()
 
     # Delete the file
     await storage.bucket("my-bucket").file("path/to/item").delete()
+
+
 # [END snippet]
diff --git a/examples/storage/read.py b/examples/storage/read.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Storage
+
 # [END import]
 async def storage_read():
-# [START snippet]
+    # [START snippet]
     # Construct a new storage client with default settings
     storage = Storage()
 
     file_ref = storage.bucket("my-bucket").file("path/to/item")
 
     # Read bytes from the file
     file = await file_ref.read()
+
+
 # [END snippet]
diff --git a/examples/storage/write.py b/examples/storage/write.py
@@ -1,13 +1,16 @@
 # [START import]
 from nitric.api import Storage
+
 # [END import]
 async def storage_write():
-# [START snippet]
+    # [START snippet]
     # Construct a new storage client with default settings
     storage = Storage()
 
     file_ref = storage.bucket("my-bucket").file("path/to/item")
 
     # Write bytes to the file
     await file_ref.write(b"example content")
+
+
 # [END snippet]
diff --git a/nitric/faas.py b/nitric/faas.py
diff --git a/nitric/faas/__init__.py b/nitric/faas/__init__.py
diff --git a/nitric/faas/faas.py b/nitric/faas/faas.py
diff --git a/nitric/faas/response.py b/nitric/faas/response.py
diff --git a/nitric/faas/trigger.py b/nitric/faas/trigger.py
diff --git a/tests/faas/__init__.py b/tests/faas/__init__.py
diff --git a/tests/faas/test_faas.py b/tests/faas/test_faas.py
diff --git a/tests/faas/test_response.py b/tests/faas/test_response.py
diff --git a/tests/faas/test_trigger.py b/tests/faas/test_trigger.py
diff --git a/tests/test_faas.py b/tests/test_faas.py

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`# [START import]`
`2`	`2`	`from nitric.api import Documents`
	`3`	`+`
`3`	`4`	`# [END import]`
`4`	`5`	`async def documents_set():`
`5`		`-# [START snippet]`
	`6`	`+ # [START snippet]`
`6`	`7`	`docs = Documents()`
`7`	`8`
`8`	`9`	`document = docs.collection("products").doc("nitric")`
`@@ -16,4 +17,6 @@ async def documents_set():`
`16`	`17`	`}`
`17`	`18`	`)`
`18`	`19`	`)`
	`20`	`+`
	`21`	`+`
`19`	`22`	`# [END snippet]`