Homogenize annotation and typing syntax about xdem HOT 3 CLOSED

I support this!

The linters I use are: mypy (git version), prospector (pylint + pep8 + McCabe complexity) and pydocstyle. The formatters I use are: isort and autopep8.

The latest release of mypy (December 2020) strangely doesn't like the list[subtype] syntax, even after including from __future__ import annotations. I therefore use the latest source version instead, which has included a fix (pip install git+https://github.com/python/mypy.git).

Linters

mypy is a static type helper, for example giving an error if you write def func(value: int = 1.1) -> float (1.1 is not an int), or try to subsequently use the function in an incorrect manner: "hello" + func(3) (str + float doesn't work).

pydocstyle makes sure docstrings are more or less correctly formatted. It doesn't enforce e.g. sphinx formatting, so maybe there's another tool to add here?

prospector is a convenience linter that implements three linters in one:

pylint is a general-purpose linter for common issues. For example, it enforces the correct use of "snake_case" and "CamelCase" naming conventions.

pep8 warns you about line lengths, weird whitespace, wrong indentation, correct line spacing between functions, etc.

McCabe complexity makes sure that functions and classes are not overly complex, e.g. if a function has more than X defined variables, maybe it should be split in two. I am particularly bad at this..

Formatters

isort sorts imports alphabetically and divides them in three categories: "builtin imports", "third party imports", "local imports" (if the import is a directory in your cwd for example).

autopep8 helps with automatically conforming your code to the pep8 standard.

I've set the autopep8 and pylint maximum column width to 120 lines instead of 80 (read Linus Torvalds' take on this!)

Should we agree on a combination of linters and formatters? I know some repos have commit/push/merge hooks that format the code. Since we are only ~three active developers right now, maybe this is overly complex at the time being, but we could consider something similar in the future.

from xdem.

Maybe the issue should be renamed "Write a contribution guideline" with all this info ;-)
https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors

from xdem.

This is amazing @erikmannerfelt ! 😳
Learning a great lot thanks to you.

Should we agree on a combination of linters and formatters? I know some repos have commit/push/merge hooks that format
the code. Since we are only ~three active developers right now, maybe this is overly complex at the time being, but we could
consider something similar in the future.

I agree that this is still early. It would be great for us three to try to abide by those standards, which are really useful even for us when coding (in PyCharm, I simply point my mouse at a function I'm using and I get all input/output types in detail, it's truly amazing), and to make everything homogeneous.
#56 will be super helpful, even for the next GlacioHack.

I guess we should aim at switching the annotations of geoutils too, for consistency? It's good practice too ;)

from xdem.