DOCS-2899: Edit code samples from Data client QA #3457
Conversation
sguequierre
commented
Sep 13, 2024
sguequierre
commented
- mirrors python sdk pr DOCS-2899: Clean up data client API code samples viam-python-sdk#729
viambot
added
the
safe to build
| if not tabular_data: | ||
| break | ||
| my_data.extend(tabular_data) | ||
| left_motor_filter = create_filter( |
| component_name="motor-1" | ||
| ) | ||
|
|
||
| data, count, last = await data_client.tabular_data_by_filter( |
There was a problem hiding this comment.
I think showing the loop is probably good because it's a more realistic use case. most people will use this to get more than 50 data points.
| for tab in data: | ||
| print(tab) |
There was a problem hiding this comment.
I don't think the variable naming here makes sense. what does tab stand for tab? Maybe reading?
| tabular_data = await data_client.tabular_data_by_mql( | ||
| organization_id="<YOUR-ORG-ID>", | ||
| mql_binary=binary_pipeline | ||
| ) |
| @@ -88,17 +89,40 @@ Obtain unified tabular data and metadata, queried with MQL. | |||
| ```python {class="line-numbers linkable-line-numbers"} | |||
There was a problem hiding this comment.
I'm confused with this, this feels like it's become a much more involved code sample. And we now no longer show how it works with pymongo?
There was a problem hiding this comment.
this was required to make it work and I am still using pymongo-- it wasn't working for me otherwise
There was a problem hiding this comment.
I see you are indeed using pymongo. Which means the code now doesn't work for the bson package.
I just tested both code snippets again and they do work.
Did you run pip uninstall pymongo and pip install bson when you were using the bson package code? Can you try these again and let me know if they work? If not lets look into it together. The code snippets as they are are a lot shorter and cleaner so if possible I'd like to stick with them
Maybe we can make that clearer like this?
# using bson package (pip install bson)
import bson
tabular_data = await data_client.tabular_data_by_mql(org_id="<your-org-id>", mql_binary=[
bson.dumps({ '$match': { 'location_id': '<location-id>' } }),
bson.dumps({ '$limit': 5 })
])
# using pymongo package (pip install pymongo)
import bson
tabular_data = await data_client.tabular_data_by_mql(org_id="<your-org-id>", mql_binary=[
bson.encode({ '$match': { 'location_id': '<location-id>' } }),
bson.encode({ '$limit': 5 })
])There was a problem hiding this comment.
I got the first option to work with organization_id. The second option as far as i can tell with pymongo still needs to be bson.BSON to work properly. Editing as such
There was a problem hiding this comment.
yeah true I missed the organization_id bit when copying - I'll send you a code snippet.
There was a problem hiding this comment.
bson.BSON.encode works, but weirdly so does running it without. I'd love to see what error you're getting but this is fine to merge
| my_data.extend(data) | ||
| camera_filter = create_filter( | ||
| component_name="camera-1" | ||
| ) |
| filter=my_filter, | ||
| limit=20, | ||
| include_binary_data=False | ||
| ) |
| org_id="a12b3c4e-1234-1abc-ab1c-ab1c2d345abc", days_of_data_to_delete) | ||
| organization_id="<YOUR-ORG-ID>", | ||
| delete_older_than_days=150 | ||
| ) |
|
|
||
| my_filter = create_filter(component_name="camera-1", organization_ids=["<YOUR-ORG-ID>"]) | ||
| binary_metadata = await data_client.binary_data_by_filter( |
There was a problem hiding this comment.
| binary_metadata = await data_client.binary_data_by_filter( | |
| binary_metadata, count, last = await data_client.binary_data_by_filter( |
There was a problem hiding this comment.
This does not work. It produces this error:
File "/Users/sierraguequierre/Desktop/data-client-qa.py", line 394, in main
binary_metadata, count, last = await data_client.binary_data_by_filter(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: DataClient.binary_data_by_filter() got an unexpected keyword argument 'include_file_data
the type returned is a list. I don't know why the error is like that but the way I have it does work and does not produce that error. Should I file a bug/are you able to reproduce? @npentrel
There was a problem hiding this comment.
for context this is the extent of my code that produces that error:
binary_metadata, count, last = await data_client.binary_data_by_filter( include_file_data=False )
There was a problem hiding this comment.
actually nvm just tested it again and it doesn't now. no idea why that was happening but can't repro. weird
| ) | ||
|
|
||
| my_ids = [] | ||
|
|
||
| for obj in binary_metadata: | ||
| for obj in binary_metadata[0]: |
There was a problem hiding this comment.
| for obj in binary_metadata[0]: | |
| for obj in binary_metadata: |
| ) | ||
|
|
||
|
|
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3457 |
