Enforce more specific PUDL resource name constraints. #4438
+99
−62
Conversation
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
zaneselvans
added
metadata
zaneselvans
commented
Jul 16, 2025
Comment on lines
-184
to
+188
| min_length=1, strict=True, pattern=r"^[a-z_][a-z0-9_]*(_[a-z0-9]+)*$" | ||
| min_length=1, | ||
| strict=True, | ||
| pattern=r"^[a-z_][a-z0-9_]*(_[a-z0-9]+)*$", |
There was a problem hiding this comment.
No changes here -- just forced args onto individual lines.
Comment on lines
+193
to
+201
| PudlResourceName = Annotated[ | ||
| str, | ||
| StringConstraints( | ||
| min_length=1, | ||
| strict=True, | ||
| pattern=rf"^(_?core_|out_)({'|'.join(ALL_PUDL_SOURCES)})__([a-z0-9_]+)$", | ||
| ), | ||
| ] | ||
| """A valid PUDL resource name conforming to our naming conventions :class:`str`.""" |
There was a problem hiding this comment.
This was the lightest weight way I could see to do this. However, it means that the runtime enforcement of type conformance needs to be done with the function below. So maybe it would be better if it were a "real" Pydantic model, if it's not being used to type a field in a Pydantic model (as it is in the Resource class and everything that hangs off of that)
Comment on lines
+946
to
+947
|
|
||
| ALL_PUDL_SOURCES = sorted(set(SOURCES.keys()).union(["epa", "eia", "ferc"])) |
There was a problem hiding this comment.
- We use the
eiaandferc"sources" for tables that are generic to the whole agency (i.e. they come from more than one data source). - However, we haven't been great about really defining what that means -- there are many tables with multiple "sources" listed which nevertheless have a single form listed in the resource name.
- The
epasource on the other hand is a rogue, used I think becauseepacamd_eiapertains to two data sources (it's glue...) and is the only data source we have that contains an underscore, which would mess up our table naming if we used it as the data source. - So maybe
epacamd_eiashouldn't actually be allowed here. Maybe we should rename that source.
Comment on lines
-260
to
+267
| def get_data_source(table_name: str) -> str: | ||
| def get_data_source(table_name: PudlResourceName) -> str: | ||
| """Return the data source element of the table's name.""" | ||
| if not is_valid_pudl_resource_name(table_name): | ||
| raise ValueError(f"Invalid PUDL resource name: {table_name}") |
There was a problem hiding this comment.
Avoids the possibility of a malformed table name resulting in undefined behavior.
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.
Overview
core_coreandoutlayers (since those are the only ones we write to the database or Parquet).Closes #4436
Testing
To-do list