🤰🏿 🉐 👣 एक बड़ी परियोजना के उदाहरण पर टाइपिंग का इतिहास 👴🏽 ✈️ 🙏🏻

सभी को नमस्कार! आज मैं आपको Ostrovok.ru में एक परियोजना के उदाहरण पर टाइपिंग के विकास की कहानी बताऊंगा।

यह कहानी python3.5 में टाइपिंग प्रचार से बहुत पहले शुरू हुई, इसके अलावा, यह python2.7 में लिखे गए एक प्रोजेक्ट के अंदर शुरू हुई ।

2013 : अभी हाल ही में python3.3 का विमोचन हुआ , नए संस्करण में माइग्रेट करने का कोई मतलब नहीं था, क्योंकि इसमें कोई विशिष्ट विशेषताएं नहीं थीं , और संक्रमण के दौरान बहुत दर्द और पीड़ा होगी।

मैं Ostrovok.ru पर पार्टनर्स प्रोजेक्ट में शामिल था - यह सेवा भागीदार एकीकरण, आरक्षण, सांख्यिकी और एक व्यक्तिगत खाते से संबंधित हर चीज के लिए जिम्मेदार थी। हमने कंपनी के अन्य माइक्रोसर्विसेज के लिए दोनों आंतरिक एपीआई और हमारे सहयोगियों के लिए एक बाहरी एपीआई का उपयोग किया।

कुछ बिंदु पर, टीम ने HTTP हैंडलर या कुछ प्रकार के व्यावसायिक तर्क लिखने के लिए निम्नलिखित दृष्टिकोण का गठन किया:

1) इनपुट और आउटपुट डेटा को एक संरचना (वर्ग) द्वारा वर्णित किया जाना चाहिए,
2) संरचनाओं के उदाहरणों की सामग्री को विवरण के अनुसार मान्य किया जाना चाहिए,
3) एक फ़ंक्शन जो इनपुट पर एक संरचना लेता है और आउटपुट पर संरचना देता है, क्रमशः इनपुट और आउटपुट में डेटा प्रकारों की जांच करनी चाहिए।

मैं प्रत्येक बिंदु पर विस्तार से नहीं लिखूंगा, नीचे दिए गए उदाहरण को समझने के लिए पर्याप्त होना चाहिए कि क्या दांव पर है।

उदाहरण

।

import datetime as dt from contracts import new_contract, contract from schematics.models import Model from schematics.types import IntType, DateType # in class OrderInfoData(Model): order_id = IntType(required=True) # out class OrderInfoResult(Model): order_id = IntType(required=True) checkin_at = DateType(required=True) checkout_at = DateType(required=True) cancelled_at = DateType(required=False) @new_contract def pyOrderInfoData(x): return isinstance(x, OrderInfoData) @new_contract def pyOrderInfoResult(x): return isinstance(x, OrderInfoResult) @contract def get_order_info(data_in): """ :type data_in: pyOrderInfoData :rtype: pyOrderInfoResult """ return OrderInfoResult( dict( order_id=data_in.order_id, checkin_at=dt.datetime.today(), checkout_at=dt.datetime.today() + dt.timedelta(days=1), cancelled_at=None, ) ) if __name__ == '__main__': data_in = OrderInfoData(dict(order_id=777)) data_out = get_order_info(data_in) print(data_out.to_native())

उदाहरण पुस्तकालयों का उपयोग करता है: योजनाबद्ध और pycontracts ।

* योजनाबद्ध - डेटा का वर्णन करने और उसे मान्य करने का एक तरीका।
* pycontracts - रनटाइम में एक फ़ंक्शन के इनपुट / आउटपुट की जांच करने का एक तरीका।

यह दृष्टिकोण आपको इसकी अनुमति देता है:

परीक्षण लिखना आसान है - सत्यापन की समस्याएं उत्पन्न नहीं होती हैं, और केवल व्यावसायिक तर्क को कवर किया जाता है।
एपीआई में प्रतिक्रिया के प्रारूप और गुणवत्ता की गारंटी देने के लिए - जो हम स्वीकार करने के लिए तैयार हैं और जो हम दे सकते हैं, उसके लिए एक कठोर रूपरेखा दिखाई देती है।
प्रतिक्रिया स्वरूप को समझना / समझना आसान है यदि यह घोंसले के विभिन्न स्तरों के साथ एक जटिल संरचना है।

यह समझना महत्वपूर्ण है कि टाइप चेकिंग (गैर-सत्यापन) केवल रनटाइम में काम करता है , और यह स्थानीय विकास, सीआई में परीक्षण चलाने और एक मंचन वातावरण में एक उम्मीदवार की रिहाई की पुष्टि करने के लिए सुविधाजनक है। उत्पादन परिवेश में, इसे अक्षम किया जाना चाहिए, अन्यथा सर्वर धीमा हो जाएगा।

वर्षों बीत गए, हमारी परियोजना बढ़ी, अधिक नए और जटिल व्यावसायिक तर्क दिखाई दिए, कम से कम एपीआई हैंडल की संख्या कम नहीं हुई।

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

वास्तव में, सब कुछ काफी सरल निकला। एक परियोजना शुरू करते समय, pycontracts पुस्तकालय सभी डॉकस्ट्रिंग को पार्स करता है जो कि मेमोरी में सभी संरचनाओं को दर्ज करने के लिए @contract द्वारा कवर किया जाता है और फिर उन्हें सही ढंग से जांचता है। जब किसी प्रोजेक्ट में संरचनाओं की संख्या हजारों में होती है, तो यह पूरी चीज धीमा होने लगती है।

इसके बारे में क्या करना है? अन्य समाधानों को देखने के लिए सही उत्तर है, सौभाग्य से यार्ड में पहले से ही 2018 ( python3.5 - python3.6 ) है, और हमने पहले ही python3.6 में अपनी परियोजना को स्थानांतरित कर दिया है ।

मैंने वैकल्पिक समाधानों का अध्ययन करना शुरू किया और इस बारे में सोचा कि कैसे एक परियोजना को " pycontracts + docstring में टाइप विवरण" से "कुछ + टाइपिंग एनोटेशन में वर्णन" टाइप किया जाए । यह पता चला कि यदि आप नवीनतम संस्करण में pycontracts को अपग्रेड करते हैं, तो आप टाइपिंग एनोटेशन शैली में प्रकारों का वर्णन कर सकते हैं, उदाहरण के लिए, यह इस तरह दिख सकता है:

 @contract def get_order_info(data_in: OrderInfoData) -> OrderInfoResult: return OrderInfoResult( dict( order_id=data_in.order_id, checkin_at=dt.datetime.today(), checkout_at=dt.datetime.today() + dt.timedelta(days=1), cancelled_at=None, ) )

समस्याएँ तब शुरू होती हैं जब आपको टाइपिंग से संरचनाओं का उपयोग करने की आवश्यकता होती है, उदाहरण के लिए वैकल्पिक या संघ , क्योंकि pycontracts को यह नहीं पता है कि इसके साथ कैसे काम करें:

 from typing import Optional @contract def get_order_info(data_in: OrderInfoData) -> Optional[OrderInfoResult]: return OrderInfoResult( dict( order_id=data_in.order_id, checkin_at=dt.datetime.today(), checkout_at=dt.datetime.today() + dt.timedelta(days=1), cancelled_at=None, ) )

मैंने रनटाइम में टाइप चेकिंग के लिए वैकल्पिक पुस्तकालयों की तलाश शुरू की:

* लागू करें
* टाइपगार्ड
* पाइपीज

उस समय लागू करना python3.7 का समर्थन नहीं करता था, लेकिन हम पहले से ही अपडेट कर चुके हैं, pytypes को सिंटैक्स पसंद नहीं आया, नतीजतन, विकल्प टाइपगार्ड पर गिर गया।

 from typeguard import typechecked @typechecked def get_order_info(data_in: OrderInfoData) -> Optional[OrderInfoResult]: return OrderInfoResult( dict( order_id=data_in.order_id, checkin_at=dt.datetime.today(), checkout_at=dt.datetime.today() + dt.timedelta(days=1), cancelled_at=None, ) )

यहाँ एक वास्तविक परियोजना के उदाहरण दिए गए हैं:

 @typechecked def view( request: HttpRequest, data_in: AffDeeplinkSerpIn, profile: Profile, contract: Contract, ) -> AffDeeplinkSerpOut: ... @typechecked def create_contract( user: Union[User, AnonymousUser], user_uid: Optional[str], params: RegistrationCreateSchemaIn, account_manager: Manager, support_manager: Manager, sales_manager: Optional[Manager], legal_entity: LegalEntity, partner: Partner, ) -> tuple: ... @typechecked def get_metaorder_ids_from_ordergroup_orders( orders: Tuple[OrderGroupOrdersIn, ...], contract: Contract ) -> list: ...

नतीजतन, एक लंबी रिफैक्टिंग प्रक्रिया के बाद, हम एनोटेशन टाइपिंग + टाइपिंग के लिए प्रोजेक्ट को पूरी तरह से स्थानांतरित करने में सक्षम थे।

हमने क्या परिणाम प्राप्त किए हैं:

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

मुझे उम्मीद है कि यह लेख आपके लिए उपयोगी होगा!

संदर्भ:
* लागू करें
* टाइपगार्ड
* पाइपीज
* pycontracts
* योजनाबद्ध

एक बड़ी परियोजना के उदाहरण पर टाइपिंग का इतिहास

More articles: