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

refactor: add use_describe to base #236

Merged
merged 2 commits into from
May 2, 2021

Conversation

bastienboutonnet
Copy link
Member

Description

Because we allow the snowflake_connector.get_columns_from_table() to take a use_describe we also add this parameter to the base so that the signatures are the same a less persmissive than if we allowed **kwargs.

How was the change tested

(If you have implemented unit tests you can list them and give some context on what they cover. If you did not implement unit testing or the change is harder to test, tell us how you made sure your change worked so we can reproduce it and check that all the bases are covered)

@codecov
Copy link

codecov bot commented May 2, 2021

Codecov Report

Merging #236 (ac84976) into dev/0.1.0 (e24455e) will decrease coverage by 0.03%.
The diff coverage is 100.00%.

Impacted file tree graph

@@              Coverage Diff              @@
##           dev/0.1.0     #236      +/-   ##
=============================================
- Coverage      82.86%   82.83%   -0.04%     
=============================================
  Files             18       18              
  Lines           1103     1101       -2     
=============================================
- Hits             914      912       -2     
  Misses           189      189              
Flag Coverage Δ
unittests 82.83% <100.00%> (-0.04%) ⬇️

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

Impacted Files Coverage Δ
dbt_sugar/core/connectors/base.py 95.00% <100.00%> (-0.46%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e24455e...ac84976. Read the comment docs.

Co-authored-by: Sourcery AI <>
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 2, 2021

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.31%.

Quality metrics Before After Change
Complexity 4.49 ⭐ 4.27 ⭐ -0.22 👍
Method Length 69.28 🙂 69.24 🙂 -0.04 👍
Working memory 10.69 😞 10.60 😞 -0.09 👍
Quality 67.48% 🙂 67.79% 🙂 0.31% 👍
Other metrics Before After Change
Lines 2725 3031 306
Changed files Quality Before Quality After Quality Change
dbt_sugar/core/flags.py 72.21% 🙂 73.35% 🙂 1.14% 👍
dbt_sugar/core/main.py 63.16% 🙂 62.91% 🙂 -0.25% 👎
dbt_sugar/core/config/config.py 77.17% ⭐ 78.74% ⭐ 1.57% 👍
dbt_sugar/core/connectors/base.py 82.67% ⭐ 83.67% ⭐ 1.00% 👍
dbt_sugar/core/connectors/snowflake_connector.py 71.90% 🙂 73.25% 🙂 1.35% 👍
dbt_sugar/core/task/audit.py 74.71% 🙂 74.73% 🙂 0.02% 👍
dbt_sugar/core/task/base.py 67.16% 🙂 67.22% 🙂 0.06% 👍
dbt_sugar/core/task/doc.py 65.09% 🙂 66.44% 🙂 1.35% 👍
tests/config_test.py 44.29% 😞 44.37% 😞 0.08% 👍
tests/doc_task_test.py 65.29% 🙂 64.96% 🙂 -0.33% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
dbt_sugar/core/task/base.py BaseTask.find_model_schema_file 25 😞 138 😞 16 ⛔ 34.07% 😞 Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
tests/doc_task_test.py test_order_schema_yml 0 ⭐ 417 ⛔ 34 ⛔ 34.92% 😞 Try splitting into smaller methods. Extract out complex expressions
tests/config_test.py test_load_config 9 🙂 205 ⛔ 20 ⛔ 36.97% 😞 Try splitting into smaller methods. Extract out complex expressions
tests/config_test.py test__integrate_cli_flags 1 ⭐ 196 😞 32 ⛔ 41.95% 😞 Try splitting into smaller methods. Extract out complex expressions
dbt_sugar/core/task/base.py BaseTask.update_model_description_test_tags 25 😞 116 🙂 12 😞 42.09% 😞 Refactor to reduce nesting. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Let us know what you think of it by mentioning @sourcery-ai in a comment.

virvirlopez
virvirlopez previously approved these changes May 2, 2021
Copy link
Contributor

@virvirlopez virvirlopez left a comment

Choose a reason for hiding this comment

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

LGTM

@bastienboutonnet bastienboutonnet changed the base branch from main to dev/0.1.0 May 2, 2021 14:00
@bastienboutonnet bastienboutonnet dismissed virvirlopez’s stale review May 2, 2021 14:00

The base branch was changed.

@bastienboutonnet bastienboutonnet merged commit eb73c4d into dev/0.1.0 May 2, 2021
@bastienboutonnet bastienboutonnet deleted the refactor/add_use_describe_to_base branch May 2, 2021 14:02
bastienboutonnet added a commit that referenced this pull request May 3, 2021
* add `use_describe` to the base `get_columns_from_table` def

* 'Refactored by Sourcery' (#237)

Co-authored-by: Sourcery AI <>

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
bastienboutonnet added a commit that referenced this pull request May 5, 2021
* feat: add describe table logic in snowflake connector (#212)

* implement `describe table` logic in SnowflakeConnector

* add flag for experimental feature in config

* update test expectations to have use_describe_snowflake False

* add use_describe_snowflake CLI arg parsing

* update cli consumption tests

* 'Refactored by Sourcery' (#213)

Co-authored-by: Sourcery AI <>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add changelog entry

* lowercase column names

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* feat: automatic insertion of primary key tests (#203)

* feat: automatic insertion of primary key tests.

* feat: adding tests

feat: adding tests

* feat: cleaning documentation

* feat: change the way of getting the SQL file

* Add new tests

* 'Refactored by Sourcery' (#216)

Co-authored-by: Sourcery AI <>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* feat: adding changelog defintion primary key tests

* feat: adding changelog defintion primary key tests

* rename and rephrase news fragment (#219)

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Bastien Boutonnet <bastien.b1@gmail.com>

* refactor: add use_describe to base (#236)

* add `use_describe` to the base `get_columns_from_table` def

* 'Refactored by Sourcery' (#237)

Co-authored-by: Sourcery AI <>

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* feat: bootstrap task (#233)

* setup arg parser and skeleton of bootstrap task

* implement barebone all dbt models dict building

* iterate through models and get col list and schema path

* combine getting columns and finding descriptor

* update tests for bootstrap_task

* update tests for audit_task

* add model placeholders in bootstrap_task

add all models placeholders

* refactor dbt models info in a dataclass for cleaner type checking

* feat: bootstrap task (Sourcery refactored) (#234)

* 'Refactored by Sourcery'

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Sourcery AI <>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* fix typo in new fragment

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* feat: allow audit task to run bootstrap (#239)

* add bootstrap option to `audit` and call it if passed

* add news fragement

* feat: collect rich user input for tests with subprocess (#238)

* feat: collect rich user input for tests with subprocess

* fix: order of the combine list

Make nicer the logs

Secure variable

* add: feature.md

* [pre-commit.ci] pre-commit autoupdate (#242)

updates:
- [github.com/psf/black: 21.4b0 → 21.4b2](psf/black@21.4b0...21.4b2)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* add dbt sugar logo

* chore(deps): Bump sqlalchemy from 1.4.12 to 1.4.13 (#243)

Bumps [sqlalchemy](https://github.com/sqlalchemy/sqlalchemy) from 1.4.12 to 1.4.13.
- [Release notes](https://github.com/sqlalchemy/sqlalchemy/releases)
- [Changelog](https://github.com/sqlalchemy/sqlalchemy/blob/master/CHANGES)
- [Commits](https://github.com/sqlalchemy/sqlalchemy/commits)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): Bump pytest from 6.2.3 to 6.2.4 (#244)

* feat: add redshift connector (#229)

* add RedshiftConnector engine creation module

* add news fragment

* move pytest-dictsdiff to dev requirements

* make read_profile use PostgresDbtProfilesModel pydantic validation class

* 'Refactored by Sourcery' (#231)

Co-authored-by: Sourcery AI <>

* Bump version: 0.0.0 → 0.1.0-a.0

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: virvirlopez <virbyte@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.

2 participants