Plot error message

[neelasha23]

Describe your changes

Better error messages when function used in plotting API is unavailable in the driver.

Issue number

Closes #159

Checklist before requesting a review

• Performed a self-review of my code
• Formatted my code with pkgmt format
• Added tests (when necessary).
• Added docstring documentation and update the changelog (when needed)

---

📚 Documentation preview 📚: https://jupysql--441.org.readthedocs.build/en/441/

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1204039895885176

[neelasha23]

This is ready for review. Some notes:

1. Added error message for percentile_disc function. Other functions used in plotting API are: avg, count, max, min, floor. As per documentation these seem to be supported in other drivers.
2. Currently there are two plots: boxplot and histograms and both are documented in tutorials.
3. Telemetry call already added to these functions.
4. i have tried modify_exception but it results in very long messages like :

[Error message]
Ensure that percentile_disc function is available on driver.
<Long stack trace>..
...
..
If you need help solving this issue, send us a message: https://ploomber.io/community
....

So directly used the COMMUNITY link along with the error message.

@idomic @edublancas

[idomic]

For 4:

i have tried modify_exception but it results in very long messages like :
So directly used the COMMUNITY link along with the error message.

Take a look in the core repo, there's the tag we've added, it'll help you and you won't need to deal with the community link manually.

[neelasha23]

Take a look in the core repo, there's the tag we've added, it'll help you and you won't need to deal with the community link manually.

Yeah I tried that out like:

except Exception as e:
        e.modify_exception = True
        raise

But the issue with that is , first it prints the msg Ensure that percentile_disc function is available on driver.. then there's a long error stack trace at the end of which If you need help solving this issue, send us a message: https://ploomber.io/community is displayed. Users may overlook this amidst the long msgs. printing the community link manually is ensuring a cleaner display like :

Original error msg 

Ensure that percentile_disc function is available on driver.`

If you need help solving this issue, send us a message: https://ploomber.io/community

<original stack trace>

@idomic

[neelasha23]

Modified to raise UsageError
@idomic

[idomic]

Modified to raise UsageError

I think it makes more sense to use a PlotError, create it if doesn't exist.

[edublancas]

I think it makes more sense to use a PlotError, create it if doesn't exist.

We can use the existing RuntimeError. I don't think we should be that specific to create a PlotError.

And UsageError isn't the appropriate one here since that should only be used when the user input is the problem. Here the problem is the database (example: doesn't implement the percentile_disc function)

[neelasha23]

Changed UsageError to RuntimeError.
@idomic

[yafimvo]

added some notes
@neelasha23

[yafimvo]

Do you think we should add a successful test where we use percentile_disc without getting this error?

[neelasha23]

This is the success testcase:

jupysql/src/tests/integration/test_generic_db_operations.py

Line 306 in 947af61

def test_sqlplot_boxplot(ip_with_dynamic_db, cell, request, test_table_name_dict):

[yafimvo]

Yes, I thought maybe we can create a scoped test to make sure that _summary_stats runs fluently with percentile_disc since test_sqlplot_boxplot may fail for other reasons. I guess we can skip it.

@idomic what do you think?
if not, we can merge it from my side.

[idomic]

@neelasha23 I tend to agree with Yafim, this test should be isolated. Let’s create a clean one just for the success case of _summary_stats.

[neelasha23]

Added unit cases for _summary_stats

[yafimvo]

lgtm!

I added one question before we merge it.

[idomic]

lgtm.