Skip to content

Commit 9ab8154

Browse files
authored
Merge pull request #17 from nitrictech/feature/faas-update
Use FaaS proto contracts for HTTP body
2 parents e33d120 + a8f765a commit 9ab8154

26 files changed

+604
-506
lines changed

.pre-commit-config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ repos:
33
rev: stable
44
hooks:
55
- id: black
6-
language_version: python3.7
76
- repo: https://github.com/pycqa/flake8
87
rev: 3.7.9
98
hooks:

contracts

docs/nitric/api/index.html

Lines changed: 84 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -106,21 +106,32 @@ <h2 class="section-title" id="header-classes">Classes</h2>
106106
<span>(</span><span>event_id: str, payload_type: str, payload: dict)</span>
107107
</code></dt>
108108
<dd>
109-
<div class="desc"><p>Represents a NitricEvent.</p>
110-
<p>Construct a new Event.</p></div>
109+
<div class="desc"><p>Represents a NitricEvent.</p></div>
111110
<details class="source">
112111
<summary>
113112
<span>Expand source code</span>
114113
</summary>
115114
<pre><code class="python">class Event(object):
116115
&#34;&#34;&#34;Represents a NitricEvent.&#34;&#34;&#34;
117-
118-
def __init__(self, event_id: str, payload_type: str, payload: dict):
119-
&#34;&#34;&#34;Construct a new Event.&#34;&#34;&#34;
120-
self.event_id = event_id
121-
self.payload_type = payload_type
122-
self.payload = payload</code></pre>
116+
event_id: str
117+
payload_type: str
118+
payload: dict</code></pre>
123119
</details>
120+
<h3>Class variables</h3>
121+
<dl>
122+
<dt id="nitric.api.Event.event_id"><code class="name">var <span class="ident">event_id</span> : str</code></dt>
123+
<dd>
124+
<div class="desc"></div>
125+
</dd>
126+
<dt id="nitric.api.Event.payload"><code class="name">var <span class="ident">payload</span> : dict</code></dt>
127+
<dd>
128+
<div class="desc"></div>
129+
</dd>
130+
<dt id="nitric.api.Event.payload_type"><code class="name">var <span class="ident">payload_type</span> : str</code></dt>
131+
<dd>
132+
<div class="desc"></div>
133+
</dd>
134+
</dl>
124135
</dd>
125136
<dt id="nitric.api.EventClient"><code class="flex name class">
126137
<span>class <span class="ident">EventClient</span></span>
@@ -221,27 +232,29 @@ <h3>Methods</h3>
221232
</dd>
222233
<dt id="nitric.api.FailedTask"><code class="flex name class">
223234
<span>class <span class="ident">FailedTask</span></span>
224-
<span>(</span><span>task: <a title="nitric.api.models.Task" href="models.html#nitric.api.models.Task">Task</a>, message: str)</span>
235+
<span>(</span><span>task_id: str, payload_type: str, payload: dict, lease_id: str = None, message: str = '')</span>
225236
</code></dt>
226237
<dd>
227-
<div class="desc"><p>Represents a failed queue publish for an event.</p>
228-
<p>Construct a new Failed Event.</p></div>
238+
<div class="desc"><p>Represents a failed queue publish for an event.</p></div>
229239
<details class="source">
230240
<summary>
231241
<span>Expand source code</span>
232242
</summary>
233243
<pre><code class="python">class FailedTask(Task):
234244
&#34;&#34;&#34;Represents a failed queue publish for an event.&#34;&#34;&#34;
235-
236-
def __init__(self, task: Task, message: str):
237-
&#34;&#34;&#34;Construct a new Failed Event.&#34;&#34;&#34;
238-
super().__init__(task.task_id, task.payload_type, task.payload, task.lease_id)
239-
self.message = message</code></pre>
245+
message: str = field(default=&#34;&#34;)</code></pre>
240246
</details>
241247
<h3>Ancestors</h3>
242248
<ul class="hlist">
243249
<li><a title="nitric.api.models.Task" href="models.html#nitric.api.models.Task">Task</a></li>
244250
</ul>
251+
<h3>Class variables</h3>
252+
<dl>
253+
<dt id="nitric.api.FailedTask.message"><code class="name">var <span class="ident">message</span> : str</code></dt>
254+
<dd>
255+
<div class="desc"></div>
256+
</dd>
257+
</dl>
245258
</dd>
246259
<dt id="nitric.api.KeyValueClient"><code class="flex name class">
247260
<span>class <span class="ident">KeyValueClient</span></span>
@@ -405,7 +418,11 @@ <h3>Methods</h3>
405418
&#34;&#34;&#34;
406419
task = self._wire_to_task(failed_task.task)
407420

408-
return FailedTask(task=task, message=failed_task.message)
421+
return FailedTask(task_id=task.task_id,
422+
payload_type=task.payload_type,
423+
payload=task.payload,
424+
lease_id=task.lease_id,
425+
message=failed_task.message)
409426

410427
def send_batch(self, queue_name: str, tasks: List[Task] = None) -&gt; PushResponse:
411428
&#34;&#34;&#34;
@@ -653,45 +670,63 @@ <h3>Methods</h3>
653670
<span>(</span><span>task_id: str, payload_type: str, payload: dict, lease_id: str = None)</span>
654671
</code></dt>
655672
<dd>
656-
<div class="desc"><p>Represents a NitricTask.</p>
657-
<p>Construct a new Task.</p></div>
673+
<div class="desc"><p>Represents a NitricTask.</p></div>
658674
<details class="source">
659675
<summary>
660676
<span>Expand source code</span>
661677
</summary>
662678
<pre><code class="python">class Task(object):
663679
&#34;&#34;&#34;Represents a NitricTask.&#34;&#34;&#34;
664-
665-
def __init__(self, task_id: str, payload_type: str, payload: dict, lease_id: str = None):
666-
&#34;&#34;&#34;Construct a new Task.&#34;&#34;&#34;
667-
self.task_id = task_id
668-
self.payload_type = payload_type
669-
self.payload = payload
670-
self.lease_id = lease_id</code></pre>
680+
task_id: str
681+
payload_type: str
682+
payload: dict
683+
lease_id: str = field(default=None)</code></pre>
671684
</details>
672685
<h3>Subclasses</h3>
673686
<ul class="hlist">
674687
<li><a title="nitric.api.models.FailedTask" href="models.html#nitric.api.models.FailedTask">FailedTask</a></li>
675688
</ul>
689+
<h3>Class variables</h3>
690+
<dl>
691+
<dt id="nitric.api.Task.lease_id"><code class="name">var <span class="ident">lease_id</span> : str</code></dt>
692+
<dd>
693+
<div class="desc"></div>
694+
</dd>
695+
<dt id="nitric.api.Task.payload"><code class="name">var <span class="ident">payload</span> : dict</code></dt>
696+
<dd>
697+
<div class="desc"></div>
698+
</dd>
699+
<dt id="nitric.api.Task.payload_type"><code class="name">var <span class="ident">payload_type</span> : str</code></dt>
700+
<dd>
701+
<div class="desc"></div>
702+
</dd>
703+
<dt id="nitric.api.Task.task_id"><code class="name">var <span class="ident">task_id</span> : str</code></dt>
704+
<dd>
705+
<div class="desc"></div>
706+
</dd>
707+
</dl>
676708
</dd>
677709
<dt id="nitric.api.Topic"><code class="flex name class">
678710
<span>class <span class="ident">Topic</span></span>
679711
<span>(</span><span>name: str)</span>
680712
</code></dt>
681713
<dd>
682-
<div class="desc"><p>Represents event topic metadata.</p>
683-
<p>Construct a new topic instance.</p></div>
714+
<div class="desc"><p>Represents event topic metadata.</p></div>
684715
<details class="source">
685716
<summary>
686717
<span>Expand source code</span>
687718
</summary>
688719
<pre><code class="python">class Topic(object):
689720
&#34;&#34;&#34;Represents event topic metadata.&#34;&#34;&#34;
690-
691-
def __init__(self, name: str):
692-
&#34;&#34;&#34;Construct a new topic instance.&#34;&#34;&#34;
693-
self.name = name</code></pre>
721+
name: str</code></pre>
694722
</details>
723+
<h3>Class variables</h3>
724+
<dl>
725+
<dt id="nitric.api.Topic.name"><code class="name">var <span class="ident">name</span> : str</code></dt>
726+
<dd>
727+
<div class="desc"></div>
728+
</dd>
729+
</dl>
695730
</dd>
696731
<dt id="nitric.api.TopicClient"><code class="flex name class">
697732
<span>class <span class="ident">TopicClient</span></span>
@@ -775,6 +810,11 @@ <h1>Index</h1>
775810
<ul>
776811
<li>
777812
<h4><code><a title="nitric.api.Event" href="#nitric.api.Event">Event</a></code></h4>
813+
<ul class="">
814+
<li><code><a title="nitric.api.Event.event_id" href="#nitric.api.Event.event_id">event_id</a></code></li>
815+
<li><code><a title="nitric.api.Event.payload" href="#nitric.api.Event.payload">payload</a></code></li>
816+
<li><code><a title="nitric.api.Event.payload_type" href="#nitric.api.Event.payload_type">payload_type</a></code></li>
817+
</ul>
778818
</li>
779819
<li>
780820
<h4><code><a title="nitric.api.EventClient" href="#nitric.api.EventClient">EventClient</a></code></h4>
@@ -784,6 +824,9 @@ <h4><code><a title="nitric.api.EventClient" href="#nitric.api.EventClient">Event
784824
</li>
785825
<li>
786826
<h4><code><a title="nitric.api.FailedTask" href="#nitric.api.FailedTask">FailedTask</a></code></h4>
827+
<ul class="">
828+
<li><code><a title="nitric.api.FailedTask.message" href="#nitric.api.FailedTask.message">message</a></code></li>
829+
</ul>
787830
</li>
788831
<li>
789832
<h4><code><a title="nitric.api.KeyValueClient" href="#nitric.api.KeyValueClient">KeyValueClient</a></code></h4>
@@ -809,9 +852,18 @@ <h4><code><a title="nitric.api.StorageClient" href="#nitric.api.StorageClient">S
809852
</li>
810853
<li>
811854
<h4><code><a title="nitric.api.Task" href="#nitric.api.Task">Task</a></code></h4>
855+
<ul class="">
856+
<li><code><a title="nitric.api.Task.lease_id" href="#nitric.api.Task.lease_id">lease_id</a></code></li>
857+
<li><code><a title="nitric.api.Task.payload" href="#nitric.api.Task.payload">payload</a></code></li>
858+
<li><code><a title="nitric.api.Task.payload_type" href="#nitric.api.Task.payload_type">payload_type</a></code></li>
859+
<li><code><a title="nitric.api.Task.task_id" href="#nitric.api.Task.task_id">task_id</a></code></li>
860+
</ul>
812861
</li>
813862
<li>
814863
<h4><code><a title="nitric.api.Topic" href="#nitric.api.Topic">Topic</a></code></h4>
864+
<ul class="">
865+
<li><code><a title="nitric.api.Topic.name" href="#nitric.api.Topic.name">name</a></code></li>
866+
</ul>
815867
</li>
816868
<li>
817869
<h4><code><a title="nitric.api.TopicClient" href="#nitric.api.TopicClient">TopicClient</a></code></h4>

0 commit comments

Comments
 (0)