@@ -1611,7 +1611,7 @@ <h4 id="frequenz.client.dispatch.test.client.FakeClient" class="doc doc-heading"
16111611
16121612 < div class ="doc doc-contents ">
16131613 < p class ="doc doc-class-bases ">
1614- Bases: < code > < a class ="autorefs autorefs-internal " title ="frequenz.client.dispatch.Client " href ="../../#frequenz.client.dispatch.Client " > Client </ a > </ code > </ p >
1614+ Bases: < code > < a class ="autorefs autorefs-internal " title ="frequenz.client.dispatch.DispatchApiClient " href ="../../#frequenz.client.dispatch.DispatchApiClient " > DispatchApiClient </ a > </ code > </ p >
16151615
16161616
16171617 < p > Fake client for testing.</ p >
@@ -1684,7 +1684,7 @@ <h4 id="frequenz.client.dispatch.test.client.FakeClient" class="doc doc-heading"
16841684< span class ="normal "> < a href ="#__codelineno-0-71 "> 71</ a > </ span >
16851685< span class ="normal "> < a href ="#__codelineno-0-72 "> 72</ a > </ span >
16861686< span class ="normal "> < a href ="#__codelineno-0-73 "> 73</ a > </ span >
1687- < span class ="normal "> < a href ="#__codelineno-0-74 "> 74</ a > </ span > </ pre > </ div > </ td > < td class ="code "> < div > < pre > < span > </ span > < code > < span id ="__span-0-15 "> < a id ="__codelineno-0-15 " name ="__codelineno-0-15 "> </ a > < span class ="k "> class</ span > < span class ="w "> </ span > < span class ="nc "> FakeClient</ span > < span class ="p "> (</ span > < span class ="n "> Client </ span > < span class ="p "> ):</ span >
1687+ < span class ="normal "> < a href ="#__codelineno-0-74 "> 74</ a > </ span > </ pre > </ div > </ td > < td class ="code "> < div > < pre > < span > </ span > < code > < span id ="__span-0-15 "> < a id ="__codelineno-0-15 " name ="__codelineno-0-15 "> </ a > < span class ="k "> class</ span > < span class ="w "> </ span > < span class ="nc "> FakeClient</ span > < span class ="p "> (</ span > < span class ="n "> DispatchApiClient </ span > < span class ="p "> ):</ span >
16881688</ span > < span id ="__span-0-16 "> < a id ="__codelineno-0-16 " name ="__codelineno-0-16 "> </ a > < span class ="w "> </ span > < span class ="sd "> """Fake client for testing.</ span >
16891689</ span > < span id ="__span-0-17 "> < a id ="__codelineno-0-17 " name ="__codelineno-0-17 "> </ a >
16901690</ span > < span id ="__span-0-18 "> < a id ="__codelineno-0-18 " name ="__codelineno-0-18 "> </ a > < span class ="sd "> This client uses a fake service to simulate the dispatch api.</ span >
@@ -3018,7 +3018,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.list" class="doc doc-hea
30183018over the dispatches. Pagination parameters like < code > page_size</ code > and < code > page_token</ code >
30193019can be used, but they are mutually exclusive.</ p >
30203020< p > Example usage:</ p >
3021- < div class ="language-python highlight "> < pre > < span > </ span > < code > < span id ="__span-0-1 "> < a id ="__codelineno-0-1 " name ="__codelineno-0-1 " href ="#__codelineno-0-1 "> </ a > < span class ="n "> client</ span > < span class ="o "> =</ span > < span class ="n "> Client </ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="o "> =</ span > < span class ="s2 "> "key"</ span > < span class ="p "> ,</ span > < span class ="n "> server_url</ span > < span class ="o "> =</ span > < span class ="s2 "> "grpc://fz-0004.frequenz.io"</ span > < span class ="p "> )</ span >
3021+ < div class ="language-python highlight "> < pre > < span > </ span > < code > < span id ="__span-0-1 "> < a id ="__codelineno-0-1 " name ="__codelineno-0-1 " href ="#__codelineno-0-1 "> </ a > < span class ="n "> client</ span > < span class ="o "> =</ span > < span class ="n "> DispatchApiClient </ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="o "> =</ span > < span class ="s2 "> "key"</ span > < span class ="p "> ,</ span > < span class ="n "> server_url</ span > < span class ="o "> =</ span > < span class ="s2 "> "grpc://fz-0004.frequenz.io"</ span > < span class ="p "> )</ span >
30223022</ span > < span id ="__span-0-2 "> < a id ="__codelineno-0-2 " name ="__codelineno-0-2 " href ="#__codelineno-0-2 "> </ a > < span class ="k "> async</ span > < span class ="k "> for</ span > < span class ="n "> page</ span > < span class ="ow "> in</ span > < span class ="n "> client</ span > < span class ="o "> .</ span > < span class ="n "> list</ span > < span class ="p "> (</ span > < span class ="n "> microgrid_id</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span > < span class ="p "> ):</ span >
30233023</ span > < span id ="__span-0-3 "> < a id ="__codelineno-0-3 " name ="__codelineno-0-3 " href ="#__codelineno-0-3 "> </ a > < span class ="k "> for</ span > < span class ="n "> dispatch</ span > < span class ="ow "> in</ span > < span class ="n "> page</ span > < span class ="p "> :</ span >
30243024</ span > < span id ="__span-0-4 "> < a id ="__codelineno-0-4 " name ="__codelineno-0-4 " href ="#__codelineno-0-4 "> </ a > < span class ="nb "> print</ span > < span class ="p "> (</ span > < span class ="n "> dispatch</ span > < span class ="p "> )</ span >
@@ -3392,7 +3392,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.list" class="doc doc-hea
33923392</ span > < span id ="__span-0-125 "> < a id ="__codelineno-0-125 " name ="__codelineno-0-125 "> </ a > < span class ="sd "> Example usage:</ span >
33933393</ span > < span id ="__span-0-126 "> < a id ="__codelineno-0-126 " name ="__codelineno-0-126 "> </ a >
33943394</ span > < span id ="__span-0-127 "> < a id ="__codelineno-0-127 " name ="__codelineno-0-127 "> </ a > < span class ="sd "> ```python</ span >
3395- </ span > < span id ="__span-0-128 "> < a id ="__codelineno-0-128 " name ="__codelineno-0-128 "> </ a > < span class ="sd "> client = Client (key="key", server_url="grpc://fz-0004.frequenz.io")</ span >
3395+ </ span > < span id ="__span-0-128 "> < a id ="__codelineno-0-128 " name ="__codelineno-0-128 "> </ a > < span class ="sd "> client = DispatchApiClient (key="key", server_url="grpc://fz-0004.frequenz.io")</ span >
33963396</ span > < span id ="__span-0-129 "> < a id ="__codelineno-0-129 " name ="__codelineno-0-129 "> </ a > < span class ="sd "> async for page in client.list(microgrid_id=1):</ span >
33973397</ span > < span id ="__span-0-130 "> < a id ="__codelineno-0-130 " name ="__codelineno-0-130 "> </ a > < span class ="sd "> for dispatch in page:</ span >
33983398</ span > < span id ="__span-0-131 "> < a id ="__codelineno-0-131 " name ="__codelineno-0-131 "> </ a > < span class ="sd "> print(dispatch)</ span >
@@ -3605,7 +3605,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.stream" class="doc doc-h
36053605dispatch events.
36063606An event is one of [CREATE, UPDATE, DELETE].</ p >
36073607< p > Example usage:</ p >
3608- < div class ="language-text highlight "> < pre > < span > </ span > < code > < span id ="__span-0-1 "> < a id ="__codelineno-0-1 " name ="__codelineno-0-1 " href ="#__codelineno-0-1 "> </ a > client = Client (key="key", server_url="grpc://fz-0004.frequenz.io")
3608+ < div class ="language-text highlight "> < pre > < span > </ span > < code > < span id ="__span-0-1 "> < a id ="__codelineno-0-1 " name ="__codelineno-0-1 " href ="#__codelineno-0-1 "> </ a > client = DispatchApiClient (key="key", server_url="grpc://fz-0004.frequenz.io")
36093609</ span > < span id ="__span-0-2 "> < a id ="__codelineno-0-2 " name ="__codelineno-0-2 " href ="#__codelineno-0-2 "> </ a > async for message in client.stream(microgrid_id=1):
36103610</ span > < span id ="__span-0-3 "> < a id ="__codelineno-0-3 " name ="__codelineno-0-3 " href ="#__codelineno-0-3 "> </ a > print(message.event, message.dispatch)
36113611</ span > </ code > </ pre > </ div >
@@ -3701,7 +3701,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.stream" class="doc doc-h
37013701</ span > < span id ="__span-0-207 "> < a id ="__codelineno-0-207 " name ="__codelineno-0-207 "> </ a > < span class ="sd "> Example usage:</ span >
37023702</ span > < span id ="__span-0-208 "> < a id ="__codelineno-0-208 " name ="__codelineno-0-208 "> </ a >
37033703</ span > < span id ="__span-0-209 "> < a id ="__codelineno-0-209 " name ="__codelineno-0-209 "> </ a > < span class ="sd "> ```</ span >
3704- </ span > < span id ="__span-0-210 "> < a id ="__codelineno-0-210 " name ="__codelineno-0-210 "> </ a > < span class ="sd "> client = Client (key="key", server_url="grpc://fz-0004.frequenz.io")</ span >
3704+ </ span > < span id ="__span-0-210 "> < a id ="__codelineno-0-210 " name ="__codelineno-0-210 "> </ a > < span class ="sd "> client = DispatchApiClient (key="key", server_url="grpc://fz-0004.frequenz.io")</ span >
37053705</ span > < span id ="__span-0-211 "> < a id ="__codelineno-0-211 " name ="__codelineno-0-211 "> </ a > < span class ="sd "> async for message in client.stream(microgrid_id=1):</ span >
37063706</ span > < span id ="__span-0-212 "> < a id ="__codelineno-0-212 " name ="__codelineno-0-212 "> </ a > < span class ="sd "> print(message.event, message.dispatch)</ span >
37073707</ span > < span id ="__span-0-213 "> < a id ="__codelineno-0-213 " name ="__codelineno-0-213 "> </ a > < span class ="sd "> ```</ span >
0 commit comments