Kyle Knapp - Automating Code Quality - PyCon 2018

[@stalinthomas9850]

06:38 flake8 10:21 pylint 14:54 coverage 16:53 Code quality tools ecosystem 18:50 Automating for local environment 21:22 Automating for a team/project environment 23:24 Benefits of automated quality check setup 24:20 Best practices 27:30 Recap

[@ralienpp]

Thanks Kyle, this was very informative! I have some questions - why did you chose to use a Make-file to do that, as opposed to a bash script or something else?

[@kyleknapp2077]

Thanks! Glad you liked the talk. We use a makefile mainly because it is just something that my team is most familiar with and use most often in other projects. Makefiles are nice because they keep all of your logic in one place (say as opposed to a bunch of bash scripts) and make it very easy to run a specific rule (i.e. all you have to do is run “make ”). However, the makefile could have been easily replaced with bash scripts or tox (Aside: tox is nice too because it is similar to a makefile but you can have it run for different Python environments automatically). In the end, it is up to on how you want to approach it as the point of it is to enable better organization of your checks and make it very easy to run them. So, if you do find something that achieves those two goals that you like, I say go for it.

[@ralienpp]

After some experimentation, I settled for Makefiles as well, they are quite convenient. Do you know of a way to wrap the calls to pylint in such a way that the build fails if there are errors, but doesn't fail if there are recommendations on style, naming conventions, etc? For example, an easy way to accomplish this is to run pylint with `--disable=C,R,W`, but this doesn't run those checks at all. I would like to run them, so I can see the output and the recommendations, but in a way that they don't interfere with the final outcome. Is this a common practice?

[@vcool]

ralienpp You can probably alternatively configure pytest to run the tools of your choice. For this you would have to install each relevant pytest plugin.

[@aljuvialle]

tox is much better and more pythonic to run any check you want and need. You can specify environment and run specific tools to use.

[@tucsonthinks]

Great talk, really enjoyed it. I wanted to look back at the slides, but both provided links are currently broken :'(

[@nx_s]

I know it might be overdue, but this link works for me: speakerdeck.com/pycon2018/kyle-knapp-automating-code-quality

[@Surister0]

pf, using requirements..txt in 2018, kinda feels old and unnecessary

[@DurgaswaroopPerla]

It's 2020 and it's still not old. That's a great way to manage dependencies.