style: add pyright + ruff checks, tighten up lib typing

canonical / data-platform-libs

A collection of charm libraries curated by the Data Platform Team

https://charmhub.io/data-platform-libs

Apache License 2.0

10 stars 9 forks source link

style: add pyright + ruff checks, tighten up lib typing #69

Closed marcoppenheimer closed 1 year ago

marcoppenheimer commented 1 year ago

Changes Made

`style: add pyright type checks, ruff linting`

Both runs on tox -e lint
Validates only src and lib
Ruff is faster, less configured, removes flake8
Pyright's closed-source version (Pylance) is the default type checker that ships with the ms-python.python VSCode extension, and is very good

marcoppenheimer commented 1 year ago

LGTM, charmcraft is not happy a bit:

2023-07-01 17:32:12.936 :: 2023-07-01 17:32:12.087 ::    ::             error: can't find Rust compiler
....
2023-07-01 17:32:12.936 :: 2023-07-01 17:32:12.087 ::    ::         ERROR: Failed building wheel for maturin

Q: are we moving to ruff for entire team?

I think we should! It's much faster than flake, fewer imports.

deusebio commented 1 year ago

I think we should! It's much faster than flake, fewer imports.

I agree (unless ruff conflicts with other tools with no clean solution for it) but given we don't have any standard set up yet, I would leave it up to the products/team/projects to decide whether to use it or not for the time being.