प्लगइन केस स्टडी: प्लगी – एली बेंडरस्कीची वेबसाइट

हुक परिभाषित करणे

आउट होस्ट दोन हुक परिभाषित करतो:

import pluggy

hookspec = pluggy.HookspecMarker("htmlize")

@hookspec(firstresult=True)
def htmlize_role_handler(role_name):
    """Return a function accepting role contents.

    The function will be called with a single argument - the role contents, and
    should return what the role gets replaced with.
    """
    pass

@hookspec
def htmlize_contents(post, db):
    """Return a function accepting full document contents.

    The function will be called with a single argument - the document contents
    (after paragraph splitting and role processing), and should return the
    transformed contents.
    """
    pass

कॉल करून एक हुक तयार केला जातो हुकस्पेक मार्कर प्रकल्पाच्या नावासह. या प्रकल्पाचे नाव होस्ट आणि त्याचे प्लगइन यांच्यात जुळले पाहिजे. हुक पॅरामीटर्स म्हणून काय स्वीकारतात आणि ते काय परत करतात याबद्दल प्लगी परवानगी आहे; जास्तीत जास्त लवचिकतेसाठी आणि मूळवर खरे राहण्यासाठी htmlize उदाहरणार्थ, आमचे हुक रिटर्न फंक्शन्स.

या सोबत हुकस्पेक मार्करहोस्ट देखील परिभाषित करतो a हुकिम्पलमार्कर त्याच नावाने:

hookimpl = pluggy.HookimplMarker("htmlize")

हे प्लगइन लोड झाल्यावर हुक जोडण्यासाठी वापरले जाते.

होस्टमध्ये प्लगइन लोड करत आहे

होस्टचे मुख्य फंक्शन स्टार्टअपवर खालीलप्रमाणे प्लगइन लोड करते:

pm = pluggy.PluginManager("htmlize")
pm.add_hookspecs(hookspecs)
pm.load_setuptools_entrypoints("htmlize")

हुकस्पेक्स आमचे पायथन मॉड्यूल आहे ज्यामध्ये वर दर्शविलेले हुक आहेत.
load_setuptools_entrypoints प्लगइन लोड करण्यासाठी प्लगीचा मदतनीस आहे pip-समान वातावरणात स्थापित आणि सेटअप टूल्स एंट्री पॉइंट म्हणून नोंदणीकृत. हे सिग्नल करण्याचा एक मार्ग आहे – एखाद्याच्या मध्ये setup.py किंवा pyproject.toml फाइल – काही मेटाडेटा ज्याचे प्रोजेक्ट रनटाइममध्ये पुनरावलोकन करू शकतात. आमच्या प्रकल्पात, प्लगइन या विभागात स्वतःची नोंदणी करतात pyproject.toml फाइल:

(project.entry-points.htmlize)
tt = "tt"

हे म्हणतात “प्रवेश बिंदूसाठी htmlizeनावाची नवीन नोंद परिभाषित करा tt“. प्लगीज load_setuptools_entrypoints नंतर ही माहिती ऍक्सेस करण्यासाठी importlib.metadata वापरते.

लक्षात ठेवा की प्लगीला ही यंत्रणा वापरण्याची आवश्यकता नाही. यजमान त्यांना हवी असलेली कोणतीही प्लगइन शोध पद्धत लागू करू शकतात आणि त्यांच्यामध्ये थेट प्लगइन जोडू शकतात
प्लगइन मॅनेजर सह नोंदणी करा पद्धत पण यासाठी वापरली जाणारी यंत्रणा आहे pytest आणि इतर अनेक प्रकल्प; हे स्थापित केलेले प्लगइन स्वयंचलितपणे शोधणे आणि नोंदणी करणे खूप सोपे करते pip आणि समतुल्य साधने.

प्लगइन्सची विनंती करत आहे

एकदा प्लगइन मॅनेजर प्लगइन लोड करते, त्यांना आवाहन करणे सोपे आहे; कसे ते येथे आहे htmlize सामग्री हुक आमंत्रित करते:

# Build full contents back again, and ask plugins to act on
# contents.
contents = ''.join(parts)
for handler in plugin_manager.hook.htmlize_contents(post=post, db=db):
    contents = handler(contents)
return contents

साधारणपणे, हुक इनव्होकेशन रिटर्न a यादी वेगवेगळ्या प्लगइन्सद्वारे जोडलेल्या सर्व हुकपैकी (एकाच होस्ट ऍप्लिकेशनमध्ये एकाधिक प्लगइन स्थापित केले जाऊ शकतात आणि त्याच हुकला जोडले जाऊ शकतात). जेव्हा होस्ट वर दर्शविल्याप्रमाणे हुक लावतो तेव्हा डीफॉल्ट ऑर्डर LIFO असते, परंतु प्लगइन हुक पर्यायांसह प्रभावित करू शकतात. प्रथम प्रयत्न करा आणि ट्रायलास्ट.

प्लगइनमध्ये हुक लागू करणे

येथे आमचे संपूर्ण आहे narcissist सामग्री हुकशी संलग्न असलेले प्लगइन:

import htmlize

@htmlize.hookimpl
def htmlize_contents(post, db):
    repl = f'I ({post.author})'

    def hook(contents):
        return re.sub(r'\bI\b', repl, contents)

    return hook

काही टिपा:

• अपेक्षा करतो htmlize स्थापित करणे; आधी चर्चा केल्याप्रमाणे, आम्ही Pluggy च्या डीफॉल्ट इंस्टॉल-आधारित पध्दतीवर अवलंबून आहोत जेथे होस्ट आणि प्लगइन दोन्ही एकाच Python वातावरणात स्थापित केले जातात आणि अशा प्रकारे एकमेकांना शोधू शकतात. तथापि, प्लगी कोणत्याही सानुकूल शोध पद्धतीचे समर्थन करते.
• ते वापरते हुकिमप्ल पूर्वी दर्शविलेले निर्यात मूल्य.
• हे एक फंक्शन देते जे सामग्रीवर कार्य करते; हे आहे htmlize-विशिष्ट करार (एबीआय, जर तुम्ही कराल) आम्ही आधी चर्चा केली आहे.

शोध

साधारणपणे, प्लगी शोध तर्कशास्त्र वापरकर्त्याच्या विवेकबुद्धीनुसार सोडते. त्याची
प्लगइन मॅनेजर आहे नोंदणी करा प्लगइन जोडण्याची पद्धत, आणि हे अनुप्रयोग निवडलेल्या कोणत्याही मार्गाने शोधले जाऊ शकते.

असे म्हटले आहे की, Pluggy वर दर्शविल्याप्रमाणे, Python पॅकेजिंगच्या एंट्री पॉइंट प्रक्रियेद्वारे – एक शोध यंत्रणा अंगभूत आहे. मोठ्या संख्येने ऍप्लिकेशन्ससाठी हे अत्यंत सोयीचे आहे, जोपर्यंत ऍप्लिकेशन आणि त्याचे प्लगइन दोन्ही मानक पायथन पॅकेजिंग टूल्सद्वारे स्थापित केले जातात (जे पायथन इकोसिस्टममध्ये एक अतिशय वाजवी गृहीतक आहे).

नोंदणी

एंट्री पॉइंट प्रक्रियेत, प्लगइन्स a जोडून स्वतःची नोंदणी करतात
(project.entry-points.) त्यांच्या मध्ये विभाग pyproject.toml
फाइल

अन्यथा – मागील विभागाप्रमाणे – वापरकर्ते त्यांच्या स्वतःच्या नोंदणी योजना तयार करण्यास मोकळे आहेत.

हुक

हे एक सोपे आहे, कारण ते म्हणतात हुक प्लगी भाषेतही! प्लगइन्स सेट करण्यासाठी प्लगइन्ससाठी फंक्शन डेकोरेटर्ससह, हुकची अंमलबजावणी खूपच सुंदर आहे. याचे उदाहरण आपण वर पाहिले आहे
@htmlize.hookimpl सजावट htmlize_contents.

प्लगइनवर अनुप्रयोग API उघड करणे

Pluggy हे Python होस्ट आणि Python प्लगइनसाठी डिझाइन केलेले असल्याने, हे अगदी सरळ आहे. प्लगइन्स सहसा असे गृहीत धरतात की होस्ट प्रोजेक्ट आधीपासूनच पायथन वातावरणात स्थापित केलेला आहे आणि त्याचे मॉड्यूल आयात केले जाऊ शकतात.

आमच्या उदाहरणात, हुकिमप्ल पासून आयात केले जाते htmlize हे पूर्ण करण्यासाठी प्लगइनद्वारे. हे प्लगइनवर होस्ट डेटा कसा पास केला जातो हे देखील दर्शविते – द
पोस्ट आणि db पॅरामीटर्स हे प्लगइन्सच्या वापरासाठी होस्टद्वारे उघड केलेले API आहेत.