--- title: "Zaawansowany tutorial: Jak pisać aplikacje wielokrotnego użytku" version: 5.0 locale: pl source: https://docs.djangoproject.com/pl/5.0/intro/reusable-apps/ canonical: https://djangodocs.dev/pl/5.0/intro/reusable-apps/ --- # Zaawansowany tutorial: Jak pisać aplikacje wielokrotnego użytku Ten tutorial dla zaawansowanych zaczyna się, gdzie [Tutorial 8](/pl/5.0/intro/tutorial07/) się skończył. Będziemy przerabiać naszą web-ankietę na samodzielny pakiet Pythona, który będziesz mógł wykorzystać w nowym projekcie i którym będziesz mógł podzielić się z innymi. Jeśli nie ukończyłeś niedawno Tutoriali 1–7, zachęcamy cię do powtórzenia ich, aby twój przykładowy projekt pasował do tego opisanego poniżej. ## Możliwość ponownego użycia ma znaczenie Zaprojektować, zbudować, przetestować i utrzymywać aplikację webową to bardzo dużo pracy. Wiele projektów w Pythonie i Django napotyka wspólne problemy. Czy nie byłoby super, jeśli moglibyśmy oszczędzić części tej powtarzanej pracy? Ponowne wykorzystanie to sposób na życie w Pythonie. [Python Package Index (PyPI)](https://pypi.org/) zawiera obszerny zakres pakietów, które możesz wykorzystać w swoich własnych pythonowych programach. Sprawdź w [Django Packages](https://djangopackages.org) istniejące aplikacje gotowe do wykorzystania, które mógłbyś wcielić w swój projekt. Samo Django także jest normalnym pythonowym pakietem. To znaczy, że możesz wziąć istniejące pakiety Pythona lub aplikacje Django i złożyć z nich swój własny projekt webowy. Musisz jedynie napisać części, które uczynią twój projekt unikalnym. Powiedzmy, że zaczynałeś nowy projekt, który potrzebował aplikacji z ankietą, takiej jak ta, nad którą pracowaliśmy. Jak uczynić tą aplikację gotową do wykorzystania przez innych? Na szczęście, jesteśmy już na dobrej drodze. W [Tutorialu 1](/pl/5.0/intro/tutorial01/) widzieliśmy jak możemy wydzielić ankiety z URLconfa na poziomie projektu przez użycie `include`. W tym tutorialu poczynimy dalsze kroki, aby uczynić aplikację łatwą do użycia w nowych projektach i gotową do publikacji, aby inni mogli ją zainstalować i używać. > **Pakiet? Aplikacja?** > > Pythonowy [package](https://docs.python.org/3/glossary.html#term-package) jest sposobem na zgrupowanie związanego kodu Pythona na potrzeby łatwego ponownego użycia. Pakiet zawiera jeden lub więcej plików z kodem Pythona (znane także jako „moduły”). > > Pakiet można zaimportować przez `import foo.bar` lub `from foo import bar`. Aby katalog (jak `polls`) stał się pakietem, musi zawierać specjalny plik `__init__.py`, który może być pusty. > > *Aplikacja* Django jest pakietem Pythona, który jest szczególnie przeznaczony do użycia w projekcie Django. Aplikacja może używać powszechnych w Django konwencji, jak posiadanie podmodułów `models`, `tests`, `urls` i `views`. > > Dalej będziemy używać pojęcia *pakietowanie*, aby opisać proces robienia pakietu Pythona łatwego do instalacji dla innych. Mamy świadomość, że może to być nieco mylące. ## Twój projekt i twoja aplikacja do ponownego wykorzystania Po poprzednich tutorialach, nasz projekt powinien wyglądać tak: ```text mysite/ manage.py mysite/ __init__.py settings.py urls.py asgi.py wsgi.py polls/ __init__.py admin.py apps.py migrations/ __init__.py 0001_initial.py models.py static/ polls/ images/ background.png style.css templates/ polls/ detail.html index.html results.html tests.py urls.py views.py templates/ admin/ base_site.html ``` Stworzyłeś `mysite/templates` w [Tutorialu 7](/pl/5.0/intro/tutorial07/) i `polls/templates` w [Tutorialu 3](/pl/5.0/intro/tutorial03/). Teraz prawdopodobnie jest jaśniejsze dlaczego postanowiliśmy mieć osobne katalogi szablonów dla projektu i aplikacji: wszystko, co jest częścią aplikacji ankietowej jest w `polls`. To powoduje, że aplikacja jest w jednym kawałku i prościej ją wrzucić w nowy projekt. Katalog `polls` mógłby być teraz skopiowany do nowego projektu Django i od razu użyty. Ale nie jest zupełnie gotowy do bycia opublikowanym. Na tę potrzebę, musimy spakować naszą aplikację, aby ułatwić innym jej instalację. ## Instalowanie narzędzi Bieżący stan pakietowania w Pythonie jest nieco zagmatwany przez wiele narzędzi. Na potrzeby tego tutorialu, użyjemy [setuptools](https://pypi.org/project/setuptools/), aby zbudować nasz pakiet. Są one zalecanym narzędziem pakietowania (zmergowane z forkiem `distribute`). Będziemy też używać [pip](https://pypi.org/project/pip/), aby go zainstalować i odinstalować. Powinieneś teraz zainstalować te dwa pakiety. Jeśli potrzebujesz pomocy, możesz zajrzeć do [jak zainstalować Django używając pipa](/pl/5.0/topics/install/#installing-official-release). W ten sam sposób możesz zainstalować `setuptools`. ## Pakowanie twojej aplikacji Pythonowe *pakietowanie* oznacza przygotowane twojej aplikacji w określonym formacie, który będzie mógł być prosto zainstalowany i użyty. Samo Django jest zapakowane właśnie w ten sposób. Dla małej aplikacji jak ankiety, ten proces nie jest zbyt skomplikowany. 1. First, create a parent directory for the package, outside of your Django project. Call this directory `django-polls`. > **Wybór nazwy dla twojej aplikacji** > > When choosing a name for your package, check PyPI to avoid naming > conflicts with existing packages. We recommend using a `django-` > prefix for package names, to identify your package as specific to > Django, and a corresponding `django_` prefix for your module name. For > example, the `django-ratelimit` package contains the > `django_ratelimit` module. > > Etykiety aplikacji (czyli ostatnia część kropkowanej ścieżki do pakietów aplikacji) *musi* być unikalna w [`INSTALLED_APPS`](/pl/5.0/ref/settings/#std-setting-INSTALLED_APPS). Unikaj używania takich samych etykiet jak którykolwiek z [pakietów contrib](/pl/5.0/ref/contrib/), na przykład `auth`, `admin` lub `messages`. 2. Move the `polls` directory into `django-polls` directory, and rename it to `django_polls`. 3. Edit `django_polls/apps.py` so that [`name`](/pl/5.0/ref/applications/#django.apps.AppConfig.name) refers to the new module name and add [`label`](/pl/5.0/ref/applications/#django.apps.AppConfig.label) to give a short name for the app: *`django-polls/django_polls/apps.py`* ```python from django.apps import AppConfig class PollsConfig(AppConfig): default_auto_field = "django.db.models.BigAutoField" name = "django_polls" label = "polls" ``` 4. Stwórz plik `django-polls/README.rst` o następującej treści: *`django-polls/README.rst`* ```rst ============ django-polls ============ django-polls is a Django app to conduct web-based polls. For each question, visitors can choose between a fixed number of answers. Detailed documentation is in the "docs" directory. Quick start ----------- 1. Add "polls" to your INSTALLED_APPS setting like this:: INSTALLED_APPS = [ ..., "django_polls", ] 2. Include the polls URLconf in your project urls.py like this:: path("polls/", include("django_polls.urls")), 3. Run ``python manage.py migrate`` to create the models. 4. Start the development server and visit the admin to create a poll. 5. Visit the ``/polls/`` URL to participate in the poll. ``` 5. Stwórz plik `django-polls/LICENSE`. Wybór licencji jest poza zakresem tego tutorialu, ale wystarczy powiedzieć, że kod wydany publicznie bez licencji jest *bezużyteczny*. Django i wiele kompatybilnych z Django aplikacji są rozpowszechniane na licencji BSD, aczkolwiek ty możesz wybrać swoją własną licencję. Bądź tylko świadom, że wybór licencji będzie miał wpływ na to, kto może używać twój kod. 6. Następnie stworzymy pliki `pyproject.toml`, `setup.cfg` i `setup.py`, które uszczegóławiają jak zbudować i zainstalować aplikację. Pełne wytłumaczenie tych plików nie należy do tego tutorialu, ale [dokumentacja setuptools](https://setuptools.pypa.io/en/latest/) ma dobre wytłumaczenie. Stwórz pliki `django-polls/pyproject.toml`, `django-polls/setup.cfg` i `django-polls/setup.py` z następującą treścią: *`django-polls/pyproject.toml`* ```toml [build-system] requires = ['setuptools>=40.8.0'] build-backend = 'setuptools.build_meta' ``` *`django-polls/setup.cfg`* ```ini [metadata] name = django-polls version = 0.1 description = A Django app to conduct web-based polls. long_description = file: README.rst url = https://www.example.com/ author = Your Name author_email = yourname@example.com license = BSD-3-Clause # Example license classifiers = Environment :: Web Environment Framework :: Django Framework :: Django :: X.Y # Replace "X.Y" as appropriate Intended Audience :: Developers License :: OSI Approved :: BSD License Operating System :: OS Independent Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Topic :: Internet :: WWW/HTTP Topic :: Internet :: WWW/HTTP :: Dynamic Content [options] include_package_data = true packages = find: python_requires = >=3.10 install_requires = Django >= X.Y # Replace "X.Y" as appropriate ``` *`django-polls/setup.py`* ```python from setuptools import setup setup() ``` 7. Only Python modules and packages are included in the package by default. To include additional files, we’ll need to create a `MANIFEST.in` file. The `setuptools` docs referred to in the previous step discuss this file in more detail. To include the templates, the `README.rst` and our `LICENSE` file, create a file `django-polls/MANIFEST.in` with the following contents: *`django-polls/MANIFEST.in`* ```text include LICENSE include README.rst recursive-include django_polls/static * recursive-include django_polls/templates * ``` 8. Opcjonalne, ale zalecane, jest zawarcie szczegółowej dokumentacji w twojej aplikacji. Stwórz pusty katalog `django-polls/docs` na przyszłą dokumentację. Dodaj nową linię w `django-polls/MANIFEST.in`: ```text recursive-include docs * ``` Zwróć uwagę, że katalog `docs` nie zostanie zawarty w twoim pakiecie dopóki nie dodasz do niego jakichś plików. Wiele aplikacji Django dostarcza swoją dokumentację online przez strony takie jak [readthedocs.org](https://readthedocs.org). 9. Try building your package by running `python setup.py sdist` inside `django-polls`. This creates a directory called `dist` and builds your new package, `django-polls-0.1.tar.gz`. Aby dowiedzieć się więcej na temat pakowania, zobacz tutorial [Packaging Python Projects](https://packaging.python.org/tutorials/packaging-projects/). ## Używanie twojego własnego pakietu Odkąd przenieśliśmy katalog `polls` poza projekt, nie działa. Naprawimy to teraz instalując nasz nowy pakiet `django-polls`. > **Instalowanie jako bibliotekę użytkownika** > > Poniższe kroki zainstalują `django-polls` jako bibliotekę użytkownika. Instalacja bibliotek per użytkownik posiada sporo zalet w porównaniu do instalacji paczek per system jak np. możliwość instalacji bibliotek w systemie, w którym nie posiadasz uprawnień administracyjnych oraz zapobieganie wpływu biblioteki na system i innych jego użytkowników. > > Pamiętaj, że instalacja per użytkownik nadal może wpłynąć na narzędzia systemowe uruchamiane przez tego samego użytkownika, więc używanie środowiska wirtualnego jest bardziej niezawodnym rozwiązaniem (patrz niżej). 1. Aby zainstalować pakiet, użyj pipa (już [go zainstalowałeś](#installing-reusable-apps-prerequisites), prawda?): ```shell python -m pip install --user django-polls/dist/django-polls-0.1.tar.gz ``` 2. Update `mysite/settings.py` to point to the new module name: ``` INSTALLED_APPS = [ "django_polls.apps.PollsConfig", ..., ] ``` 3. Update `mysite/urls.py` to point to the new module name: ``` urlpatterns = [ path("polls/", include("django_polls.urls")), ..., ] ``` 4. Run the development server to confirm the project continues to work. ## Publikowanie twojej aplikacji Teraz, kiedy już spakowaliśmy i przetestowaliśmy `django-polls`, są gotowe do podzielenia się ze światem! Gdyby to nie był tylko przykład, mógłbyś teraz: - Wyślij e-mail z pakietem do znajomego. - Załaduj pakiet na swoją stronę. - Opublikuj pakiet w publicznym repozytorium, takim jak [Python Package Index (PyPI)](#the-python-package-index-pypi). [packaging.python.org](https://packaging.python.org) ma [dobry tutorial](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives) na ten temat. ## Instalowanie pakietów Pythona z wirtualnym środowiskiem Earlier, we installed `django-polls` as a user library. This has some disadvantages: - Modyfikowanie bibliotek użytkownika może wpłynąć na inne oprogramowanie Python w twoim systemie. - Nie będziesz w stanie uruchamiać wielu wersji tego pakietu (lub innych o takiej samej nazwie). Zazwyczaj takie sytuacje zdarzają się tylko kiedy utrzymujesz kilka projektów Django. W takiej sytuacji najlepszym rozwiązaniem jest venv \. To narzędzie pozwala utrzymywać wiele izolowanych środowisk Pythona, każdy ze swoimi własnymi kopiami bibliotek i przestrzeniami nazw dla pakietów.