alexafsm icon indicating copy to clipboard operation
alexafsm copied to clipboard

Custom style for flake8?

Open nalourie-ai2 opened this issue 7 years ago • 3 comments

  • alexafsm version: 0.1.0
  • Python version: 3.6.0
  • Operating System: El Capitan

Description

Running flake8 on the master branch I get a lot of style errors, which seems like a lot of noise. It makes me guess that maybe there are different settings that you're using with flake8 to develop, and I'm wondering what those settings are / if contributers should use them when submitting pull requests.

What I Did

> flake8 alexafsm tests
alexafsm/policy.py:32:80: E501 line too long (95 > 79 characters)
alexafsm/policy.py:49:80: E501 line too long (84 > 79 characters)
alexafsm/policy.py:59:80: E501 line too long (90 > 79 characters)
alexafsm/policy.py:85:80: E501 line too long (81 > 79 characters)
alexafsm/policy.py:94:80: E501 line too long (83 > 79 characters)
alexafsm/policy.py:125:80: E501 line too long (81 > 79 characters)
alexafsm/policy.py:127:80: E501 line too long (104 > 79 characters)
alexafsm/policy.py:134:80: E501 line too long (87 > 79 characters)
alexafsm/policy.py:138:80: E501 line too long (95 > 79 characters)
alexafsm/policy.py:142:80: E501 line too long (84 > 79 characters)
alexafsm/response.py:10:80: E501 line too long (98 > 79 characters)
alexafsm/response.py:15:80: E501 line too long (92 > 79 characters)
alexafsm/response.py:21:80: E501 line too long (93 > 79 characters)
alexafsm/session_attributes.py:6:80: E501 line too long (86 > 79 characters)
alexafsm/session_attributes.py:19:80: E501 line too long (83 > 79 characters)
alexafsm/session_attributes.py:39:80: E501 line too long (85 > 79 characters)
alexafsm/session_attributes.py:41:80: E501 line too long (83 > 79 characters)
alexafsm/session_attributes.py:51:80: E501 line too long (93 > 79 characters)
alexafsm/session_attributes.py:80:80: E501 line too long (87 > 79 characters)
alexafsm/session_attributes.py:90:80: E501 line too long (81 > 79 characters)
alexafsm/session_attributes.py:93:80: E501 line too long (87 > 79 characters)
alexafsm/session_attributes.py:96:80: E501 line too long (87 > 79 characters)
alexafsm/states.py:20:80: E501 line too long (91 > 79 characters)
alexafsm/states.py:24:80: E501 line too long (88 > 79 characters)
alexafsm/states.py:37:80: E501 line too long (98 > 79 characters)
alexafsm/states.py:60:80: E501 line too long (92 > 79 characters)
alexafsm/states.py:64:80: E501 line too long (83 > 79 characters)
alexafsm/utils.py:24:80: E501 line too long (96 > 79 characters)
alexafsm/utils.py:53:80: E501 line too long (80 > 79 characters)
alexafsm/utils.py:62:80: E501 line too long (85 > 79 characters)
tests/test_session_attributes.py:3:80: E501 line too long (94 > 79 characters)
tests/skillsearch/policy.py:11:80: E501 line too long (88 > 79 characters)
tests/skillsearch/policy.py:35:80: E501 line too long (87 > 79 characters)
tests/skillsearch/policy.py:36:80: E501 line too long (81 > 79 characters)
tests/skillsearch/policy.py:37:80: E501 line too long (90 > 79 characters)
tests/skillsearch/policy.py:46:80: E501 line too long (83 > 79 characters)
tests/skillsearch/server.py:31:80: E501 line too long (84 > 79 characters)
tests/skillsearch/server.py:59:80: E501 line too long (80 > 79 characters)
tests/skillsearch/skill.py:5:80: E501 line too long (87 > 79 characters)
tests/skillsearch/states.py:23:80: E501 line too long (81 > 79 characters)
tests/skillsearch/states.py:82:80: E501 line too long (81 > 79 characters)
tests/skillsearch/states.py:85:80: E501 line too long (81 > 79 characters)
tests/skillsearch/states.py:88:80: E501 line too long (95 > 79 characters)
tests/skillsearch/states.py:148:80: E501 line too long (94 > 79 characters)
tests/skillsearch/states.py:149:80: E501 line too long (92 > 79 characters)
tests/skillsearch/states.py:155:80: E501 line too long (89 > 79 characters)

nalourie-ai2 avatar Mar 01 '17 09:03 nalourie-ai2

Flake8 should be run from tox.

pip install tox (in system Python, not in virtualenv)

Then:

tox

vha14 avatar Mar 01 '17 18:03 vha14

That makes sense. Perhaps its worth removing the instructions about running flake8 and the test suite manually from the contributing instructions, as python devs unfamiliar with tox might become confused by it.

nalourie-ai2 avatar Mar 01 '17 20:03 nalourie-ai2

Yes. I'll update CONTRIBUTING.md accordingly.

On Wed, Mar 1, 2017 at 12:04 PM, Nicholas A. Lourie < [email protected]> wrote:

That makes sense. Perhaps its worth removing the instructions about running flake8 and the test suite manually from the contributing instructions, as python devs unfamiliar with tox might become confused by it.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/allenai/alexafsm/issues/7#issuecomment-283453619, or mute the thread https://github.com/notifications/unsubscribe-auth/AAgXBQy_qM4wJP-IeykVWsQMkhuCSYgJks5rhc9dgaJpZM4MPZ8i .

vha14 avatar Mar 01 '17 20:03 vha14