Add static analysis tools for PRs

[George3d6]

We need to add a static analysis tool that triggers on each PR and provides a report, ideally flake8 style where we can configure its behaviour and have the action fail until the PR respects all imposed rules. The "configure behaviour" bit is important since we might have some standards that are not in line with static analysis preferences (e.g. there's certain bits where we use exec and eval or where we must use * imports and so forth)

Multiple people can tackle this one, since the ore tools the merrier as long as they catch actual errors, ideally also fix the errors detected as part of the PR if it's easy enough. However if the tool catch more than 5-10 errors then don't bother, just make the PR, since we might think those are not actual errors and will want to configure them away.

Currently, I use pylance and find it amazing for this, but am open to any tool

[vickywane]

Hi @George3d6 ,

I would love to introduce Pyright. It's an opensource alternative for your Pylance.

Since Pylance has similar features of Pyright, would it be worth it including both?

[George3d6]

I was unaware pylance was closed sourced O.O

But yes, please go ahead and introduce it, given that it's made by Microsoft I assume it might be intended to replace pylance in VSC anyway.

[George3d6]

I was unaware pylance was closed sourced O.O

But yes, please go ahead and introduce it, given that it's made by Microsoft I assume it might be intended to replace pylance in VSC anyway.

[vickywane]

@George3d6 I just discovered Prospector which i think is an amazing tool.

It is recommended to use Pylance by installing it in VSC so i don't think there's any need to manually configure it here.

I'll push a PR now with Prospector.

[vickywane]

@George3d6 I've opened a PR for this here.

[George3d6]

Hacktoberfest is over :( But if you want to finish the PR (@vickywane )and/or if anyone else wants to work on this, it's still something we'd very much like

[vickywane]

@George3d6 I really would like to finish my work on introducing Prospector here but the issue I faced was that Prospector was not outputting the logs in the Github CI Run.

I dont know if it’s the way stdio is handled within your GitHub CI but locally the same tool prints out the analysis result. I will however try a few more times to see if i can figure it out.