✨ add list_cubes method to client#6
Merged
rafaelleinio merged 3 commits intoMay 18, 2026
Conversation
rafaelleinio
requested changes
May 18, 2026
Comment on lines
+111
to
+113
| cube["name"] | ||
| for cube in response.json().get("cubes", []) | ||
| if isinstance(cube, dict) and isinstance(cube.get("name"), str) |
Collaborator
There was a problem hiding this comment.
can you structure the response as pydantic model? it's the pattern we use for other requests
Comment on lines
+248
to
+250
| measures: list["CubeJSMetaMeasure"] = Field(default_factory=list) | ||
| dimensions: list["CubeJSMetaDimension"] = Field(default_factory=list) | ||
| segments: list["CubeJSMetaSegment"] = Field(default_factory=list) |
Collaborator
There was a problem hiding this comment.
if you use from __future__ import annotations you don't need to use this string reference here, it could be just list[CubeJSMetaMeasure]
Comment on lines
+256
to
+306
| class CubeJSMetaMeasure(BaseModel): | ||
| """CubeJS measure metadata.""" | ||
|
|
||
| name: str | ||
| title: str | ||
| type: str | ||
| short_title: str | None = Field(default=None, alias="shortTitle") | ||
| alias_name: str | None = Field(default=None, alias="aliasName") | ||
| agg_type: str | None = Field(default=None, alias="aggType") | ||
| drill_members: list[str] = Field(default_factory=list, alias="drillMembers") | ||
|
|
||
| class Config: # noqa: D106 | ||
| populate_by_name = True | ||
|
|
||
|
|
||
| class CubeJSMetaDimension(BaseModel): | ||
| """CubeJS dimension metadata.""" | ||
|
|
||
| name: str | ||
| title: str | ||
| type: str | ||
| short_title: str | None = Field(default=None, alias="shortTitle") | ||
| alias_name: str | None = Field(default=None, alias="aliasName") | ||
| suggest_filter_values: bool | None = Field( | ||
| default=None, alias="suggestFilterValues" | ||
| ) | ||
|
|
||
| class Config: # noqa: D106 | ||
| populate_by_name = True | ||
|
|
||
|
|
||
| class CubeJSMetaSegment(BaseModel): | ||
| """CubeJS segment metadata.""" | ||
|
|
||
| name: str | ||
| title: str | ||
| short_title: str | None = Field(default=None, alias="shortTitle") | ||
|
|
||
| class Config: # noqa: D106 | ||
| populate_by_name = True | ||
|
|
||
|
|
||
| class CubeJSMetaResponse(BaseModel): | ||
| """CubeJS metadata response. | ||
|
|
||
| Args: | ||
| cubes: cubejs metadata entries for cubes and views. | ||
|
|
||
| """ | ||
|
|
||
| cubes: list[CubeJSMetaCube] = Field(default_factory=list) |
rafaelleinio
approved these changes
May 18, 2026
Collaborator
rafaelleinio
left a comment
rafaelleinio
left a comment
There was a problem hiding this comment.
I'll merge and release, thanks for the contribution old friend 🤓
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit a324296. Configure here.
Contributor
Author
haha it's been a pleasure |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Low Risk
Low risk, additive change that introduces a new metadata call and data models without altering existing query execution logic.
Overview
Adds a new async
list_cubes()client method that calls CubeJSGET /cubejs-api/v1/metawith the same retry/error-handling behavior asget_measures, returning a typedCubeJSMetaResponse.Introduces Pydantic metadata models (
CubeJSMetaCube,CubeJSMetaMeasure,CubeJSMetaDimension,CubeJSMetaSegment) with alias support for CubeJS field names, exports them fromcubejs.__init__, and adds unit tests covering successful parsing/serialization and 400-error handling. Also updatesuv.lock(dependency metadata churn).Reviewed by Cursor Bugbot for commit a324296. Bugbot is set up for automated code reviews on this repo. Configure here.
Implements meta endpoint as a list cubes method