feat: support for custom grain #55
Merged
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
This commit adds a new `BaseModel.DEPRECATED` key that can be added to the dataclasses `metadata` dict to indicate that this field is deprecated.
|
By the way: I had another PR for this that kept the old |
WilliamDee
approved these changes
Oct 17, 2024
This commit introduces a new `DeprecatedMixin` class that can be added to any model class to mark that class as deprecated. It will throw a warning if the user tries to instantiate the class.
serramatutu
force-pushed
the
serramatutu/custom-grain-support
branch
from
b98ab02 to
564c332
Compare
serramatutu
commented
Oct 17, 2024
| @@ -8,7 +8,9 @@ kindFormat: '### {{.Kind}}' | |||
| changeFormat: '* {{.Body}}' | |||
| kinds: | |||
| - label: Breaking Changes | |||
| auto: major | |||
There was a problem hiding this comment.
Since we're under 1.0 we can make breaking changes in minor versions so I changed it.
serramatutu
force-pushed
the
serramatutu/custom-grain-support
branch
from
564c332 to
d34961f
Compare
|
@courtneyholcomb about testing:
|
courtneyholcomb
approved these changes
Oct 17, 2024
Since we introduced custom grains, the old `queryable_granularities` is deprecated in favor of the new `queryable_time_granilarities`, which is just a simple list of strings. This commit marks the `TimeGranularity` class and all granularity fields that return it as deprecated.
This commit changes the `OrderByGroupBy` class to use `str` instead of the deprecated `TimeGranularity` enum as its input grain. We can do this without a deprecation because we haven't released the SDK since the order by refactor, so we can just change it.
We need to call `BaseModel._register_subclasses` otherwise models will fail to use `camelCase` and raise deprecation warnings. That is done in `dbtsl.models.__init__`. If the user never explicitly imports that, this won't get called, and they might get an error. This fixes that by adding an explicit call to it on the library init.
We are raising deprecation warnings from the GQL client when we instantiate the models. To avoid the warning spam, we filter those warnings out. They should only be display if the user uses any deprecated class, not us.
serramatutu
force-pushed
the
serramatutu/custom-grain-support
branch
from
ccd5cde to
ed78b15
Compare
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 grain and deprecates old fields that use the
TimeGranularityenum. I also deprecatedTimeGranularityitself.I recommend reviewing commit by commit :)