Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Drobne porządki w importach #1620

Open
lgpawel opened this issue Dec 21, 2023 · 0 comments · May be fixed by #1630
Open

Drobne porządki w importach #1620

lgpawel opened this issue Dec 21, 2023 · 0 comments · May be fixed by #1630
Assignees

Comments

@lgpawel
Copy link
Contributor

lgpawel commented Dec 21, 2023

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.

@cptkidd62 cptkidd62 self-assigned this Dec 21, 2023
@cptkidd62 cptkidd62 linked a pull request Jan 3, 2024 that will close this issue
@cptkidd62 cptkidd62 linked a pull request Jan 3, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants