Allow custom granularity names in string name to struct conversion #1387
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 was referenced Aug 29, 2024
|
Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide. |
tlento
force-pushed
the
allow-arbitrary-granularity-names-in-structured-linkable-spect-name
branch
from
ea0ee4f to
c8ca0af
Compare
|
|
||
| This implies that all values in the TimeGranularity enumeration must be lower-case. | ||
| """ | ||
| assert self.element_name.lower() == self.element_name, ( |
There was a problem hiding this comment.
This means that custom granularities will be required to be lowercase. Is that a necessary restriction?
There was a problem hiding this comment.
In my opinion, yes. We do not want Fortnight and fortnight to mean different things in the same model. But also this this the standard we've used for ages.
| "parse time!" | ||
| ) | ||
| assert all([link_name.lower() == link_name for link_name in self.entity_link_names]), ( | ||
| f"Found entity link name that includes upper-case letters. Entity link names: {self.entity_link_names}. " |
There was a problem hiding this comment.
Is this enforced already? That entity names must be lowercase?
There was a problem hiding this comment.
Excellent! And a helpful link pointing me to how to add this validation for custom granularities too 🙃
This was referenced Sep 3, 2024
courtneyholcomb
approved these changes
Sep 3, 2024
tlento
force-pushed
the
allow-arbitrary-granularity-names-in-structured-linkable-spect-name
branch
from
c8ca0af to
dafccd5
Compare
tlento
changed the base branch from
remove-from-name-spec-methods
to
graphite-base/1387
MetricFlow relies on a class called StructuredLinkableSpecName to manage conversion between structured names and their string representations, e.g., `listing__is_lux` or `listing__created_at__month`. Up until now the time granularity component of this naming struct required an enumeration value, which would then be converted to its string representation at serialization time. With custom granularities we need to explicitly allow for a string name for the input time granularity. This implements that change, along with some added enforcement to ensure consistency in how we conver to/from the string representations of these names.
tlento
force-pushed
the
allow-arbitrary-granularity-names-in-structured-linkable-spect-name
branch
from
dafccd5 to
1b2bbeb
Compare
tlento
deleted the
allow-arbitrary-granularity-names-in-structured-linkable-spect-name
branch
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.
MetricFlow relies on a class called StructuredLinkableSpecName to manage
conversion between structured names and their string representations,
e.g.,
listing__is_luxorlisting__created_at__month.Up until now the time granularity component of this naming struct
required an enumeration value, which would then be converted to its
string representation at serialization time. With custom granularities
we need to explicitly allow for a string name for the input time
granularity. This implements that change, along with some added
enforcement to ensure consistency in how we conver to/from the string
representations of these names.