Linting + Autoformatting Rules Selection

[rafmudaf]

Ruff was integrated into FLORIS via #562 with an initial basic configuration and minimal rules enabled. This discussion outlines additional rules to include or explicitly exclude. The full set of rules are available in the Ruff documentation.

@RHammond2 reviewed the available options and commented in #562 with this list and suggestions:

• D: pydocstyle
  • This will be a useful catch for technical errors in our docstrings, given it has a google style setting
  • However, I think most of our docstring issues stem from the fact that they don't provide a whole lot of useful information, and this won't remotely help with the real issues we have.
• UP: pyupgrade
  • I've been meaning to use this in other libraries to ensure old code snippets aren't out of date and to find places where some core usage has changed, particularly for targeting specific version of Python we want to support.
  • I think we'll have already addressed much of this in our initial v3 push, but could helpful to ensure we're using modern Python for the lifetime of the project
• FBT: flake8-boolean-trap
  • This could be nice as a safety check, but I don't think we have much in the way of boolean inputs, so could not provide too much value
• B: flake8-bugbear
  • I'd want to look into this more, so I'd definitively put this in the later category, but could be helpful as an additional check on our code style for non PEP8 oddities.
• PT: flake8-pytest-style
  • I could go either way with this one, but I'm wondering if this could help people getting acquainted with writing tests
• RET: flake8-return
  • I haven't used this one, but I think given the issue we had with porting the old code, we might find this to be helpful in avoiding non-pythonic or odd return patterns.
• SIM: flake8-simplify
  • Seems neat, but could get us down a rabbit hole, so this might be something to consider later to help catch odd code patterns
• PTH: flake8-use-pathlib
  • I'd like to see this one added to help people switch from os to pathlib.Path and help us identify where to switch things out
• ERA: eradicate
  • We should never use this unless we're happy with removing our old code tracks