🚩 🍵 👩🏽‍🚒 Django और DRF टाइपिंग 🙅🏻 🧖🏽 👦🏾

जैसा कि आप पहले से ही जानते हैं कि मुझे वैकल्पिक स्थिर टाइपिंग पसंद है। बात यह है कि कभी-कभी यह वैकल्पिक नहीं है, लेकिन असंभव है। क्योंकि हमारे पास पायथन के इकोसिस्टम में बहुत बड़ी अनकैप्ड परियोजनाएं हैं।

Django और Django-Rest-Framework उनमें से दो थे। थे। क्योंकि अब उन्हें टाइप किया जा सकता है! मुझे django और drf लिए टाइप किए गए Django संगठन और स्टब्स की drf ।

यह एक संक्षिप्त ट्यूटोरियल होने जा रहा है और गाइड प्राप्त करना शुरू कर रहा है।

यश

मैं इस परियोजना को आगे बढ़ाने के लिए और इसे संभव बनाने वाले सभी योगदानकर्ताओं के लिए @mkurnikov को एक बड़ा "धन्यवाद" कहना चाहता हूं। तुम सब कमाल हो!

TLDR

इस लेख में, मैं दिखा रहा हूँ कि कैसे django और drf साथ काम करते हैं। आप यहाँ परिणाम पर एक नज़र डाल सकते हैं।

और आप पहले से ही कॉन्फ़िगर की गई सभी चीजों के साथ अपनी नई परियोजनाओं को शुरू करने के लिए wemake-django-template का उपयोग कर सकते हैं। यह बिल्कुल उदाहरण परियोजना की तरह दिखेगा।

शुरुआत हो रही है

इस छोटे ट्यूटोरियल में, मैं आपको एक्शन में django-stubs और djangorestframework-stubs की कई विशेषताएं djangorestframework-stubs । मुझे उम्मीद है कि यह आपको यकीन दिलाएगा कि आपके अच्छे काम के बाद किसी को चीजों को दोगुना करना है।

आप हमेशा मूल दस्तावेज का उल्लेख कर सकते हैं। सभी चरणों को भी कवर किया गया है।

शुरू करने के लिए हमें एक नई परियोजना और एक स्वच्छ आभासी वातावरण की आवश्यकता होगी, इसलिए हम अपनी निर्भरताएं स्थापित कर सकते हैं:

 pip install django django-stubs mypy

फिर हमें सही ढंग से mypy को कॉन्फ़िगर करने की आवश्यकता होगी। इसे दो चरणों में विभाजित किया जा सकता है। सबसे पहले, हम mypy कॉन्फ़िगर करते हैं:

 # setup.cfg [mypy] # The mypy configurations: https://mypy.readthedocs.io/en/latest/config_file.html python_version = 3.7 check_untyped_defs = True disallow_any_generics = True disallow_untyped_calls = True disallow_untyped_decorators = True ignore_errors = False ignore_missing_imports = True implicit_reexport = False strict_optional = True strict_equality = True no_implicit_optional = True warn_unused_ignores = True warn_redundant_casts = True warn_unused_configs = True warn_unreachable = True warn_no_return = True

फिर हम django-stubs प्लगइन कॉन्फ़िगर करते हैं:

 # setup.cfg [mypy] # Appending to `mypy` section: plugins = mypy_django_plugin.main [mypy.plugins.django-stubs] django_settings_module = server.settings

हम यहाँ क्या करते हैं?

हम कुछ जटिल mypy विशिष्ट स्थितियों (जैसे मॉडल, क्वेरीसेट, सेटिंग्स, आदि) में चेकर अनुमान प्रकारों की सहायता के लिए एक कस्टम mypy प्लगइन जोड़ते हैं।
हम django-stubs लिए कस्टम कॉन्फ़िगरेशन भी जोड़ते हैं ताकि इसे सेटिंग्स पर इंगित किया जा सके, हम Django के लिए उपयोग करते हैं। इसे आयात करने की आवश्यकता होगी।

अंतिम परिणाम यहां पाया जा सकता है ।

अब हमारे पास सब कुछ स्थापित और कॉन्फ़िगर है। चलिए चेक करते हैं बातें!

टंकण विचार

आइए टाइपिंग विचारों से शुरू करें क्योंकि यह इस प्लगइन के साथ सबसे आसान काम है।

यहां हमारा सरल कार्य-आधारित दृश्य है:

 # server/apps/main/views.py from django.http import HttpRequest, HttpResponse from django.shortcuts import render def index(request: HttpRequest) -> HttpResponse: reveal_type(request.is_ajax) reveal_type(request.user) return render(request, 'main/index.html')

आइए देखें और देखें कि यह किस प्रकार का है। ध्यान दें कि हमें PYTHONPATH को संशोधित करने की आवश्यकता हो सकती है, इसलिए mypy हमारी परियोजना को आयात करने में सक्षम होगी:

 » PYTHONPATH="$PYTHONPATH:$PWD" mypy server server/apps/main/views.py:14: note: Revealed type is 'def () -> builtins.bool' server/apps/main/views.py:15: note: Revealed type is 'django.contrib.auth.models.User'

चलो कुछ तोड़ने की कोशिश करते हैं:

 # server/apps/main/views.py def index(request: HttpRequest) -> HttpResponse: return render(request.META, 'main/index.html')

नहीं, वहाँ एक टाइपो और mypy इसे पकड़ लेंगे:

 » PYTHONPATH="$PYTHONPATH:$PWD" mypy server server/apps/main/views.py:18: error: Argument 1 to "render" has incompatible type "Dict[str, Any]"; expected "HttpRequest"

यह काम करता है! ठीक है, लेकिन यह बहुत सीधे आगे है। आइए हमारे उदाहरण को थोड़ा जटिल करें और यह दिखाने के लिए कि हम कैसे मॉडल और क्वेरी टाइप कर सकते हैं एक कस्टम मॉडल बनाएं।

टाइपकास्टिंग मॉडल और क्वेरीसेट

Django का ORM एक किलर-फीचर है। यह बहुत लचीला और गतिशील है। इसका मतलब यह भी है कि टाइप करना कठिन है। आइए देखें कुछ विशेषताएं जो पहले से ही django-stubs द्वारा कवर की गई हैं।

हमारे मॉडल की परिभाषा:

 # server/apps/main/models.py from django.contrib.auth import get_user_model from django.db import models User = get_user_model() class BlogPost(models.Model): author = models.ForeignKey(User, on_delete=models.CASCADE) text = models.TextField() is_published = models.BooleanField(default=False) created_at = models.DateTimeField(auto_now_add=True) def __str__(self) -> str: reveal_type(self.id) # example reveal of all fields in a model reveal_type(self.author) reveal_type(self.text) reveal_type(self.is_published) reveal_type(self.created_at) return '<BlogPost {0}>'.format(self.id)

और इस मॉडल का हर क्षेत्र django-stubs द्वारा कवर किया गया है। आइए देखें कि कौन से प्रकार सामने आए हैं:

 » PYTHONPATH="$PYTHONPATH:$PWD" mypy server server/apps/main/models.py:21: note: Revealed type is 'builtins.int*' server/apps/main/models.py:22: note: Revealed type is 'django.contrib.auth.models.User*' server/apps/main/models.py:23: note: Revealed type is 'builtins.str*' server/apps/main/models.py:24: note: Revealed type is 'builtins.bool*' server/apps/main/models.py:25: note: Revealed type is 'datetime.datetime*'

सब कुछ अच्छा लग रहा है! मॉडल क्षेत्र को सही उदाहरण प्रकारों में परिवर्तित करने के लिए django-stubs कस्टम mypy प्लगइन प्रदान करता है। इसलिए सभी प्रकार सही ढंग से प्रकट होते हैं।

django-stubs प्लगइन की दूसरी बड़ी विशेषता यह है कि हम QuerySet टाइप कर सकते हैं:

 # server/apps/main/logic/repo.py from django.db.models.query import QuerySet from server.apps.main.models import BlogPost def published_posts() -> 'QuerySet[BlogPost]': # works fine! return BlogPost.objects.filter( is_published=True, )

और यहां बताया गया है कि इसे कैसे जांचा जा सकता है:

 reveal_type(published_posts().first()) # => Union[server.apps.main.models.BlogPost*, None]

हम .values() और .values_list() कॉल के साथ .values() को भी एनोटेट कर सकते हैं। यह प्लगइन स्मार्ट है!

मैं कई वर्षों से QuerySet s की वापसी करने QuerySet विधियाँ QuerySet तरीकों से जूझ रहा हूँ। यह सुविधा मेरे लिए एक बड़ी समस्या का हल करती है: कोई अधिक Iterable[BlogPost] या List[User] । मैं अब वास्तविक प्रकारों का उपयोग कर सकता हूं।

टाइपिंग एपीआई

लेकिन, विचार, मॉडल, रूप, कमांड, यूआरएल और व्यवस्थापक टाइप करना हम सब के पास नहीं है। टंकजडंगो में भी djangorestframework के लिए djangorestframework । आइए इसे स्थापित और कॉन्फ़िगर करें:

 pip install djangorestframework djangorestframework-stubs

और हम सीरियल बनाने के लिए शुरू कर सकते हैं:

 # server/apps/main/serializers.py from rest_framework import serializers from server.apps.main.models import BlogPost, User class UserSerializer(serializers.ModelSerializer): class Meta: model = User fields = ['username', 'email'] class BlogPostSerializer(serializers.HyperlinkedModelSerializer): author = UserSerializer() class Meta: model = BlogPost fields = ['author', 'text', 'is_published', 'created_at']

दृश्य:

 # server/apps/main/views.py from rest_framework import viewsets from server.apps.main.serializers import BlogPostSerializer from server.apps.main.models import BlogPost class BlogPostViewset(viewsets.ModelViewSet): serializer_class = BlogPostSerializer queryset = BlogPost.objects.all()

और राउटर:

 # server/apps/main/urls.py from django.urls import path, include from rest_framework import routers from server.apps.main.views import BlogPostViewset, index router = routers.DefaultRouter() router.register(r'posts', BlogPostViewset) urlpatterns = [ path('', include(router.urls)), # ... ]

यह भी नहीं दिखता है कि कुछ बदल गया है, लेकिन अंदर सब कुछ टाइप किया गया है: सेटिंग्स, धारावाहिक, दृश्य और राउटर। यह आपको वृद्धिशील रूप से टाइपिंग जोड़ने की अनुमति देगा जहां आपको उनकी सबसे अधिक आवश्यकता है।

आइए queryset = BlogPost.objects.all() को बदलने का प्रयास करें
हमारे विचार में queryset = [1, 2, 3] करने के लिए queryset = [1, 2, 3] :

 » PYTHONPATH="$PYTHONPATH:$PWD" mypy server server/apps/main/views.py:25: error: Incompatible types in assignment (expression has type "List[int]", base class "GenericAPIView" defined the type as "Optional[QuerySet[Any]]")

नहीं, यह काम नहीं करेगा! अपना कोड ठीक करें!

निष्कर्ष

फ्रेमवर्क इंटरफेस टाइप करना एक कमाल की बात है। जब returns और mappers जैसे उपकरणों के साथ संयुक्त होता है, तो यह टाइप-फ्रेमवर्क इंटरफेस में लिपटे टाइप-सेफ और डिक्लेक्टिव बिजनेस लॉजिक को लिखने की अनुमति देगा। और इन दोनों के बीच की परत में त्रुटियों की संख्या को कम करने के लिए।

वैकल्पिक क्रमिक स्थिर टाइपिंग भी आपको तेजी से शुरू करने और केवल तभी जोड़ने की अनुमति देती है जब आपका एपीआई स्थिर होता है या बहुत शुरुआत से टाइप-संचालित विकास के साथ जाता है।

हालाँकि, django-stubs और djangorestframework-stubs नई परियोजनाएँ हैं। अभी भी बहुत सारे कीड़े, नियोजित विशेषताएं, लापता प्रकार के चश्मे हैं। हम पायथन में डेवलपर टूलिंग को वास्तव में भयानक बनाने के लिए समुदाय के हर योगदान का स्वागत करते हैं।

मूल रूप से मेरे ब्लॉग पर प्रकाशित।

Django और DRF टाइपिंग