थोड़ा और प्रतिबिंब जोड़ें: सज्जाकार

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

कटौती के तहत, समस्या को हल करने के लिए अपनी स्वयं की विधि है, जिसके परिणामस्वरूप एक छोटा पुस्तकालय सामान्य उपयोग के लिए उपलब्ध है।

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

हालांकि, ध्यान में रखने के लिए कुछ नियम हैं। निर्मित डेकोरेटर्स को पंजीकृत करने से काम नहीं चलेगा। यही है, दुर्भाग्यवश, @staticmethod , @classmethod और जैसे सज्जाकार ट्रैक नहीं कर पाएंगे (यदि कोई इस समस्या का समाधान पा सकता है, तो मैं बहुत आभारी रहूंगा)। और सबसे महत्वपूर्ण बात, सजावट करने वालों को उनका उपयोग करने से पहले पंजीकृत होना चाहिए।

वास्तव में, रजिस्ट्री के यांत्रिकी काफी सरल हैं। डेकोरेटर का पंजीकरण करके, आपको वास्तव में एक सजाया हुआ स्रोत डेकोरेटर मिलता है, जो अपनी मूल कार्यक्षमता के अलावा, फ़ंक्शन के "__annotations__" विशेषता के बारे में भी जानकारी लिखता है।

यदि एक फ़ंक्शन (या विधि) को कई डेकोरेटर्स के साथ सजाया गया है, तो उनका उपयोग करने से पहले सभी डेकोरेटर्स को पंजीकृत करना महत्वपूर्ण है और सभी डेकोरेटर्स को सही तरीके से ध्यान में रखा जाएगा। यह है कि, फार्म का एक डिजाइन:

 @decorator_one @decorator_two @decorator_three def some_function(): pass 

सफलतापूर्वक काम करेगा।

"रेग" लाइब्रेरी (जैसा कि मैंने इसे कहा था) पायथन 2.x और संस्करण 3.x दोनों के साथ संगत है (हम अपनी परियोजनाओं पर दोनों शाखाओं का उपयोग करते हैं, इसलिए संगतता की जांच की गई थी)।

गितुब पर स्रोत उपलब्ध हैं, लाइसेंस, हमेशा की तरह, एमआईटी है, इसलिए आप जो चाहें करें।

प्रलेखन यहाँ है ।

आप इसे केवल PyPI के माध्यम से स्थापित कर सकते हैं:

 $ pip install regd 

नीचे कार्यक्षमता के बारे में कुछ शब्द दिए गए हैं।

1. सज्जाकारों का पंजीकरण।

अलग-अलग तरीकों का उपयोग करके साधारण और पैरामीटर वाले डेकोरेटर पंजीकृत होने चाहिए:

 from regd import DecoratorRegistry as dreg #  ""  simple_decorator = dreg.decorator( mydecorator) #  ""  param_decorator = dreg.parametrized_decorator( param_decorator) 

2. प्रतिबिंब एपीआई

API फ़ंक्शन को अधिक समझने के लिए, आइए पहले एक साधारण डेकोरेटर बनाएं और पंजीकृत करें, जो वास्तव में कुछ भी नहीं करता है, लेकिन बस मौजूद है।

 from regd import DecoratorRegistry as dreg #   def mydecorator( fn) : #    -  ... def wrapper( *args, **kwargs) # ...   -  ... return fn( *args, **kwargs) return wrapper #    mydecorator = dreg.decorator( mydecorator) 

याद रखें - आपको सजाने से पहले सज्जाकारों को पंजीकृत करने की आवश्यकता है ।

अब, पंजीकरण के बाद, हम हमेशा की तरह अपने डेकोरेटर का उपयोग कर सकते हैं:

 @mydecorator def myfunc() : pass 

अब, किसी भी समय, कोड में कहीं से भी, हम यह पता लगा सकते हैं कि फ़ंक्शन डेकोरेटर द्वारा सजाया गया है या नहीं:

 print( dreg.is_decorated_with( myfunc, mydecorator)) 

कुछ और उपयोगी तरीके:

• all_decorated_module_functions( module, exclude_methods=False, exclude_functions=False) - आपको दिए गए मॉड्यूल में पंजीकृत डेकोरेटर्स द्वारा सजाए गए वर्गों के सभी कार्यों और / या तरीकों को प्राप्त करने की अनुमति देता है।
• module_functions_decorated_with( module, decorator, exclude_methods=False, exclude_functions=False) - आपको दिए गए मॉड्यूल में दिए गए डेकोरेटर द्वारा सजाए गए वर्गों के सभी कार्यों और / या तरीकों को प्राप्त करने की अनुमति देता है।
• decorated_methods( cls, decorator) methods decorated_methods( cls, decorator) - हमें दिए गए डेकोरेटर द्वारा सजे वर्ग / वस्तु के सभी तरीके मिलते हैं
• get_decorators( fn) - दिए गए फ़ंक्शन / विधि के लिए सभी ज्ञात डेकोरेटर्स की सूची लौटाएगा
• get_real_function( fn) - मूल फ़ंक्शन का लिंक लौटाएगा, जिसे डेकोरेटर्स द्वारा सजाया गया था (हां, आप मूल फ़ंक्शन तक पहुंच सकते हैं और सजावट को दरकिनार भी कर सकते हैं)
• is_decorated_with( fn, decorator) - चेक करता है कि दिए गए फ़ंक्शन को दिए गए डेकोरेटर द्वारा is_decorated_with( fn, decorator) गया है या नहीं

मुझे आशा है कि कोई काम आता है या उपयोगी लगता है। सभी टिप्पणियों और सुझावों का स्वागत है।