Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MAINTENANCE] Remove context root directory search logic within SerializableDataContext #9904

Closed
wants to merge 5 commits into from

Conversation

cdkini
Copy link
Member

@cdkini cdkini commented May 8, 2024

In 0.18.x, the context would search up to 4 levels up in a file/directory structure to find a GX project. This feels a bit too magical and results in difficult to diagnose bugs.

  • Description of PR changes above includes a link to an existing GitHub issue
  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses ruff format + ruff check)
  • Appropriate tests and docs have been updated

For more information about contributing, see Contribute.

After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!

Copy link

netlify bot commented May 8, 2024

Deploy Preview for niobium-lead-7998 canceled.

Name Link
🔨 Latest commit 77e1774
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/663d2a2365a65d0008100182

@cdkini cdkini self-assigned this May 8, 2024
Copy link

codecov bot commented May 8, 2024

Codecov Report

Attention: Patch coverage is 90.90909% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 77.32%. Comparing base (ed3b5b4) to head (77e1774).

Files Patch % Lines
..._context/data_context/serializable_data_context.py 90.90% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #9904      +/-   ##
===========================================
+ Coverage    77.28%   77.32%   +0.03%     
===========================================
  Files          492      492              
  Lines        42006    41971      -35     
===========================================
- Hits         32465    32453      -12     
+ Misses        9541     9518      -23     
Flag Coverage Δ
3.10 63.75% <54.54%> (+0.02%) ⬆️
3.11 63.75% <54.54%> (+0.02%) ⬆️
3.11 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 53.66% <18.18%> (+0.02%) ⬆️
3.11 aws_deps 44.77% <54.54%> (+<0.01%) ⬆️
3.11 big 54.24% <54.54%> (+0.01%) ⬆️
3.11 databricks 45.93% <18.18%> (+0.02%) ⬆️
3.11 filesystem 59.19% <90.90%> (+0.02%) ⬆️
3.11 mssql 48.77% <18.18%> (+0.02%) ⬆️
3.11 mysql 48.82% <18.18%> (+0.02%) ⬆️
3.11 postgresql 52.70% <18.18%> (+0.02%) ⬆️
3.11 snowflake 46.56% <18.18%> (+0.02%) ⬆️
3.11 spark 56.33% <18.18%> (+0.03%) ⬆️
3.11 trino 50.76% <18.18%> (+0.02%) ⬆️
3.8 63.77% <54.54%> (+0.02%) ⬆️
3.8 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 53.67% <18.18%> (+0.02%) ⬆️
3.8 aws_deps 44.79% <54.54%> (+<0.01%) ⬆️
3.8 big 54.25% <54.54%> (+0.01%) ⬆️
3.8 databricks 45.94% <18.18%> (+0.02%) ⬆️
3.8 filesystem 59.20% <90.90%> (+0.02%) ⬆️
3.8 mssql 48.75% <18.18%> (+0.02%) ⬆️
3.8 mysql 48.81% <18.18%> (+0.02%) ⬆️
3.8 postgresql 52.68% <18.18%> (+0.02%) ⬆️
3.8 snowflake 46.57% <18.18%> (+0.01%) ⬆️
3.8 spark 56.30% <18.18%> (+0.03%) ⬆️
3.8 trino 50.74% <18.18%> (+0.02%) ⬆️
3.9 63.77% <54.54%> (+0.02%) ⬆️
cloud 0.00% <0.00%> (ø)
docs-basic 47.38% <90.90%> (+0.01%) ⬆️
docs-creds-needed 48.43% <90.90%> (+0.01%) ⬆️
docs-spark 47.10% <90.90%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@billdirks billdirks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this! We should verify with @jcampbell that he is onboard with this change.

) or cls._search_gx_dir_for_context_yml(
search_start_dir=search_start_dir, gx_dir=cls._LEGACY_GX_DIR
directory_to_search=directory_to_search, gx_dir_name=cls._LEGACY_GX_DIR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can get rid of this _LEGACY_GX_DIR also.

)

@classmethod
def _search_gx_dir_for_context_yml(
cls, search_start_dir: pathlib.Path, gx_dir: str
cls, directory_to_search: pathlib.Path, gx_dir_name: str
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: This signature is kind of strange since one argument is a path and one is a str.

@cdkini cdkini closed this May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants