Planowanie struktury pakietu Python-
src-układ: pakiet znajduje się w src/safesort/, a nie w korzeniu repozytorium — i dlaczego jest to świadomy wybór, a nie dogmat.
Chaotyczna struktura katalogów nie przeszkadza programowi działać, ale utrudnia jego zrozumienie, testowanie i instalowanie jako pakiet. Dopóki kod nie jest napisany, zarejestrujemy tylko szkielet — i dodamy do niego po jednym pliku na raz, gdy pojawi się zadanie dla niego.
Kod źródłowy znajduje się w środku src/, a nie bezpośrednio w katalogu głównym
repozytorium — to się nazywa src- Układ (src layout). Bez niego
na poziomie zainstalowany pakiet i katalog źródłowy byłyby takie same, co łatwo byłoby pomyłkować
Sprawdź niewłaściwy kod, który faktycznie został zainstalowany — na przykład, jeśli zapomnisz o ponownej instalacji
po edycji pliku.
Krótko
- Pakiet na razie składa się tylko z README.md, pyproject.toml, src/safesort/__init__.py i tests/.
- src- układ umieszcza kod źródłowy w src/safesort/ zamiast w korzu repozytorium, aby testy nie mogły przypadkowo uzyskać dostępu do odinstalowanego kodu.
- Pozostałe moduły pojawią się pojedynczo, każdy z nich, gdy będzie miał konkretne zadanie.