Create extension pack "inwt Python IDE"

chamaoskurumi commented 10 months ago

Minimal set an Python extensions bundled into a pack
Should represent as good as possible our inwt best practices

chamaoskurumi commented 10 months ago

We should check these out https://github.com/microsoft/vscode-python/wiki/Migration-to-Python-Tools-Extensions

chamaoskurumi commented 9 months ago

What do we actually need?

VSCode extensions needed

[x] Python ms-python.python (includes Pylance as language server. inwt-smart-execute has Python as a dependency anyway, but we want to make it explicit)
[x] Jupyter ms-toolsai.jupyter (also dependency, but we make it explicit)
~black jaakko.black (auto-formatting)~ I realized ruff can also do formatting and if that works fine, we don't need black anymore...so one dependency less
[x] ruff charliermarsh.ruff (linting - replaces isort, flake8, etc... according to here)
[x] ~mypy ms-python.mypy-type-checker~ (typechecking) Can be handled by Pylance (pyright) which is automatically installed as language server. I simply enabled the capability via the configuration. It is also faster and works out of the box. When there are no type annotations, pyright is doing type inference to some extend, which will give you hints none the less (different to mypy which always assumes ANY if annotations are missing)
[x] rewrap stkb.rewrap (comment rewrapping, not yet implemented in ruff but maybe soon)
[x] autoDocstring njpwerner.autodocstring (creates nice docstrings for functions and classes via TAB)
[ ] Python Environment Manager donjayamanne.python-environment-manager
[x] inwt-smart-execute inwtlab.python-smart-execute
[ ] Python-indent KevinRose.vsc-python-indent

Settings

[x] Configuration of ruff (line length, etc....)
- line-length: 100
- Ignore: ANN: We do not enforce type annotations by default
- Ignore: D: We do not enforce doc strings by default
- enable auto-format and sort imports on save
~Configuration of black (used by default and automatically)~
[x] Configuration of rewrap (set line length and enable automatically and autoformat)
- line-length: 100
[ ] Configuration of autoDocstring (set default docstring format to "google")

wahani commented 9 months ago

I removed the smart execute logic and also most of the extensions from the bundle. When we start to configure ruff, black and so on, we have to check if this is now possible using configurationDefaults:

Maybe with this we do not need to create a settings.json after all.

Also we now have a gh action to publish the extension. This happens as soon as we create a tag on gh.

chamaoskurumi commented 9 months ago

I added python-indent KevinRose.vsc-python-indent to the list above

wahani commented 9 months ago

Did a first release. Had to strip some more configuration to get there. But also verified the gh action works: https://marketplace.visualstudio.com/items?itemName=inwtlab.inwt-python-ide-v2

wahani commented 8 months ago

@chamaoskurumi do we actually need python-indent when we autoformat at the same time?

chamaoskurumi commented 8 months ago

Well I trusted the author of python-indent when he says

But tbh I didn't try it out, maybe this information is outdated and python-indent is not needed.

chamaoskurumi commented 8 months ago

Besides, I tried to updated the npm packages in this branch, but unfortunately it created all sorts of problems. We either accept that we work with (very) old package versions or we need to update one by one to see how far we get without breaking things.

wahani commented 8 months ago

Besides, I tried to updated the npm packages in this branch, but unfortunately it created all sorts of problems. We either accept that we work with (very) old package versions or we need to update one by one to see how far we get without breaking things.

Since they are only relevant for development and we do not need them for the extension, I would leave them as they are. If you want to follow that road, I would start from scratch, following https://code.visualstudio.com/api/get-started/your-first-extension for an extension pack, and simply update/copy the contents from the package.json.

wahani commented 8 months ago

Well I trusted the author of python-indent when he says

I went through some of the examples and I think with autoformatting, there is not much you gain. Also some of the mentioned tickets are closed, because they have become part of pylance and got implemented.

chamaoskurumi commented 1 month ago

@wahani I guess we can close this issue, since all relevant python extensions were included in the inwt Python IDE v2 already, right? (I'm referring to these extensions here )

wahani commented 1 month ago

I think the doc string extension is missing.

INWTlab / inwt-python-ide

Create extension pack "inwt Python IDE" #1

What do we actually need?