feat: support for custom time granularities #54
Closed
Conversation
This file contains 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
We introduced custom granularities, and now we need to add support for it in the SDK. This commit is the first step towards that. It changes all usages of `TimeGranularity` by a new `Grain` type, which can be either the standard `TimeGranularity` or a `str` that represents a custom granilarity. We still haven't changed the underlying implementation to allow for fetching these custom grains or sending them via GraphQL. This will be next.
This commit adds a new classmethod called `extra_gql_fields` to `GraphQLFragmentMixin`. This method should return any extra fields that should be added to the GraphQL fragment that represents that dataclass. This can be paired with `dataclasses.InitVar` to create "hidden" fields that get queried via GraphQL and fed into `__post_init__` without actually exposing them to the dataclass. I used this to combine `queryableGranularities` and `queryableTimeGranularities` in one single field that is a list of `Grain`, so that it's less confusing to users.
serramatutu
commented
Oct 17, 2024
| @@ -32,7 +33,7 @@ def _serialize_val(cls, val: Any) -> str: | |||
| if isinstance(val, OrderByGroupBy): | |||
| d = f'Dimension("{val.name}")' | |||
| if val.grain: | |||
| grain_str = val.grain.name.lower() | |||
| grain_str = val.grain.name.lower() if isinstance(val.grain, TimeGranularity) else val.grain.lower() | |||
There was a problem hiding this comment.
@courtneyholcomb This supposes custom grains are not case-sensitive. Is this true?
There was a problem hiding this comment.
They will be lowercase! This is enforced with a validation error in DSI
|
I closed this since I realized at the end that we're actually returning the existing grains from |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR adds support for custom time granularities in the SDK.
Changes
Graintype that can be either the standardTimeGranularityorstr, representing a custom grain.TimeGranularityin our input/output models to useGrainqueryable_granularitiesat__post_init__inMetricandDimension.I recommend reviewing this commit by commit.
Breaking changes
Users expecting
Metric.queryable_granularitiesandDimension.queryable_granularitiesto be onlyTimeGranularitynow need to account for them beingstr.