Noissue - Added flake8-docstrings (codingtools)

flake8-eyeo/tox.ini

 [tox]
-envlist=py{27,35,36}-flake8{2,3}
+envlist = py{27,35,36}-flake8{2,3},flake8

[tlucas, 2017/10/09 23:39:38]

In case you decide to stick to your separation of testing and linting, we won't
need additional environments for flake82 / flake83 (since flake8 won't be run
anyway)

[Sebastian Noack, 2017/10/10 05:34:30]

Well, this is the flake8-eyeo extension. The py{27,35,36}-flake8{2,3}
environments don't lint this code, but run the tests. And obviously we have to
test the extension with all supported versions of Python and flake8. We can drop
support for flake8 2 now, but this is out of the scope of this change.

+
+[flake8]
+ignore = D1,N802
 
 [testenv]
-deps=
+deps =

[tlucas, 2017/10/09 23:39:38]

Same as above, if you stick to your separation we won't even need to install
flake8 in the environments where only the tests are run.

[Sebastian Noack, 2017/10/10 05:34:30]

Again, this is the environment for the tests (not for linting), and since this
is a flake8 plugin, of course we need flake8 to test it.

     flake82: flake8==2.*
     flake83: flake8==3.*
-    pep8-naming
-commands=
+commands =
     python setup.py test
-    flake8 flake8_eyeo.py setup.py --ignore N802
+
+[testenv:flake8]

[Sebastian Noack, 2017/10/09 02:08:58]

This is somewhat unrelated, but it seems to make most sense for the tox setups
where we have many environments, to lint our code separately, instead of each
time for each Python version supported.

[Vasily Kuznetsov, 2017/10/09 21:16:14]

Indeed, it doesn't make sense to lint the code with the old version of Flake8
since we don't care what it thinks if the new version likes the code.

However, as Flake8 is tied to the version of Python on which it runs [1], in
order to confirm that code is Python2-kosher and also Python3-kosher, we might
need to run Flake8 on both Python2 and Python3. It's possible that the only
difference between running it on different interpreters is the ability to parse
Python3-syntax (irrelevant here since we can't use it), but I haven't found any
source that would confirm or disconfirm this, so if we want to be on the safe
side, doing both seems advisable. Or maybe that's too paranoid... I'm not sure.

In any case it probably makes sense to select a specific version of Python in
the linting environment to ensure consistency.

[1] http://flake8.pycqa.org/en/latest/ (see the note at the top of the page)

[Sebastian Noack, 2017/10/10 05:34:30]

The note in the flake8 documentation merely reminds you that when you use flake8
on an older Python version, that it cannot parse (or at least properly
understand) language features that have been added in newer versions of Python.
This, however, doesn't matter if your code is backwards compatible with Python
2, as you are stuck with the feature subset of all supported Python versions.

Regardless, I think it is sufficient to lint code that is compatible with Python
3, on Python 3 only. If the code looks good in Python 3, it looks good for the
future. And as long as it still runs on Python 2 (if required), I don't care if
in rare cases it might cause some additional linter warnings there. At some
point, support for Python 2 will be dropped, anyway.

It seems, by default, tox is using the latest available Python interpreter, if
not otherwise specified. So IMO we are all good.

[Sebastian Noack, 2017/10/10 18:17:39]

Indeed, in my /usr/bin/tox it says #!/usr/bin/python3. But yeah, if you would
install tox with pip (not pip3 or apt), which I suspect is how you installed
tox, it might use Python 2 inside the venvs by default. Anyway, I added
basepython now.

+deps =
+  flake8

[Vasily Kuznetsov, 2017/10/10 13:00:08]

Nit: these lines have different indentation level. Not that it matters for
anything but aesthetics, but would be neater if they were also indented by 4
spaces.

[Sebastian Noack, 2017/10/10 18:17:39]

Done.

+  flake8-docstrings
+  pep8-naming
+commands =
+    flake8 flake8_eyeo.py setup.py