Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 Make mypy and doc string linters opt out instead of opt in #1001

Closed
3 tasks done
s-weigand opened this issue Feb 12, 2022 · 1 comment · Fixed by #1173
Closed
3 tasks done

🔧 Make mypy and doc string linters opt out instead of opt in #1001

s-weigand opened this issue Feb 12, 2022 · 1 comment · Fixed by #1173
Assignees
Labels
Type: Tooling Tools used for the project (CI, CD, docs etc.)
Milestone

Comments

@s-weigand
Copy link
Member

Proposed refactoring

To improve our code quality we started to use mypy and docstring linters on more and more sub packages.
We are now at a point where it might be easier to those tools opt out for the packages that aren't ready, instead of opt in for the packages that we already use them on.

Currently checked sub packages:

  • plugin_system
  • utils
  • deprecation
  • testing
  • parameter
  • project
  • model/property.py
  • builtin/io/pandas

Currently NOT checked sub packages:

  • io (should be no problem)
  • typing (should be no problem)
  • analysis (needs type stubs and docstrings)
  • builtin (needs type stubs and docstrings for megacomplexes, io needs more annotations and docstrings)
  • cli (?)
  • model (needs type stubs and docstrings)

Benefits

  • Makes code easier to maintain
  • Documents the user facing API
  • Mypy will find a lot of problem we didn't discover yet (unused code paths)

Additional context

@s-weigand s-weigand added the Type: Tooling Tools used for the project (CI, CD, docs etc.) label Feb 12, 2022
@s-weigand s-weigand added this to the v0.7.0 milestone May 17, 2022
@jsnel
Copy link
Member

jsnel commented Nov 6, 2022

I think we already made a lot of progress towards this, could you re-evaluate how far we are from achieving this @s-weigand ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Tooling Tools used for the project (CI, CD, docs etc.)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants