Отже, ви поступово починаєте писати довші програми, і вам варто познайомитися з деякими рекомендаціями по стильовому оформленню коду. Не шкодуйте часу на те, щоб ваш код читався як можна простіше. Зрозумілий код допомагає стежити за тим, що робить ваша програма, і спрощує вивчення вашого коду іншими розробниками.
Програмісти Python виробили ряд рішень по стилю, щоб весь код мав хоча б віддалено схожу структуру. Навчившись писати «чистий» код Python, ви зможете зрозуміти загальну структуру коду Python, написаного будь-яким іншим програмістом, хто виконує ті ж рекомендації. Якщо ви розраховуєте коли-небудь стати професійним програмістом, звикайте дотримуватися цих рекомендацій вже зараз, щоб виробити корисну звичку.
Рекомендації по стилю.
Коли хто-небудь хоче внести зміни в мову Python, він пише документ PEP (Python Enhancement Proposal). Одним з найстаріших PEP є документ PEP 8 до рекомендацій по стильовому оформленню коду. PEP 8 має досить велику довжину, але більша частина документа присвячена більш складним програмним структурам, ніж ті, які зустрічалися вам до цього моменту. Керівництво по стилю Python було написано з урахуванням того факту, що код читається частіше, ніж пишеться. Ви пишете свій код один раз, а потім починаєте читати його, коли переходите до налагодження. При розширенні функціональності програми ви знову витрачаєте час на читання свого коду. А коли вашим кодом починають користуватися інші програмісти, вони теж читають його. Вибираючи між написанням коду, який простіше пишеться, і кодом, який простіше читається, програмісти Python майже завжди рекомендують другий варіант. Наступні поради допоможуть вам з самого початку писати чистий, зрозумілий код.
Відступи.
PEP 8 рекомендує позначати рівень відступу чотирма пробілами. Використання чотирьох пробилів спрощує читання програми і при цьому залишає достатньо місця для декількох рівнів відступів в кожному рядку. У програмах форматування тексту для створення відступів часто використовується табуляція замість пробілів. Такий спосіб добре працює в текстових процесорах, але інтерпретатор Python цього не розуміє, коли табуляція змішується з пробілами. У кожному текстовому редакторі є параметр конфігурації, який замінює натискання клавіші табуляції заданою кількістю пробилів. Звичайно, клавіша табуляції зручна, але ви повинні простежити за тим, щоб редактор вставляв в документ пробили замість табуляцій. Поєднання табуляцій і пробилів у файлі може створити проблеми, та сильно ускладнити діагностику. Якщо ви думаєте, що в програмі табуляції змішалися з пробілами, пам'ятайте, що в більшості редакторів існує можливість перетворити усі табуляції в пробили.
Довжина рядків.
Багато програмістів Python рекомендують обмежувати довжину рядків 80 символами. Історично ця рекомендація з'явилася через те, що в більшості комп'ютерів в одному рядку терміналу містилося всього 79 символів. В даний час на екранах поміщаються куди довші рядки, але для застосування стандартної довжини рядка в 79 символів існують і інші причини. Професійні програмісти часто відкривають на одному екрані відразу кілька файлів; стандартна довжина рядка дозволяє бачити всі рядки в двох або трьох файлах, відкритих на екрані одночасно. PEP 8 також рекомендує обмежувати коментарі 72 символами на рядок, тому що деякі службові програми, які автоматично генерують документацію в великих проектах, додають символи форматування на початку кожного рядка коментаря. Рекомендації PEP 8 по вибору довжини рядка не є непорушними, і деякі програмісти воліють обмеження в 99 символів. Поки ви вчитеся, довжина рядка в коді не так важлива, але врахуйте, що при спільній роботі, майже завжди дотримуються рекомендації PEP 8. У більшості редакторів можна встановити візуальний орієнтир (зазвичай вертикальну лінію на екрані), що показує, де проходить межа.
Порожні рядки.
Порожні рядки застосовуються для візуального групування частин програми. Використовуйте порожні рядки для структурування файлів, але не зловживайте ними. Приклади, наведені в статтях, допоможуть вам виробити потрібний баланс. Наприклад, якщо в програмі п'ять рядків коду створюють список, а потім наступні три рядки щось роблять з цим списком, два фрагмента доречно розділити порожнім рядком. Проте між ними не варто вставляти три або чотири порожні рядки. Порожні рядки не впливають на роботу коду, але відображаються на зручності його читання. Інтерпретатор Python використовує горизонтальні відступи для інтерпретації сенсу коду, але ігнорує вертикальні інтервали.
Інші рекомендації.
PEP 8 містить багато інших рекомендацій по стилю, але ці рекомендації в основному відносяться до програм більш складних, ніж ті, які ви пишете на даний момент. В міру вивчення більш складних можливостей Python я буду приводити відповідні фрагменти рекомендаціям PEP 8.
- Войдите или зарегистрируйтесь, чтобы оставлять комментарии