Czy Twój kod w Pythonie jest czytelny?

Rozpoczynając naukę programowania w języku Python, zwracam uwagę na szczegóły dotyczące sposobu pisania mojego kodu. Nie tylko jego funkcjonalność, ale upewnienie się, że mój kod jest zgodny z najlepszymi praktykami i może być łatwo interpretowany przez innych. Jest to ważny nawyk, który należy wdrożyć, więc jeśli w przyszłości zostanie utworzona aplikacja internetowa lub zostanie napisana część bazy kodu, inni inżynierowie oprogramowania mogą łatwo zobaczyć, co robi kod, a pracę można poprawić. Odniosłem się do Przewodnika stylów PEP 8 dla kodu Pythona, aby uzyskać jaśniejszy obraz tego, jak wygląda najlepsza praktyka w kodowaniu Pythona.

W Pythonie spacje są generalnie preferowane zamiast tabulatorów. Jeśli zdecydujesz się to zrobić, możesz użyć kodu — ale nie należy mieszać tabulatorów i spacji! Znaczenie spójności będzie powracającym tematem na tym blogu. Ludziom łatwiej jest czytać treści i rozumieć je, jeśli są spójne. Identyfikacja powinna składać się z czterech spacji. W poniższym przykładzie print jest wcięty o 4 spacje od początku pierwszego wiersza.

W Pythonie linia powinna być ograniczona do 75 znaków. Jeśli Twój kod przekroczy limit 75 znaków, możesz użyć wiszącego wcięcia, aby przenieść przepełniony kod do następnej linii i upewnić się, że nadal jest czytelny. W przypadku przekazywania wcięć priorytetem jest wyrównanie przepełnionego kodu z jego odpowiednikiem w poprzedniej linii, aby był łatwiejszy do odczytania. Dlatego wiszące wcięcia nie muszą być wcięte o cztery spacje. Poniżej znajduje się przykład przepełnienia kodu wykorzystującego wiszące wcięcie.

Należy również unikać dodatkowych odstępów między nawiasami a znakami interpunkcyjnymi. Czasami muszę sobie przypominać, że piszę kod, a nie pracę semestralną. Poniżej znajduje się rażący przykład białej przestrzeni. Ogólnie rzecz biorąc, dobrą praktyką jest ponowne przeczytanie kodu, aby upewnić się, że dodatkowe miejsce nie wkradło się przypadkowo do kodu.

Na koniec ważne jest, aby kod Pythona zawierał komentarze i aby te komentarze były łatwe do odczytania. Komentarze w Pythonie powinny być pisane pełnymi zdaniami i zaczynać się wielką literą, chyba że pierwsze słowo jest zmienną pisaną małą literą. Jeśli w komentarzu jest kilka zdań, po kropce powinny być dwie spacje. (Moja praktyka semestralna w końcu się tu przyda!). Komentarze są szczególnie ważne, jeśli istnieje sekcja kodu, której przeznaczenie jest niejasne.

Istnieją przypadki, w których przewodnik stylistyczny PEP 8 nie ma preferencji. W takich przypadkach możesz wybrać styl swojego kodu, ale zawsze powinieneś starać się być spójny. Pamiętaj, konsekwencja to podstawa!

Źródła:

Pięć wskazówek, jak zwiększyć czytelność kodu Pythona. Inżynieria dla nauki o danych

https://engineeringfordatascience.com/posts/top_tips_for_improving_python_code_without_refactoring/