Стиль программирования, комментарии и строки документации

Про стиль, оформление и т. п. есть целое сообщество: PyCQA

О дисциплине разработки

Замечание. Многие ссылки в плане приведены через сайт Python Packages Index (PyPI). Получается один лишний уровень косвенности, но:

Оформление кода

pep-0008 — рекомендации к оформлению кода.

pep-0257 — рекомендации к оформлению строк документации

Анализаторы кода (см. сайт PyCQA):

Форматтеры

Регламент или стандарт?

“A foolish consistency is the hobgoblin of little minds, adored by little statesmen and philosophers and divines. With consistency a great soul has simply nothing to do. He may as well concern himself with his shadow on the wall. Speak what you think now in hard words, and to-morrow speak what to-morrow thinks in hard words again, though it contradict every thing you said to-day. — 'Ah, so you shall be sure to be misunderstood.' — Is it so bad, then, to be misunderstood? Pythagoras was misunderstood, and Socrates, and Jesus, and Luther, and Copernicus, and Galileo, and Newton, and every pure and wise spirit that ever took flesh. To be great is to be misunderstood.”

Примеры дисциплин оформления

Из личных наблюдений

Что (почти) не покажут анализаторы кода

Комментарии

Аннотирование

TODO совместить с MyPy

Напомню:

Д/З

В семестровом проекте должна быть поддержка

В каталоге проекта можно разместить настроечные файлы проверяльщиков и изменить/отключить некоторые из претензии: например, изменить длину строки.

LecturesCMC/PythonDevelopment2023/07_Style (последним исправлял пользователь FrBrGeorge 2023-03-21 16:18:58)