CixoNotes - prośba o ocenę kodu prostego programu w języku python

Question

Hejka, niedawno napisałem program służący do tworzenia prostych notatek, dodając go do .bashrc możemy sobie takie przygotowane wcześniej notatki wyświetlać za każdym razem jak zalogujemy się do tty albo otworzymy terminal. Jeżeli ktoś ma ochotę i chwilę czasu był bym bardzo wdzięczny za ocenę mojego kodu :3

Link do repo git: https://github.com/CixoDevelop/CixoNotes

Dzięki za każdą sugestię

Answer 1

Na szybko:

• Brak testów
• Trzymanie konfiguracji lepiej byłoby przenieść do pliku z konfiguracją i zaczytywać taki plik (np. za pomocą modułu confgparser). Sprawdzanie pól poprzez iterowanie po vars to chyba nie najlepszy pomysł. Ostatecznie dałoby się ten kod skrócić poprzez iterowanie po atrybutach klasy Language
• Niezgodność z PEP-8. Nazwy metod piszemy snake casem, a nie camel casem, to nie JS. Nazwy plików podobnie
• Brak komentarzy w języku angielskim
• Import z gwiazdką
• Brak f-stringów, zamiast tego używasz starego formatowania
• Brak menadżera kontekstu przy obsłudze plików
• Do pracy ze ścieżkami/plikami używaj modułu pathlib zamiast os.path
• Warto napisać w readme w jakimś znany formacie, np. markdown
• Nic nie mówiące opisy commitów

 

Comments

Dzięki wprowadze zmiany

---

@Benek, Wprowadziłem zmiany o których pisałeś za wyjątkiem języka angielskiego - zbyt mało znam ten język jeszcze żeby w nim opisywać takie rzeczy. Jeżeli miał byś chwilkę był bym strasznie wdzięczny jak byś powiedział czy o to chodziło