Add typed client options #96

joeriddles · 2021-12-15T01:01:00Z

Closes #50

This PR:

Adds more type hints throughout.
Adds typed supabase Client options in the form of ClientOptions.
Adds a test.ps1 file that is equivalent to test.sh, to more easily run tests on Windows.

joeriddles · 2021-12-15T01:20:15Z

I ran pre-commit on my end and everything is looking good. I did have to make a commit to fix all the line-endings. Setting core.autocrlf = true should fix this in the future.

> pre-commit run --all-files
pre-commit run --all-files
Trim Trailing Whitespace.................................................Passed
Check for added large files..............................................Passed
Mixed line ending........................................................Passed
isort....................................................................Passed
autoflake................................................................Passed
black....................................................................Passed

dreinon · 2021-12-15T23:25:54Z

@joeriddles thanks for the contribution! Tests are failing, could you take a look whenever you have time, please?

Thanks!

joeriddles · 2021-12-15T23:48:06Z

@dreinon fixed the tests! Looks like they're passing on my machine. I'm not exactly sure what xfailed and xpassed mean, but they're not red.

collected 57 items

tests\test_client.py xxxxxxxxxxxxxxxxXXXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...s                                                                                     [ 92%]
tests\test_client_options.py ..                                                                                                                                [ 96%] 
tests\test_dummy.py ..                                                                                                                                         [100%]

=== 7 passed, 1 skipped, 46 xfailed, 3 xpassed in 4.67s ===

dreinon · 2021-12-16T00:15:57Z

@leynier @anand2312 can you review this too please?

dreinon · 2021-12-15T23:15:31Z

supabase/lib/client_options.py

+ """A storage provider. Used to store the logged in session."""
+ local_storage: Dict[str, Any] = dataclasses.field(default_factory=lambda: {})
+
+ """Options passed to the realtime-js instance"""


Realtime-py?

Realtime-py?

Not sure I understand this comment. Is ClientOptions missing some realtime_py values?

The existing comment says realtime-js, I'm guessing dreinon is asking you to change that to realtime-py

dreinon · 2021-12-16T00:21:31Z

@dreinon fixed the tests! Looks like they're passing on my machine. I'm not exactly sure what xfailed and xpassed mean, but they're not red.

collected 57 items

tests\test_client.py xxxxxxxxxxxxxxxxXXXxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...s                                                                                     [ 92%]
tests\test_client_options.py ..                                                                                                                                [ 96%] 
tests\test_dummy.py ..                                                                                                                                         [100%]

=== 7 passed, 1 skipped, 46 xfailed, 3 xpassed in 4.67s ===

xfails are tests that are expected to fail, but xpasses are tests that are expected to fail but passed (which shouldn't be the case). Could you look into these cases too please @joeriddles?

dreinon · 2021-12-16T00:23:24Z

Well, actually, these xpasses are happening in a file this PR does not touch, so no worries about that.

dreinon · 2021-12-16T00:26:55Z

What I would actually like you to check is the two refactors sourcery proposes in PR #97, last commit. These cases are when variables are inmediately returned, sourcery asks you to return its value directly.

joeriddles · 2021-12-16T06:18:27Z

What I would actually like you to check is the two refactors sourcery proposes in PR #97, last commit. These cases are when variables are inmediately returned, sourcery asks you to return its value directly.

Sure, made the changes, though one of sourcery's suggested changes was for part of a function I didn't touch. Regardless, made the small tweaks.

supabase/client.py

supabase/lib/storage_client.py

Co-authored-by: Anand <[email protected]>

joeriddles · 2021-12-16T15:52:26Z

@anand2312 thanks for adding those type hints

dreinon · 2021-12-16T16:03:28Z

Perfect, so let's wait for @leynier 's review and then we'll ve ready to merge :)

sourcery-ai · 2021-12-16T21:05:40Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	0.71 ⭐	0.72 ⭐	0.01 👎
Method Length	22.74 ⭐	22.42 ⭐	-0.32 👍
Working memory	5.55 ⭐	5.50 ⭐	-0.05 👍
Quality	86.45% ⭐	86.32% ⭐	-0.13% 👎

Other metrics	Before	After	Change
Lines	219	210	-9

Changed files	Quality Before	Quality After	Quality Change
supabase/client.py	84.33% ⭐	84.06% ⭐	-0.27% 👎
supabase/lib/constants.py	99.83% ⭐	100.00% ⭐	0.17% 👍
supabase/lib/storage_client.py	97.67% ⭐	97.67% ⭐	0.00%
tests/conftest.py	93.85% ⭐	92.70% ⭐	-1.15% 👎

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation

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!

joeriddles · 2021-12-16T21:06:21Z

I also added py.typed to implement PEP561, "Distributing and Packaging Type Information".

leynier · 2021-12-17T00:30:36Z

LGTM! Thanks for the contribution @joeriddles

Add typed client options

b228d2b

sourcery-ai bot mentioned this pull request Dec 15, 2021

Add typed client options (Sourcery refactored) #97

Closed

Run pre-commit on all files

781214d

Add missing import to client.py

34fea34

dreinon requested a review from a team December 16, 2021 00:14

dreinon approved these changes Dec 16, 2021

View reviewed changes

Implement sourcery suggestions to return values directly

6413418

anand2312 reviewed Dec 16, 2021

View reviewed changes

supabase/client.py Outdated Show resolved Hide resolved

supabase/lib/storage_client.py Outdated Show resolved Hide resolved

J0 approved these changes Dec 16, 2021

View reviewed changes

dreinon and others added 2 commits December 16, 2021 16:20

Add missing type hints

c11691f

Co-authored-by: Anand <[email protected]>

Typo

86eae8b

dreinon approved these changes Dec 16, 2021

View reviewed changes

Add py.typed (PEP561)

6ce1cc0

leynier approved these changes Dec 17, 2021

View reviewed changes

dreinon merged commit 5b5850f into supabase-community:develop Dec 17, 2021

joeriddles deleted the add-client-options branch December 17, 2021 01:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add typed client options #96

Add typed client options #96

joeriddles commented Dec 15, 2021

joeriddles commented Dec 15, 2021

dreinon commented Dec 15, 2021

joeriddles commented Dec 15, 2021

dreinon commented Dec 16, 2021

dreinon Dec 15, 2021

joeriddles Dec 16, 2021 •

edited

Loading

anand2312 Dec 16, 2021

dreinon commented Dec 16, 2021

dreinon commented Dec 16, 2021

dreinon commented Dec 16, 2021

joeriddles commented Dec 16, 2021

joeriddles commented Dec 16, 2021

dreinon commented Dec 16, 2021

sourcery-ai bot commented Dec 16, 2021

joeriddles commented Dec 16, 2021

leynier commented Dec 17, 2021

Add typed client options #96

Add typed client options #96

Conversation

joeriddles commented Dec 15, 2021

joeriddles commented Dec 15, 2021

dreinon commented Dec 15, 2021

joeriddles commented Dec 15, 2021

dreinon commented Dec 16, 2021

dreinon Dec 15, 2021

Choose a reason for hiding this comment

joeriddles Dec 16, 2021 • edited Loading

Choose a reason for hiding this comment

anand2312 Dec 16, 2021

Choose a reason for hiding this comment

dreinon commented Dec 16, 2021

dreinon commented Dec 16, 2021

dreinon commented Dec 16, 2021

joeriddles commented Dec 16, 2021

joeriddles commented Dec 16, 2021

dreinon commented Dec 16, 2021

sourcery-ai bot commented Dec 16, 2021

Sourcery Code Quality Report

Legend and Explanation

joeriddles commented Dec 16, 2021

leynier commented Dec 17, 2021

joeriddles Dec 16, 2021 •

edited

Loading