प्लगइन्स के साथ Mypy एक्सटेंशन

शुभ दोपहर, दोस्तों। और हम नए पाठ्यक्रमों को लॉन्च करने की तीव्रता में वृद्धि करना जारी रखते हैं और अब अप्रैल की देर से शुरू होने वाले "वेब-डेवलपर इन पायथन" पाठ्यक्रम में कक्षाओं की घोषणा करते हुए खुश हैं। इस संबंध में, हम परंपरागत रूप से उपयोगी सामग्री के अनुवाद को साझा करते हैं। चलिए शुरू करते हैं।

पायथन को एक गतिशील टाइपिंग भाषा के रूप में जाना जाता है। डीएसएल जैसे फ्रेमवर्क लिखना बहुत आसान है जो स्टैटिक टाइप चेकिंग टूल्स के साथ पार्स करना मुश्किल है। इसके बावजूद, mypy के नवीनतम कार्यात्मक नवाचारों, जैसे कि प्रोटोकॉल और शाब्दिक प्रकार , साथ ही मेटाक्लस और डिस्क्रिप्टर समर्थन के लिए बुनियादी समर्थन, हम अक्सर सटीक प्रकार प्राप्त कर सकते हैं, लेकिन झूठी सकारात्मक और अन्य नकारात्मक कारकों से बचना अभी भी मुश्किल है। इस समस्या को हल करने के लिए और प्रत्येक ढांचे के लिए प्रकार प्रणाली को अनुकूलित करने की आवश्यकता से बचने के लिए, मैपी प्लग-इन सिस्टम का समर्थन करता है। पाइथन में प्लगइन्स मॉड्यूल हैं जो प्लगइन हुक प्रदान करते हैं जो कि एक पुस्तकालय और ढांचे के साथ बातचीत करने वाले वर्गों और कार्यों के प्रकारों की जांच करते समय मैपी कॉल करेंगे। इस प्रकार, लौटे हुए फ़ंक्शन के प्रकार को अधिक सटीक रूप से अलग करना संभव है, जो कि व्यक्त करने के लिए अन्यथा बहुत मुश्किल है, या डेकोरेटर के प्रभावों को प्रतिबिंबित करने के लिए स्वचालित रूप से कुछ वर्ग विधियां उत्पन्न करते हैं। प्लग-इन सिस्टम की वास्तुकला के बारे में अधिक जानने के लिए और सुविधाओं की पूरी सूची देखें, दस्तावेज़ीकरण देखें ।



मानक पुस्तकालय के लिए संबंधित प्लगइन्स

Mypy बुनियादी कार्यों और कक्षाओं, साथ ही ctypes , contextlib और dataclasses को लागू करने के लिए डिफ़ॉल्ट प्लगइन्स के साथ आता है। इसमें एटर्स के लिए प्लगइन्स भी शामिल हैं (यह ऐतिहासिक रूप से पहला थर्ड-पार्टी प्लगइन है जो मायपी के लिए लिखा गया है)। ये प्लगइन्स mypy को इन लाइब्रेरी फ़ंक्शंस का उपयोग करके अधिक सटीक रूप से निर्धारित प्रकारों और सही ढंग से कोड की जांच करने की अनुमति देते हैं। एक उदाहरण के साथ यह दिखाने के लिए, एक कोड स्निपेट पर एक नज़र डालें:

 from dataclasses import dataclass from typing import Generic, TypeVar @dataclass class TaggedVector(Generic[T]): data: List[T] tag: str position = TaggedVector([0, 0, 0], 'origin') 

ऊपर, get_class_decorator_hook() को तब परिभाषित किया जाता है जब कक्षा परिभाषित की जाती है। यह फ़ंक्शन बॉडी में __init__() सहित ऑटो-जनरेटेड तरीके जोड़ता है। Mypy इस तरह के एक कंस्ट्रक्टर का उपयोग TaggedVector[int] position के प्रकार के रूप में TaggedVector[int] सही गणना करता है। जैसा कि आप उदाहरण से देख सकते हैं, प्लगइन्स सामान्य कक्षाओं के साथ भी काम करते हैं।

यहाँ एक और कोड है:

 from contextlib import contextmanager @contextmanager def timer(title: str) -> Iterator[float]: ... with timer(9000) as tm: ... 

यहाँ get_function_hook() डेकोरेटर के लिए सटीक रिटर्न प्रकार प्रदान करता है, इसलिए एक विशेष प्रकार के अनुपालन के लिए सजाए गए फ़ंक्शन पर कॉल की जा सकती है। अब mypy त्रुटि को पहचान सकता है: timer() लिए तर्क timer() एक स्ट्रिंग होना चाहिए।

प्लगइन्स और स्टब्स का एक संयोजन

डायनेमिक पायथन फ़ंक्शंस का उपयोग करने के अलावा, बड़े एपीआई होने की समस्या में अक्सर फ्रेमवर्क चलता है। Mypy को इन पुस्तकालयों का उपयोग करने वाले कोड का परीक्षण करने के लिए पुस्तकालयों के लिए स्टब फ़ाइलों की आवश्यकता होती है (केवल यदि पुस्तकालय में अंतर्निहित एनोटेशन नहीं होते हैं, जो इतना सामान्य नहीं है)। टाइप किए गए बड़े फ्रेमवर्क के लिए स्टब्स वितरित करना एक आम बात नहीं है:

• टाइप किए गए एक अपेक्षाकृत धीमी गति से रिलीज चक्र ( mypy के साथ भेज दिया गया) है।
• अपूर्ण स्टब्स से झूठी कॉल हो सकती है, जिससे बचना बेहद मुश्किल होगा।
• विभिन्न टाइप किए गए संस्करणों से स्टब्स को न मिलाएं ।

PEP 561 में पेश किए गए स्टब पैकेज निम्नलिखित कार्य करते हैं:

• डेवलपर्स स्टब पैकेज को जितनी बार चाहें उतनी बार जारी कर सकते हैं।
• जिन उपयोगकर्ताओं ने पैकेज का उपयोग करने के लिए नहीं चुना है, वे झूठी सकारात्मक नहीं देखेंगे।
• आप कई अलग-अलग स्टब पैकेजों के मनमाने ढंग से संस्करण स्थापित कर सकते हैं।

इसके अलावा, pip आपको एक वितरण में पुस्तकालयों और संबंधित खस्ताहाल प्लग के लिए विभिन्न स्टब्स को संयोजित करने की अनुमति देता है। Mypy फ्रेमवर्क या संबंधित प्लगइन के लिए स्टब्स को आसानी से विकसित किया जा सकता है और एक वितरण में एक साथ रखा जा सकता है, जो बेहद उपयोगी है क्योंकि प्लगइन्स स्टब में गायब या गलत परिभाषाओं को भरते हैं।

इस तरह के पैकेज का नवीनतम उदाहरण SQLAlchemy स्टब्स और प्लगइन है , संस्करण 0.1 की पहली सार्वजनिक रिलीज के साथ, जिसे कुछ समय पहले PyPI पर प्रकाशित किया गया था। इस तथ्य के बावजूद कि यह परियोजना शुरुआती अल्फा संस्करण में है, हम टाइप चेकिंग में सुधार करने के लिए सुरक्षित रूप से ड्रॉपबॉक्स में इसका उपयोग कर सकते हैं। प्लगइन मूल ORM घोषणाओं को समझता है:

 from sqlalchemy.ext.declarative import declarative_base from sqlalchemy import Column, Integer, String Base = declarative_base() class User(Base): __tablename__ = 'users' id = Column(Integer, primary_key=True) name = Column(String) 

ऊपर दिए गए कोड स्निपेट में, get_dynamic_class_hook() को बताने के लिए प्लगइन get_dynamic_class_hook() का उपयोग करता है कि बेस एक मान्य आधार वर्ग है, भले ही वह ऐसा न दिखता हो। तब get_base_class_hook() को उपयोगकर्ता को परिभाषित करने के लिए कहा जाता है, और कई स्वचालित रूप से उत्पन्न विशेषताओं को जोड़ता है। अगला, हम मॉडल का एक उदाहरण बनाते हैं:

user = User(id=42, name=42)

get_function_hook() कहा जाता है, इसलिए mypy में त्रुटि दिखाई दे सकती है: उपयोगकर्ता नाम के बजाय integer मान प्राप्त होता है।

स्टब्स Column को जेनेरिक डिस्क्रिप्टर के रूप में परिभाषित करते हैं, ताकि मॉडल विशेषताओं को सही प्रकार मिलें:

 id_col = User.id # Inferred type is "Column[int]" name = user.name # Inferred type is "Optional[str]" 

हम पीआरएस का स्वागत करते हैं जो स्टब्स में अधिक सटीक प्रकार जोड़ते हैं (कोर मॉड्यूल के लिए प्रगति यहां ट्रैक की जाती है )।

प्लग पर काम करते समय हमने कुछ नुकसान खोजे हैं:

• प्रारंभिक चरण में झूठी सकारात्मकता से बचने के लिए __getattr__() का उपयोग करें जब स्टब्स पूरा नहीं होता है (यह मॉड्यूल विशेषताओं के गायब होने पर mypy त्रुटियों को रोकता है)। यदि आप किसी सबमॉडल्स के गुम होने पर __init__.py फ़ाइलों में भी इसका उपयोग कर सकते हैं।
• कस्टम एट्रिब्यूट एक्सेस के लिए डिस्क्रिप्टर्स अक्सर अधिक सटीक प्रकार की परिभाषाओं के साथ मदद करते हैं (जैसा कि हमने ऊपर समीक्षा की कॉलम उदाहरण में)। वर्णनकर्ता का उपयोग करना ठीक है, भले ही रनटाइम का वास्तविक कार्यान्वयन एक अधिक जटिल तंत्र का उपयोग करता है, उदाहरण के लिए, मेटाक्लस सहित।
• बिना किसी हिचकिचाहट के, फ्रेमवर्क वर्गों को सामान्यीकृत घोषित करें। इस तथ्य के बावजूद कि वे रनटाइम में ऐसे नहीं हैं, यह तकनीक आपको फ्रेमवर्क के कुछ तत्वों के प्रकार को अधिक सटीक रूप से निर्धारित करने की अनुमति देती है, जबकि रनटाइम त्रुटियों को आसानी से दरकिनार किया जा सकता है। (हमें उम्मीद है कि फ्रेमवर्क धीरे-धीरे जेनेरिक प्रकारों के लिए मूल समर्थन को जोड़ देगा, स्पष्ट रूप से typing.Generic से संबंधित वर्गों को विरासत में typing.Generic । typing.Generic ।)

हाल ही में जारी किए गए मैपी प्लगइन्स

लोकप्रिय पायथन फ्रेमवर्क के लिए पहले से ही कई प्लगइन्स उपलब्ध हैं। ऊपर उल्लिखित SQLAlchemy प्लगइन के अलावा, स्टब्स के साथ अन्य उल्लेखनीय नमूने पैकेज और अंतर्निहित खस्ता प्लगइन में Django और Zope इंटरफेस के लिए स्टब्स शामिल हैं। इन परियोजनाओं पर सक्रिय काम चल रहा है।

स्टब और प्लगइन पैकेज स्थापित करना और कनेक्ट करना

Mypy के लिए प्लगइन पैकेज को स्थापित करने के लिए पाइप का उपयोग करें और / या वर्चुअल वातावरण में स्टब करें जहां mypy पहले से इंस्टॉल है :

  $ pip install sqlalchemy-stubs 

Mypy स्वचालित रूप से स्थापित स्टब्स का पता लगाएगा। स्थापित प्लगइन्स को कनेक्ट करने के लिए, उन्हें सीधे mypy.ini में शामिल करें (या उपयोगकर्ता कॉन्फ़िगरेशन फ़ाइल में):

 [mypy] plugins = sqlmypy, mypy_django_plugin.main 

Mypy प्लगइन्स विकसित करना और स्टब्स लिखना

यदि आप उपयोग किए जाने वाले ढांचे के लिए स्टब्स और प्लग इन का पैकेज विकसित करना चाहते हैं, तो हम टेम्पलेट के रूप में sqlalchemy-stubs रिपॉजिटरी का उपयोग कर सकते हैं। इसमें सेटअप- setup.py , डेटा-चालित परीक्षणों का उपयोग करके अवसंरचना परीक्षण, और प्लग-इन (प्लग हुक) के लिए हुक के सेट के साथ एक उदाहरण प्लग-इन कक्षा शामिल है। हम स्टबगेन का उपयोग करने की सलाह देते हैं ताकि वे उन स्टब्स को स्वचालित रूप से उत्पन्न कर सकें जो उन्हें उपयोग करने के लिए मैपी के साथ आते हैं। Stubgen ने mypy 0.670 में mypy 0.670 सुधार किया है।

यदि आप mypy प्लगइन सिस्टम के बारे में अधिक जानना चाहते हैं तो दस्तावेज़ीकरण देखें। आप लेख में चर्चा किए गए प्लगइन्स के स्रोत कोड के लिए इंटरनेट भी खोज सकते हैं। यदि आपके कोई प्रश्न हैं, तो आप उन्हें यहाँ पूछ सकते हैं।

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