iiuni / projektzapisy

System Zapisów na zajęcia w Instytucie Informatyki Uniwersytetu Wrocławskiego
https://zapisy.ii.uni.wroc.pl
30 stars 10 forks source link

Drobne porządki w importach #1620

Open lgpawel opened 8 months ago

lgpawel commented 8 months ago

W Pythonie importy powinny być na początku pliku (PEP8: "Imports are always put at the top of the file"), ale nie ma na to chyba reguły lintera (jest parę pokrewnych), bo czasami jednak są powody, by od tego odejść (o czym zaraz), w związku z czym mamy w projekcie kilka takich wystąpień. Zaawansowane narzędzie developerskie pt. grep (a dokładnie wykonane w /zapisy/apps polecenie rgrep '^ .* import ' – tj. z lenistwa szukam wciętych importów, a nie wszystkich nie-na-topie) po odsianiu kilku fałszywych pozytywów (np. słowo "import" w docstring-u) mówi o wystąpieniach problemu w:

enrollment/courses/models/group.py
enrollment/courses/models/term.py
users/apps.py
schedule/views.py
schedule/models/event.py
schedule/models/specialreservation.py

Należałoby przenieść importy łamiące ww. zasadę na początek pliku bądź znaleźć uzasadnienie, dlaczego w określonych przypadkach należy zostawić je tak, jak są. Oprócz przejrzenia ww. plików należy sprawdzić, czy nie ma gdzieś importów "problematycznych" ale niezagnieżdżonych.

Osobna sprawa to importy w wierszach zakończonych komentarzem # noqa – nieprzypadkowo wszystkie są ostatnimi instrukcjami metod przeciążających AppConfig.ready(), ponadto wszystkie (poza jednym) dotyczą plików z definicjami sygnałów. Tu gołym okiem widać, że same importy należy zostawić tak, jak są, bo dzieje się tu jakaś większa kombinacja z wbudowanymi klasami Django; być może osobno (tj. poza tym issue) warto by rozważyć przepisanie tego tak, żeby wyglądało mniej kryptycznie, tu na razie ograniczmy się do zmiany komentarza tak, by wyłączał nie wszystkie reguły lintera, a tylko te w tym miejscu istotne. Będzie to bodajże F401, ale należy sprawdzić, czy wyłącznie.