formatters don't work when installed via pipx

mikeage commented 3 years ago

Checklist prior to opening an issue

[ ] I have followed fully the installation steps laid out in the documentation site.
[x] I have restarted jupyterlab.
[x] I have read the FAQ section in the documentation site.

Describe the bug I realize that this is not according to the installation instructions, but I'd like to know if there's any way to make it work.

I run jupyter as a globally installed package, but I prefer to install tools like black and isort using pipx (https://github.com/pipxproject/pipx). This way, I can access the same tools from within any virtualenv, rather than being limited to the global environment only. However, if I do this, even though they're accessible from the command line (they're in ~/.local/bin, which is in my $PATH, they cannot be imported, and therefore they fail to run in jupyterlab_code_formatter.

Is there any way to run formatters that are not available as python modules but are executable from the command line? I realize it might be slower to do a fork/exec (i.e., subprocess) rather than an import, but it also seems like it'd be more flexible if I could run formatters using a command line without needing a python import.

E.g.,

$ python -c "import black"
Traceback (most recent call last):
  File "<string>", line 1, in <module>
ImportError: No module named black

but

$ which black
/Users/mikemi/.local/bin/black

Diagnostic commands Please attach the output of the following commands (please format them properly)

pip freeze

appdirs==1.4.4
appnope==0.1.0
argon2-cffi==20.1.0
astroid==2.4.2
async-generator==1.10
attrs==20.2.0
autopep8==1.5.4
backcall==0.2.0
beautifulsoup4==4.9.3
bleach==3.2.1
bs4==0.0.1
certifi==2020.6.20
cffi==1.14.3
cfgv==3.2.0
chardet==3.0.4
click==7.1.2
cycler==0.10.0
decorator==4.4.2
defusedxml==0.6.0
distlib==0.3.1
entrypoints==0.3
filelock==3.0.12
identify==1.5.7
idna==2.10
ipdb==0.13.4
ipykernel==5.3.4
ipython==7.19.0
ipython-genutils==0.2.0
ipywidgets==7.5.1
jedi==0.17.2
Jinja2==2.11.2
json5==0.9.5
jsonschema==3.2.0
jupyter==1.0.0
jupyter-client==6.1.7
jupyter-console==6.2.0
jupyter-core==4.7.0
jupyterlab==2.2.9
jupyterlab-code-formatter==1.3.8
jupyterlab-pygments==0.1.2
jupyterlab-server==1.2.0
kiwisolver==1.3.1
lazy-object-proxy==1.4.3
lxml==4.6.1
MarkupSafe==1.1.1
matplotlib==3.3.2
mccabe==0.6.1
mistune==0.8.4
mypy-extensions==0.4.3
nbclient==0.5.1
nbconvert==6.0.7
nbformat==5.0.8
nest-asyncio==1.4.2
nodeenv==1.5.0
notebook==6.1.5
numpy==1.19.4
packaging==20.4
pandocfilters==1.4.3
parso==0.7.1
pathspec==0.8.1
pexpect==4.8.0
pickleshare==0.7.5
Pillow==8.0.1
prometheus-client==0.8.0
prompt-toolkit==3.0.8
ptyprocess==0.6.0
pycodestyle==2.6.0
pycparser==2.20
Pygments==2.7.2
pylint==2.6.0
pyparsing==2.4.7
pyrsistent==0.17.3
PySocks==1.7.1
python-dateutil==2.8.1
pytz==2020.4
PyYAML==5.3.1
pyzmq==19.0.2
qtconsole==4.7.7
QtPy==1.9.0
regex==2020.11.13
requests==2.24.0
Send2Trash==1.5.0
six==1.15.0
soupsieve==2.0.1
terminado==0.9.1
testpath==0.4.4
toml==0.10.2
tornado==6.1
traitlets==5.0.5
typed-ast==1.4.1
typing-extensions==3.7.4.3
urllib3==1.25.11
virtualenv==20.1.0
wcwidth==0.2.5
webencodings==0.5.1
widgetsnbextension==3.5.1
wrapt==1.12.1

jupyter labextension list


JupyterLab v2.2.9
Known labextensions:
app dir: /usr/local/share/jupyter/lab
    @ryantam626/jupyterlab_code_formatter v1.3.8  enabled  OK
    jupyterlab-theme-solarized-dark v1.0.3  enabled  OK

- `jupyter serverextension list`

config dir: /Users/mikemi/.jupyter jupyterlab_code_formatter enabled

Validating... jupyterlab_code_formatter OK config dir: /usr/local/etc/jupyter jupyterlab enabled
Validating... jupyterlab 2.2.9 OK

Screenshots n/a

Additional context n/a

ryantam626 commented 3 years ago

Hi, that would invovles a fair bit of code change, something that I don't have the time to do and properly test right now. If you would like to have a go at it, implementing a new class based on https://github.com/ryantam626/jupyterlab_code_formatter/blob/3bd3bff8c9ee63f94cc25749e2920c0c217e2c38/serverextension/jupyterlab_code_formatter/formatters.py#L20 is probably a good start.

mikeage commented 3 years ago

Thanks for the response. My first time using jupyter lab (let alone extensions) was yesterday, so I'm not sure if I'm going to be able to tackle this one now... maybe one day.

inigohidalgo commented 1 year ago

FWIW, it seems it might not be a super simple change to do this, especially bc of the complications around how formatted code is returned in formatters.

As a workaround, you can install whatever formatter you want to use into the environment pipx created for jupyterlab.

pipx inject jupyter jupyter-code-formatter
pipx inject jupyter black

This makes the packages available to the extension.

jupyterlab-contrib / jupyterlab_code_formatter

formatters don't work when installed via pipx #178