डेटा कक्षाओं का परिचय

पायथन 3.7 में शुरू की गई नई विशेषताओं में से एक डेटा क्लासेस है। वे उन कक्षाओं के लिए कोड की पीढ़ी को स्वचालित करने के लिए डिज़ाइन किए गए हैं जो डेटा संग्रहीत करने के लिए उपयोग किए जाते हैं। इस तथ्य के बावजूद कि वे काम के अन्य तंत्र का उपयोग करते हैं, उनकी तुलना "डिफ़ॉल्ट मूल्यों के साथ उत्परिवर्तित ट्यूपल्स" के साथ की जा सकती है।

• पीईपी 557 - डेटा कक्षाएं
• आधिकारिक दस्तावेज

परिचय

उपरोक्त सभी उदाहरणों के लिए उनके संचालन के लिए अजगर 3.7 या उच्चतर की आवश्यकता होती है।

अधिकांश अजगर डेवलपर्स को इन वर्गों को नियमित रूप से लिखना पड़ता है:

class RegularBook: def __init__(self, title, author): self.title = title self.author = author 

पहले से ही इस उदाहरण में, अतिरेक दिखाई देता है। शीर्षक और लेखक पहचानकर्ता का उपयोग कई बार किया जाता है। वास्तविक वर्ग में ओवरराइड विधियाँ __eq__ और __eq__ भी __eq__ ।

dataclasses मॉड्यूल में @dataclass डेकोरेटर होता है। इसका उपयोग करना, एक समान कोड इस तरह दिखेगा:

 from dataclasses import dataclass @dataclass class Book: title: str author: str 

यह नोट करना महत्वपूर्ण है कि प्रकार एनोटेशन की आवश्यकता है । ऐसे सभी फ़ील्ड जिनमें टाइप मार्क्स नहीं हैं, उन्हें नज़रअंदाज़ कर दिया जाएगा। बेशक, यदि आप एक विशिष्ट प्रकार का उपयोग नहीं करना चाहते हैं, तो आप typing मॉड्यूल से Any निर्दिष्ट कर सकते हैं।

परिणामस्वरूप आपको क्या मिलता है? आप स्वचालित रूप से एक वर्ग प्राप्त करते हैं, कार्यान्वित विधियों के साथ __init__ , __eq__ , __eq__ और __eq__ । इसके अलावा, यह एक नियमित वर्ग होगा और आप इसे विरासत में ले सकते हैं या मनमाना तरीके जोड़ सकते हैं।

 >>> book = Book(title="Fahrenheit 451", author="Bradbury") >>> book Book(title='Fahrenheit 451', author='Bradbury') >>> book.author 'Bradbury' >>> other = Book("Fahrenheit 451", "Bradbury") >>> book == other True 

विकल्प

तुक या शब्दकोष

बेशक, यदि संरचना काफी सरल है, तो आप डेटा को शब्दकोश या टपल में सहेज सकते हैं:

 book = ("Fahrenheit 451", "Bradbury") other = {'title': 'Fahrenheit 451', 'author': 'Bradbury'} 

हालाँकि, इस दृष्टिकोण के नुकसान हैं:

• यह याद रखना चाहिए कि चर में इस संरचना से संबंधित डेटा शामिल हैं।
• एक शब्दकोश के मामले में, आपको चाबियों के नाम का ध्यान रखना चाहिए। शब्दकोश {'name': 'Fahrenheit 451', 'author': 'Bradbury'} ऐसे इनिशियलाइज़ेशन भी औपचारिक रूप से सही होंगे।
• टपल के मामले में, आपको मूल्यों के क्रम का ट्रैक रखना होगा, क्योंकि उनका कोई नाम नहीं है।

एक बेहतर विकल्प है:

Namedtuple

 from collections import namedtuple NamedTupleBook = namedtuple("NamedTupleBook", ["title", "author"]) 

यदि हम इस तरह से बनाए गए वर्ग का उपयोग करते हैं, तो हमें डेटा क्लास का उपयोग करने के समान व्यावहारिक रूप से मिलता है।

 >>> book = NamedTupleBook("Fahrenheit 451", "Bradbury") >>> book.author 'Bradbury' >>> book NamedTupleBook(title='Fahrenheit 451', author='Bradbury') >>> book == NamedTupleBook("Fahrenheit 451", "Bradbury")) True 

लेकिन सामान्य समानता के बावजूद, नामित टुपल्स की अपनी सीमाएं हैं। वे इस तथ्य से आते हैं कि ट्यूपल्स नाम अभी भी ट्यूपल्स हैं।

सबसे पहले, आप अभी भी विभिन्न वर्गों के उदाहरणों की तुलना कर सकते हैं।

 >>> Car = namedtuple("Car", ["model", "owner"]) >>> book = NamedTupleBook("Fahrenheit 451", "Bradbury")) >>> book == Car("Fahrenheit 451", "Bradbury") True 

दूसरा, टुपल्स नाम अपरिवर्तनीय हैं। कुछ स्थितियों में, यह उपयोगी है, लेकिन मैं अधिक लचीलापन चाहता हूं।
अंत में, आप एक नामित टपल के साथ-साथ एक नियमित रूप से काम कर सकते हैं। उदाहरण के लिए, पुनरावृति।

अन्य परियोजनाएं

यदि मानक पुस्तकालय तक सीमित नहीं है, तो आप इस समस्या के अन्य समाधान पा सकते हैं। विशेष रूप से, परियोजना संलग्न है । यह डेटासाल से भी अधिक कर सकता है और अजगर के पुराने संस्करणों जैसे 2.7 और 3.4 पर काम करता है। फिर भी, यह तथ्य कि यह मानक पुस्तकालय का हिस्सा नहीं है, असुविधाजनक हो सकता है

सृजन

डेटा वर्ग बनाने के लिए आप @dataclass डेकोरेटर का उपयोग कर सकते हैं। इस स्थिति में, वर्ग एनोटेशन के साथ परिभाषित वर्ग के सभी क्षेत्रों को परिणामी कक्षा के संबंधित तरीकों में उपयोग किया जाएगा।

एक विकल्प के रूप में, make_dataclass फ़ंक्शन है, जो नामित ट्यूपल्स बनाने के लिए समान रूप से काम करता है।

 from dataclasses import make_dataclass Book = make_dataclass("Book", ["title", "author"]) book = Book("Fahrenheit 451", "Bradbury") 

डिफ़ॉल्ट मान

एक उपयोगी विशेषता फ़ील्ड में डिफ़ॉल्ट मान जोड़ने में आसानी है। __init__ विधि को फिर से परिभाषित करने की अभी भी आवश्यकता नहीं है, बस कक्षा में सीधे मान निर्दिष्ट करें।

 @dataclass class Book: title: str = "Unknown" author: str = "Unknown author" 

उन्हें जनरेट किए गए __init__ विधि को ध्यान में रखा जाएगा

 >>> Book() Book(title='Unknown', author='Unknown author') >>> Book("Farenheit 451") Book(title='Farenheit 451', author='Unknown author') 

लेकिन नियमित कक्षाओं और विधियों के साथ, आपको म्यूट डिफॉल्ट का उपयोग करने से सावधान रहने की आवश्यकता है। यदि, उदाहरण के लिए, आपको सूची को डिफ़ॉल्ट मान के रूप में उपयोग करने की आवश्यकता है, तो एक और तरीका है, लेकिन नीचे उस पर अधिक।

इसके अलावा, उस क्रम की निगरानी करना महत्वपूर्ण है जिसमें डिफ़ॉल्ट मान वाले फ़ील्ड निर्धारित किए जाते हैं, क्योंकि यह __init__ विधि में उनके आदेश से बिल्कुल मेल खाता है

अपरिवर्तनीय डेटा क्लासेस

नामित टुपल्स के उदाहरण अपरिवर्तनीय हैं। कई स्थितियों में, यह एक अच्छा विचार है। डेटा कक्षाओं के लिए, आप यह भी कर सकते हैं। कक्षा बनाते समय केवल frozen=True पैरामीटर को निर्दिष्ट करें, और यदि आप इसके फ़ील्ड को बदलने का प्रयास करते हैं, तो एक FrozenInstanceError अपवाद को FrozenInstanceError जाएगा।

 @dataclass(frozen=True) class Book: title: str author: str 

 >>> book = Book("Fahrenheit 451", "Bradbury") >>> book.title = "1984" dataclasses.FrozenInstanceError: cannot assign to field 'title' 

डेटा क्लास सेटिंग

frozen पैरामीटर के अलावा, @dataclass डेकोरेटर में अन्य पैरामीटर हैं:

• init : अगर यह True (डिफ़ॉल्ट), तो __init__ विधि उत्पन्न होती है। यदि वर्ग में पहले से ही एक __init__ विधि परिभाषित है, तो पैरामीटर को अनदेखा किया जाता है।
• repr : __repr__ विधि के निर्माण को (डिफ़ॉल्ट रूप से) सक्षम करता है। उत्पन्न स्ट्रिंग में वर्ग का नाम और वर्ग में परिभाषित सभी क्षेत्रों का नाम और प्रतिनिधित्व होता है। इस मामले में, व्यक्तिगत क्षेत्रों को बाहर रखा जा सकता है (नीचे देखें)
• eq : __eq__ विधि के निर्माण में (डिफ़ॉल्ट रूप से) सक्षम __eq__ है। ऑब्जेक्ट्स की तुलना उसी तरह से की जाती है जैसे कि वे संबंधित फ़ील्ड मानों वाले टुपल्स थे। इसके अतिरिक्त, टाइप मिलान की जाँच की जाती है।
• order सक्षम करता है (डिफ़ॉल्ट बंद है) __lt__ , __le__ , __gt__ और __ge__ । ऑब्जेक्ट्स की तुलना उसी तरह की जाती है जैसे फील्ड वैल्यू के संबंधित ट्यूपल्स में। उसी समय, वस्तुओं का प्रकार भी जांचा जाता है। यदि order निर्दिष्ट किया गया है, लेकिन eq नहीं है, तो ValueError अपवाद को फेंक दिया जाएगा। साथ ही, वर्ग में पहले से ही तुलनात्मक तरीके शामिल नहीं होने चाहिए।
• unsafe_hash __hash__ पद्धति की पीढ़ी को प्रभावित करता है। व्यवहार मापदंडों के मूल्यों पर भी निर्भर करता है eq और frozen

व्यक्तिगत क्षेत्रों को अनुकूलित करें

अधिकांश मानक स्थितियों में, यह आवश्यक नहीं है, लेकिन फ़ील्ड फ़ंक्शन का उपयोग करके व्यक्तिगत फ़ील्ड तक डेटा वर्ग के व्यवहार को अनुकूलित करना संभव है।

परिवर्तनीय दोष

ऊपर उल्लिखित एक विशिष्ट स्थिति सूची या अन्य उत्परिवर्तनीय डिफ़ॉल्ट मानों का उपयोग है। आप पुस्तकों की एक सूची युक्त "बुकशेल्फ़" वर्ग चाह सकते हैं। यदि आप निम्नलिखित कोड चलाते हैं:

 @dataclass class Bookshelf: books: List[Book] = [] 

दुभाषिया एक त्रुटि की रिपोर्ट करेगा:

 ValueError: mutable default <class 'list'> for field books is not allowed: use default_factory 

हालांकि, अन्य परिवर्तनशील मूल्यों के लिए, यह चेतावनी काम नहीं करेगी और गलत प्रोग्राम व्यवहार को जन्म देगी।

समस्याओं से बचने के लिए, field फ़ंक्शन के default_factory पैरामीटर का उपयोग करने का सुझाव दिया गया है। इसका मान मापदंडों के बिना किसी भी वस्तु या कार्य को कहा जा सकता है।
वर्ग का सही संस्करण इस तरह दिखता है:

 @dataclass class Bookshelf: books: List[Book] = field(default_factory=list) 

अन्य विकल्प

निर्दिष्ट default_factory अलावा, फ़ील्ड फ़ंक्शन में निम्न पैरामीटर हैं:

• default : default मान। यह पैरामीटर आवश्यक है क्योंकि field को कॉल करने के लिए डिफ़ॉल्ट फ़ील्ड मान बदलता है।
• init : __init__ विधि में फ़ील्ड के उपयोग को सक्षम करता है (डिफ़ॉल्ट)
• repr : __repr__ विधि में एक फ़ील्ड के उपयोग को सक्षम करता है (डिफ़ॉल्ट)
• compare में (डिफ़ॉल्ट) तुलना विधियों में क्षेत्र का उपयोग ( __eq__ , __le__ और अन्य) शामिल हैं
• hash : एक बूलियन मूल्य या None हो सकता है। यदि यह True , तो हैश की गणना करने के लिए फ़ील्ड का उपयोग किया जाता है। यदि None (डिफ़ॉल्ट रूप से) निर्दिष्ट None , तो compare पैरामीटर के मूल्य का उपयोग किया जाता है।
  hash=False निर्दिष्ट करने के कारणों में से एक hash=False किसी दिए गए compare=True लिए hash=False compare=True क्षेत्र की हैश की गणना करने में कठिनाई हो सकती है जबकि तुलना के लिए यह आवश्यक है।
• metadata : कस्टम शब्दकोश या None । मान को MappingProxyType में लपेटा जाता है ताकि यह अपरिवर्तनीय हो जाए। यह पैरामीटर डेटा कक्षाओं द्वारा स्वयं उपयोग नहीं किया जाता है और तीसरे पक्ष के एक्सटेंशन के लिए अभिप्रेत है।

आरंभीकरण के बाद प्रसंस्करण

यदि ऑटो-जनरेट किया गया __post_init__ विधि __post_init__ पद्धति को कॉल करता है, यदि कक्षा में परिभाषित किया गया है। एक नियम के रूप में, इसे self.__post_init__() के रूप में कहा जाता है self.__post_init__() , हालांकि, अगर InitVar प्रकार के चर वर्ग में परिभाषित किए गए हैं, तो उन्हें विधि मापदंडों के रूप में पारित किया जाएगा।

यदि __init__ विधि उत्पन्न नहीं हुई है, तो __post_init__ नहीं कहा जाएगा।

उदाहरण के लिए, एक उत्पन्न पुस्तक विवरण जोड़ें

 @dataclass class Book: title: str author: str desc: str = None def __post_init__(self): self.desc = self.desc or "`%s` by %s" % (self.title, self.author) 

 >>> Book("Fareneheit 481", "Bradbury") Book(title='Fareneheit 481', author='Bradbury', desc='`Fareneheit 481` by Bradbury') 

केवल आरंभीकरण के लिए पैरामीटर

__post_init__ मेथड से जुड़ी संभावनाओं में से एक यह है कि पैरामीटर केवल आरंभीकरण के लिए उपयोग किया जाता है। यदि, किसी क्षेत्र की घोषणा करते समय, InitVar को इसके प्रकार के रूप में निर्दिष्ट करें, तो इसका मान __post_init__ विधि के पैरामीटर के रूप में पारित किया जाएगा। किसी अन्य तरीके से डेटा फ़ील्ड में ऐसे फ़ील्ड का उपयोग नहीं किया जाता है।

 @dataclass class Book: title: str author: str gen_desc: InitVar[bool] = True desc: str = None def __post_init__(self, gen_desc: str): if gen_desc and self.desc is None: self.desc = "`%s` by %s" % (self.title, self.author) 

 >>> Book("Fareneheit 481", "Bradbury") Book(title='Fareneheit 481', author='Bradbury', desc='`Fareneheit 481` by Bradbury') >>> Book("Fareneheit 481", "Bradbury", gen_desc=False) Book(title='Fareneheit 481', author='Bradbury', desc=None) 

विरासत

जब आप @dataclass डेकोरेटर का उपयोग करते हैं, तो यह ऑब्जेक्ट के साथ शुरू होने वाले सभी मूल वर्गों से होकर गुजरता है और प्रत्येक डेटा वर्ग के लिए यह खेतों को एक ऑर्डर किए गए शब्दकोश में बचाता है, फिर प्रोसेस्ड क्लास के गुणों को जोड़ता है। सभी उत्पन्न विधियाँ परिणामित शब्दकोश से फ़ील्ड का उपयोग करती हैं।

परिणामस्वरूप, यदि मूल वर्ग डिफ़ॉल्ट मानों को परिभाषित करता है, तो आपको फ़ील्ड्स को डिफ़ॉल्ट मानों के साथ परिभाषित करना होगा।

चूंकि आदेशित शब्दकोश निम्नलिखित कक्षाओं के लिए प्रविष्टि क्रम में मूल्यों को संग्रहीत करता है

 @dataclass class BaseBook: title: Any = None author: str = None @dataclass class Book(BaseBook): desc: str = None title: str = "Unknown" 

इस हस्ताक्षर के साथ एक __init__ विधि उत्पन्न की जाएगी:

 def __init__(self, title: str="Unknown", author: str=None, desc: str=None)