Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Conversation

@J0
Copy link
Contributor

@J0 J0 commented Oct 30, 2022

Attempts to mirror the effort by great @anand2312 on the storage-py library.

A few pointers which need to be addressed:

  • Get autodoc to properly parse error docstrings

Notes

Sphinx seems to have an unresolved dependency conflict with flake8.
As such, I've left it out for now

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 30, 2022

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.09%.

Quality metrics Before After Change
Complexity 3.11 ⭐ 3.12 ⭐ 0.01 👎
Method Length 57.24 ⭐ 57.29 ⭐ 0.05 👎
Working memory 7.17 🙂 7.18 🙂 0.01 👎
Quality 76.13% 76.04% -0.09% 👎
Other metrics Before After Change
Lines 1261 1267 6
Changed files Quality Before Quality After Quality Change
docs/source/conf.py 97.17% ⭐ 96.18% ⭐ -0.99% 👎
gotrue/_async/api.py 80.72% ⭐ 80.59% ⭐ -0.13% 👎
gotrue/_async/client.py 71.91% 🙂 71.91% 🙂 0.00%

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

File Function Complexity Length Working Memory Quality Recommendation
gotrue/_async/client.py AsyncGoTrueClient.get_session_from_url 15 🙂 252 ⛔ 13 😞 35.91% 😞 Try splitting into smaller methods. Extract out complex expressions
gotrue/_async/client.py AsyncGoTrueClient.sign_in 11 🙂 147 😞 13 😞 47.42% 😞 Try splitting into smaller methods. Extract out complex expressions
gotrue/_async/client.py AsyncGoTrueClient.__init__ 3 ⭐ 111 🙂 17 ⛔ 54.55% 🙂 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!

Help us improve this quality report!

@codecov
Copy link

codecov bot commented Oct 30, 2022

Codecov Report

Base: 84.48% // Head: 84.46% // Decreases project coverage by -0.01% ⚠️

Coverage data is based on head (df4ab8f) compared to base (dff74c6).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #180      +/-   ##
==========================================
- Coverage   84.48%   84.46%   -0.02%     
==========================================
  Files          14       14              
  Lines        1057     1056       -1     
==========================================
- Hits          893      892       -1     
  Misses        164      164              
Impacted Files Coverage Δ
gotrue/_async/client.py 89.49% <ø> (ø)
gotrue/_async/api.py 69.82% <100.00%> (-0.18%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@J0 J0 marked this pull request as ready for review October 30, 2022 22:08
@leynier
Copy link
Contributor

leynier commented Nov 5, 2022

@J0 maybe we can try to use https://github.com/charliermarsh/ruff as a replacement for flake8

@J0
Copy link
Contributor Author

J0 commented Dec 12, 2022

Going to merge for now, will do any modifications to add ruff in a follow up PR

@J0 J0 merged commit f7eade8 into main Dec 12, 2022
@J0 J0 deleted the j0/add_docs branch December 12, 2022 08:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants