Refactor: Standardize insight NAME attributes to snake_case identifiers#84
Closed
Sourabhchrs93 wants to merge 2 commits intomainfrom
Closed
Refactor: Standardize insight NAME attributes to snake_case identifiers#84Sourabhchrs93 wants to merge 2 commits intomainfrom
Sourabhchrs93 wants to merge 2 commits intomainfrom
Conversation
Update NAME attributes across all insight classes from verbose descriptions
to concise snake_case identifiers for better programmatic usage. This change
affects 54 files across checks, tests, governance, modelling, performance,
SQL, and structure insights.
Key changes:
- Check insights: Use descriptive snake_case (e.g., column_name_inconsistent_desc)
- Test insights: Standardize naming (e.g., missing_primary_keys_tests)
- Governance insights: Clarify purpose (e.g., public_model_no_contract)
- Modelling insights: Simplify names (e.g., direct_join_to_source)
- Performance insights: Concise identifiers (e.g., chain_view_linking)
- Structure insights: Pattern-based naming (e.g., model_path_violation)
Also fixes typo in check_model_name_contract.py ("Mmdel" -> proper identifier)
ALIAS and DESCRIPTION fields remain unchanged for backward compatibility
and human-readable documentation.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
already merged. |
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to d968896 in 2 minutes and 1 seconds. Click for details.
- Reviewed
709lines of code in54files - Skipped
0files when reviewing. - Skipped posting
9draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. src/datapilot/core/platforms/dbt/insights/:1
- Draft comment:
Overall, the refactor updates all insight NAME attributes to concise snake_case identifiers (e.g. 'column_name_inconsistent_desc', 'model_missing_columns', 'public_model_no_contract', etc.). ALIAS, DESCRIPTION and other fields remain unchanged for backward compatibility. The changes are consistent and improve programmatic usage. Please ensure integration tests confirm no regressions. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
2. src/datapilot/core/platforms/dbt/insights/checks/check_source_columns_have_desc.py:19
- Draft comment:
There seems to be an extra trailing space at the end of the string in REASON_TO_FLAG. Consider removing the trailing space for consistency. - Reason this comment was not posted:
Comment was on unchanged code.
3. src/datapilot/core/platforms/dbt/insights/checks/check_source_has_all_columns.py:20
- Draft comment:
Typo: There appears to be an extra trailing space at the end of the REASON_TO_FLAG string. Consider removing it for consistency. - Reason this comment was not posted:
Comment was on unchanged code.
4. src/datapilot/core/platforms/dbt/insights/checks/check_source_has_loader.py:14
- Draft comment:
There appears to be a trailing space at the end of the REASON_TO_FLAG string (after "analysis."). It might be worth removing this extra whitespace. - Reason this comment was not posted:
Comment was on unchanged code.
5. src/datapilot/core/platforms/dbt/insights/checks/check_source_table_has_description.py:14
- Draft comment:
There's a trailing space at the end of the REASON_TO_FLAG string. Consider removing it for consistency. - Reason this comment was not posted:
Comment was on unchanged code.
6. src/datapilot/core/platforms/dbt/insights/dbt_test/missing_primary_key_tests.py:26
- Draft comment:
There's an extra space at the end of the DESCRIPTION string. Please remove the trailing space. - Reason this comment was not posted:
Comment was on unchanged code.
7. src/datapilot/core/platforms/dbt/insights/performance/chain_view_linking.py:19
- Draft comment:
Typographical Issue: There is trailing whitespace at the end of the description string. Consider removing the extra space to maintain consistency. - Reason this comment was not posted:
Comment was on unchanged code.
8. src/datapilot/core/platforms/dbt/insights/sql/sql_check.py:35
- Draft comment:
Typo: There is an extra trailing space in the DESCRIPTION string. Consider removing the space at the end. - Reason this comment was not posted:
Comment was on unchanged code.
9. src/datapilot/core/platforms/dbt/insights/sql/sql_check.py:37
- Draft comment:
Typo: There is an extra trailing space in the FAILURE_MESSAGE string. Consider removing the space at the end. - Reason this comment was not posted:
Comment was not on a location in the diff, so it can't be submitted as a review comment.
Workflow ID: wflow_2NIOpWnemTVR1omt
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
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
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.
Update NAME attributes across all insight classes from verbose descriptions to concise snake_case identifiers for better programmatic usage. This change affects 54 files across checks, tests, governance, modelling, performance, SQL, and structure insights.
Key changes:
Also fixes typo in check_model_name_contract.py ("Mmdel" -> proper identifier)
ALIAS and DESCRIPTION fields remain unchanged for backward compatibility and human-readable documentation.
🤖 Generated with Claude Code
Important
Standardizes
NAMEattributes to snake_case identifiers across all insight classes, affecting 54 files, and fixes a typo incheck_model_name_contract.py.NAMEattributes to snake_case identifiers across all insight classes for better programmatic usage.ALIASandDESCRIPTIONfields remain unchanged for backward compatibility.check_model_name_contract.py("Mmdel" -> proper identifier).This description was created by
for d968896. You can customize this summary. It will automatically update as commits are pushed.