Check if Python has sqlite3 is installed before attempting to install ipykernel #5149

juliasilge · 2024-10-23T22:17:19Z

Addresses #4698

Currently the message says this if your Python doesn't have sqlite3 there:

Thoughts or feedback? We believe this is most likely to happen on Linux when you are missing a sysreq.

QA Notes

To confirm this is working as expected, you need two Python envs:

Make one new Python env that is "normal", i.e. has the built-in sqlite3 module, but doesn't have ipykernel installed (perhaps via pyenv virtualenv). You should be able to choose this env via "Python: Select Interpreter", agree to the ipykernel installation, and see the ipykernel installation succeed. ✅
Make one new Python env that has ✨ problems ✨ i.e. does not have the built-in sqlite3 module. The only way I could find to do this is to delete it: first find where it is for the Python you are about to destroy and then delete it. Now choose this Python env via "Python: Select Interpreter" and see the message telling you that you need sqlite3. 🚫

… ipykernel

juliasilge · 2024-10-23T22:24:28Z

extensions/positron-python/src/client/common/installer/productService.ts

@@ -23,6 +23,7 @@ export class ProductService implements IProductService {
        this.ProductTypes.set(Product.python, ProductType.Python);
        // --- Start Positron ---
        this.ProductTypes.set(Product.fastapiCli, ProductType.DataScience);
+        this.ProductTypes.set(Product.sqlite3, ProductType.DataScience);


This is not really a data science package, but it is most like that given the current options in ProductType. I did try adding a new type but then we would need to make an installer for it and that doesn't seem important, given that we can't install the missing system requirement for people in a straightforward way.

IIUC the names are misleading. This looks like the right place.

seeM

I made a new Python 3.9.18 venv and moved the sqlite3 module folder to sqlite-bak, then tried to start it. In my case, it showed the ipykernel install prompt and when I accepted that, it showed an error:

Not sure if I misread the instructions.

seeM · 2024-10-25T13:06:02Z

extensions/positron-python/src/client/common/installer/moduleInstaller.ts

@@ -303,6 +303,8 @@ export function translateProductToModule(product: Product): string {
        // --- Start Positron ---
        case Product.fastapiCli:
            return 'fastapi_cli';
+        case Product.sqlite3:
+            return '_sqlite3';


Is this correct?

Suggested change

return '_sqlite3';

return 'sqlite3';

This is what generates the original error:
https://github.com/python/cpython/blob/main/Lib/sqlite3/dbapi2.py#L27

from _sqlite3 import *

seeM · 2024-10-25T13:06:47Z

extensions/positron-python/src/client/common/installer/productService.ts

@@ -23,6 +23,7 @@ export class ProductService implements IProductService {
        this.ProductTypes.set(Product.python, ProductType.Python);
        // --- Start Positron ---
        this.ProductTypes.set(Product.fastapiCli, ProductType.DataScience);
+        this.ProductTypes.set(Product.sqlite3, ProductType.DataScience);


IIUC the names are misleading. This looks like the right place.

juliasilge · 2024-10-25T14:32:54Z

I just kicked off a release build here so we can have folks with easy access to a Linux machine to test it out. To test it out, you will need:

Linux machine with no sqlite system library installed
Install pyenv and then a Python version (you should see "WARNING: The Python sqlite3 extension was not compiled. Missing the SQLite3 lib?" during this installation)
Open up Positron and try to start that pyenv Python

petetronic · 2024-10-25T17:05:01Z

Using Fedora 40 desktop, I was able to see the new warning.

I uninstalled python 3.11.10 using pyenv
I ensured sqlite3 was not installed on Fedora
I re-installed python 3.11.10 using pyenv and confirmed I saw the expected warning during installation

WARNING: The Python sqlite3 extension was not compiled. Missing the SQLite3 lib?

I installed the custom Positron prerelease build .rpm that @juliasilge listed above
I started a Python 3.11.10 interpreter
It showed the expected improved error in the Positron Console:

The Python sqlite3 extension is required but not installed for interpreter: Python 3.11.10 64-bit ('3.11.10'). Missing the SQLite3 lib?

To confirm the happy path:

I ran sudo dnf install sqlite-devel
I uninstalled Python 3.11.10 with pyenv
I re-installed Python 3.11.10 with pyenv, and noted there was no warning about sqlite3
I restarted Positron from above, and started a Python 3.10.11 interpreter
It prompted me to install ipykernel, which I accepted
I was able to use the Positron Console with this Python interpreter successfully

Note that sqlite by itself was not enough, it needed to be the sqlite-devel package so that the Python module _sqlite3 could be compiled during installation. We could note the distinction in our installation guide if it's too much detail to customize this message per platform. We could perhaps refer people to Positron's installation guide too.

juliasilge · 2024-10-25T17:28:48Z

I added this info to our docs here: posit-dev/positron-website#11

What do you think would be the most clear error message? Maybe a slight edit such as:

The Python sqlite3 extension is required but not installed for interpreter: ${this.interpreter?.displayName}. Missing the system library for SQLite?

Check if Python has sqlite3 is installed before attempting to install…

45962cd

… ipykernel

juliasilge commented Oct 23, 2024

View reviewed changes

juliasilge marked this pull request as ready for review October 24, 2024 03:53

juliasilge requested a review from seeM October 24, 2024 03:53

seeM requested changes Oct 25, 2024

View reviewed changes

juliasilge requested a review from seeM October 25, 2024 20:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check if Python has sqlite3 is installed before attempting to install ipykernel #5149

Check if Python has sqlite3 is installed before attempting to install ipykernel #5149

juliasilge commented Oct 23, 2024

juliasilge Oct 23, 2024

seeM Oct 25, 2024

seeM left a comment

seeM Oct 25, 2024

petetronic Oct 25, 2024

seeM Oct 25, 2024

juliasilge commented Oct 25, 2024

petetronic commented Oct 25, 2024 •

edited

Loading

juliasilge commented Oct 25, 2024 •

edited

Loading

Check if Python has sqlite3 is installed before attempting to install ipykernel #5149

Are you sure you want to change the base?

Check if Python has sqlite3 is installed before attempting to install ipykernel #5149

Conversation

juliasilge commented Oct 23, 2024

QA Notes

juliasilge Oct 23, 2024

Choose a reason for hiding this comment

seeM Oct 25, 2024

Choose a reason for hiding this comment

seeM left a comment

Choose a reason for hiding this comment

seeM Oct 25, 2024

Choose a reason for hiding this comment

petetronic Oct 25, 2024

Choose a reason for hiding this comment

seeM Oct 25, 2024

Choose a reason for hiding this comment

juliasilge commented Oct 25, 2024

petetronic commented Oct 25, 2024 • edited Loading

juliasilge commented Oct 25, 2024 • edited Loading

petetronic commented Oct 25, 2024 •

edited

Loading

juliasilge commented Oct 25, 2024 •

edited

Loading