Healthy practices for happy and successful codebase

1. ealthy practices for
happy and successful codebase
Misha Behersky KyivPy, September, 2016

2. Code style
2

3. Same code
3

4. Bearsharktopus
4

5. pep8 is not enough
Grid, vertical, hanging indent, vertical hanging indent, hanging grid...
5

6. isort
standard library modules
third-party modules
user-defined modules
6

7. pycodestyle, pyflakes, pylint,
pychecker, etc.
● No global found
● Passing the wrong number of parameters
● Using format strings that don't match arguments
● Using a variable before setting it
● self is not the first parameter defined for a method
● Unused function/method arguments (can ignore self)
● No doc strings in modules, classes, functions
● ...
7

8. tick with strict rules
8

9. Managing requirements
9

10. pgrade fast
pypiup pip-tools
10

11. Dependency hell
11

12. Environments
● Develop in env that is as close as possible to production
one
● Test in all possible envs that your app might run
● Select your favourite IDE and use it)
12

13. Testing
● Test what's likely to break
● Test negative cases and edge cases
● If writing tests is hard, that might be a bug
● Aggressively make your test suite fast and reliable
● Run it automatically
13

14. Flaky???
● If it’s flaky it’s not a test*
● Stop calling your build flaky*
*If I was in my office I would bite my tongue
14

15. o not write tests
15

16. rief is not better
16

17. self-descriptive speaks for itself
17

18. Overcommunicate
18

19. Naming
19

20. utomate routine
20

21. Put your two cents in
21

22. ail early
22

23. ail early
23

24. ail early
24

25. Dream within a dream
25

26. elete code as soon as you know you don't
need it any more, no questions asked
26

27. vulture
27

28. Are you ready?
28

29. ime is the only resource you truly need
29

30. easure everything
30

31. Wakatime
31

32. cloc
32

33. Toggl
33

34. Other tools
https://github.com/madisonmay/BlackWidow
34
https://github.com/mschwager/cohesion
https://github.com/Yelp/undebt

35. ecap
● Play stupid
● If you don’t try, you’ll never know
● Save your energy for something better than
programming work
● Consider and reason
● …
● ???
● PROFIT!
35

36. esources
https://github.com/timothycrosley/isort [6]
http://www.kennethreitz.org/essays/a-better-pip-workflow [10]
https://github.com/ekonstantinidis/pypiup [10]
http://semver.org [11]
https://tox.readthedocs.io/en/latest/ [12]
http://holger-peters.de/using-pyenv-and-tox.html [12]
https://eev.ee/blog/2016/08/22/testing-for-people-who-hate-testing [13]
https://github.com/box/flaky [14]
http://martinfowler.com/bliki/TwoHardThings.html [19]
https://github.com/myint/vulture [27]
http://bmwlog.pp.ua/post/105 [32]
36

37. &
37

38. e are hiring
datarobot.com/careers/ 38

39. hanks for your attention
bmwlog.pp.ua
bmwant@gmail.com
@bmwant
39