🤙 🤴🏽 📪 पायथन के साथ पायथन परीक्षण। प्लगइन्स अध्याय 5 🦗 🕴🏻 🙎🏿

पीछे अगला

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

इस पुस्तक में उदाहरण Python 3.6 और pytest 3.2 का उपयोग करके लिखे गए हैं। पाइस्टेस्ट 3.2 पायथन 2.6, 2.7, और पायथन 3.3+ का समर्थन करता है।

टास्क परियोजना के लिए स्रोत कोड, साथ ही साथ इस पुस्तक में दिखाए गए सभी परीक्षणों के लिए, पुस्तक के वेब पेज pragprog.com पर लिंक पर उपलब्ध है। परीक्षण कोड को समझने के लिए आपको स्रोत कोड डाउनलोड करने की आवश्यकता नहीं है; परीक्षण कोड उदाहरणों में एक सुविधाजनक रूप में प्रस्तुत किया गया है। लेकिन परियोजना के कार्यों के साथ पालन करने के लिए, या अपनी खुद की परियोजना का परीक्षण करने के लिए परीक्षण उदाहरणों को अनुकूलित करें (आपके हाथ अनटूट हो गए हैं!), आपको पुस्तक के वेब पेज पर जाना होगा और काम डाउनलोड करना होगा। वहाँ, पुस्तक के वेब पेज पर, इरेटा संदेशों और एक चर्चा मंच के लिए एक लिंक है।

स्पॉइलर के तहत इस श्रृंखला के लेखों की एक सूची है।

सामग्री की तालिका

और आगे चलते हैं!

आपको यह जानकर आश्चर्य हो सकता है कि यदि आपने इस पुस्तक में पिछले अध्यायों के माध्यम से काम किया है, तो आपने पहले से ही कुछ प्लगइन्स लिखे हैं। हर बार जब आप प्रोजेक्ट के शीर्ष-स्तरीय conftest.py फ़ाइल में जुड़नार और / या हुक फ़ंक्शन conftest.py , तो आप एक स्थानीय conftest प्लगइन बनाते हैं। इन conftest.py फाइलों को इंस्टाल करने योग्य प्लगइन्स में परिवर्तित करना केवल एक अतिरिक्त काम है, जिसे आप प्रोजेक्ट्स के साथ, अन्य लोगों के साथ या दुनिया के साथ साझा कर सकते हैं।

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

इस अध्याय में आप सीखेंगे कि प्लगइन्स कैसे बनाएं, और मैं आपको परीक्षण, पैकेजिंग और वितरण के लिए सही दिशा दिखाऊंगा। पूर्ण पायथन पैकेजिंग और वितरण विषय बहुत व्यापक है और अपनी पुस्तक होने का दावा करता है, इसलिए हम सब कुछ कवर नहीं करेंगे। लेकिन आपको अपनी टीम के साथ प्लगइन्स का आदान-प्रदान करने में सक्षम होने के लिए पर्याप्त जानकारी मिलेगी। मैं PyPI समर्थन और कम से कम काम के साथ प्लगइन्स बनाने के कुछ सरल तरीकों के बारे में भी बात करूंगा।

प्लगइन्स खोजें

आप कई जगहों पर थर्ड-पार्टी पाइस्टेस्ट प्लग इन पा सकते हैं। पृष्ठ 163 पर परिशिष्ट 3, प्लग इन सैम्पलर पैक में सूचीबद्ध प्लगइन्स, PyPI से डाउनलोड के लिए उपलब्ध हैं। हालांकि, यह महान पाइस्टेस्ट प्लगइन्स को खोजने के लिए एकमात्र स्थान नहीं है।

https://docs.pytest.org/en/latest/plugins.html

मुख्य पाइस्टेस्ट प्रलेखन साइट में एक पृष्ठ होता है जो पाइस्टेस्ट प्लगइन्स को स्थापित करने और उपयोग करने के बारे में बात करता है और कुछ सामान्य प्लगइन्स को सूचीबद्ध करता है।

https://pypi.python.org

पायथन पैकेज इंडेक्स (PyPI) बहुत सारे पायथन पैकेज प्राप्त करने के लिए एक शानदार जगह है, लेकिन पाइस्टेस्ट प्लग इन की खोज करने के लिए भी एक शानदार जगह है। पाइस्टेस्ट प्लग इन की खोज करते समय, बस "पाइस्टेस्ट," "पाइस्टेस्ट -" या "-पाइस्ट" को सर्च फील्ड में दर्ज करें, क्योंकि अधिकांश पाइस्टेस्ट प्लग इन या तो "पाइस्टेस्ट -" से शुरू होते हैं या "-पाइस्टेस्ट" के साथ समाप्त होते हैं।

https://github.com/pytest-dev

GitHub पर pytest-dev समूह वह है जहाँ pytest स्रोत कोड संग्रहीत है। इसके अलावा, यहां आप लोकप्रिय पाइस्टेस्ट प्लगइन्स पा सकते हैं, जिन्हें पाइस्टेस्ट कर्नेल टीम द्वारा लंबे समय में समर्थित होना चाहिए।

प्लगइन स्थापना

पाइस्टेस्ट प्लग को अन्य पायथन पैकेजों की तरह, पाइप के साथ स्थापित किया जाता है। हालांकि,
आप प्लगइन्स को स्थापित करने के लिए कई तरीकों से पाइप का उपयोग कर सकते हैं।

PyPI से स्थापित करें

चूंकि PyPI पाइप के लिए डिफ़ॉल्ट स्थान है, PyPI से प्लग इन स्थापित करना सबसे आसान तरीका है। आइए pytest-cov plugin इंस्टॉल करें:

 $ pip install pytest-cov

PyPI से नवीनतम स्थिर संस्करण स्थापित किया जाएगा।

PyPI से एक विशिष्ट संस्करण स्थापित करना

यदि आप प्लगइन का एक विशिष्ट संस्करण चाहते हैं, तो आप == बाद संस्करण निर्दिष्ट कर सकते हैं:

 $ pip install pytest-cov==2.4.0

.Tar.gz या .whl फ़ाइल से स्थापित करें

PyPI पैकेज को एक्सटेंशन .tar.gz और / या .whl साथ ज़िप फ़ाइलों के रूप में वितरित किया जाता है। उन्हें अक्सर टार बॉल और पहियों के रूप में जाना जाता है। यदि आपको सीधे PyPI के साथ काम करने की समस्या है (जो फ़ायरवॉल और अन्य नेटवर्क जटिलताओं के साथ हो सकती है), आप या तो .tar.gz या .whl डाउनलोड कर सकते हैं और इस या उस से इंस्टॉल कर सकते हैं।

आपको टैम्पुरीन के साथ अनपैक या नृत्य करने की आवश्यकता नहीं है; बस उस पर पाइप:

 $ pip install pytest-cov-2.4.0.tar.gz # or $ pip install pytest_cov-2.4.0-py2.py3-none-any.whl

स्थानीय निर्देशिका से स्थापना

आपके पास .tar.gz या .whl में एक स्थानीय या साझा निर्देशिका में प्लगइन्स (और अन्य पायथन पैकेज) के लिए प्लगइन्स हो सकते हैं और प्लगइन्स को स्थापित करने के लिए PyPI के बजाय इसका उपयोग कर सकते हैं:

 $ mkdir some_plugins $ cp pytest_cov-2.4.0-py2.py3-none-any.whl some_plugins/ $ pip install --no-index --find-links=./some_plugins/ pytest-cov

--no-index pip को PyPI से कनेक्ट नहीं करने के लिए कहता है। --find-links=./some_plugins/ पाइप को some_plugins निर्देशिका में देखने के लिए कहता है। यह विधि विशेष रूप से उपयोगी है यदि आपके पास स्थानीय रूप से संग्रहीत थर्ड-पार्टी और आपके स्वयं के प्लगइन्स दोनों हैं, साथ ही यदि आप निरंतर एकीकरण के लिए या विषाक्त के साथ नए आभासी वातावरण बना रहे हैं। (हम अध्याय 7 में पेज 7 पर अन्य उपकरणों के साथ पाइस्टेस्ट का उपयोग करते हुए अध्याय 7 में जहरीले और निरंतर एकीकरण के बारे में बात करेंगे।)

कृपया ध्यान दें कि स्थानीय निर्देशिका इंस्टॉलेशन विधि का उपयोग करके आप कई संस्करण स्थापित कर सकते हैं और निर्दिष्ट कर सकते हैं कि आप कौन सा संस्करण == और संस्करण संख्या जोड़कर चाहते हैं:

 $ pip install --no-index --find-links=./some_plugins/ pytest-cov==2.4.0

Git भंडार से स्थापित करें

आप इस मामले में Git रिपॉजिटरी से सीधे प्लगइन्स इंस्टॉल कर सकते हैं GitHub:

 $ pip install git+https://github.com/pytest-dev/pytest-cov

आप संस्करण टैग भी निर्दिष्ट कर सकते हैं:

 $ pip install git+https://github.com/pytest-dev/pytest-cov@v2.4.0

या आप एक शाखा निर्दिष्ट कर सकते हैं:

 $ pip install git+https://github.com/pytest-dev/pytest-cov@master

Git रिपॉजिटरी से इंस्टॉल करना विशेष रूप से उपयोगी है यदि आप Git में अपना काम संग्रहीत कर रहे हैं या यदि प्लग या प्लगइन का आवश्यक संस्करण PyPI से गायब है।

अनुवादक नोट:

पाइप Git, Mercurial, Subversion, और Bazaar से स्थापना का समर्थन करता है और url उपसर्गों का उपयोग करके VCS प्रकार को परिभाषित करता है: "git +", "hg +", "svn +", "bzr +"।
अधिक जानकारी के लिए PyPI प्रलेखन देखें।

अपने खुद के प्लगइन्स लिखना

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

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

प्लगइन मैकेनिक्स की चर्चा से व्यवहार परिवर्तनों को अलग रखने के लिए, हम इसे पुनर्वितरण प्लगइन में बदलने से पहले conftest.py में परिवर्तन करेंगे। आपको इस तरह से प्लगइन्स चलाने की आवश्यकता नहीं है। लेकिन अक्सर, केवल एक परियोजना में आपके द्वारा उपयोग किए जाने वाले परिवर्तन एक प्लगइन में साझा करने और चालू करने के लिए पर्याप्त उपयोगी होंगे। इसलिए, हम conftest.py फ़ाइल में कार्यक्षमता जोड़कर शुरू करते हैं, और फिर, conftest.py में सब कुछ काम करने के बाद, हम कोड को पैकेज में स्थानांतरित करते हैं।

वापस कार्य परियोजना के लिए। पृष्ठ 30 पर "प्रतीक्षा के लिए प्रतीक्षा" अनुभाग में, हमने कई परीक्षण लिखे जो यह जांचते हैं कि क्या अपवाद को किसी ने एपीआई फ़ंक्शन को गलत तरीके से कहा था। ऐसा लगता है कि हम कम से कम कुछ त्रुटि राज्यों को याद कर रहे हैं।

यहाँ कुछ और परीक्षण हैं:

ch5 / a / functions_proj / परीक्षण / func / test_api_exception.py

 """     API wrong.""" import pytest import tasks from tasks import Task @pytest.mark.usefixtures('tasks_db') class TestAdd(): """,   tasks.add().""" def test_missing_summary(self): """  ,  summary missing.""" with pytest.raises(ValueError): tasks.add(Task(owner='bob')) def test_done_not_bool(self): """  ,  done   bool.""" with pytest.raises(ValueError): tasks.add(Task(summary='summary', done='True'))

यदि वे पास होते हैं, तो जांच करने के लिए उन्हें चलाएं

 $ cd /path/to/code/ch5/a/tasks_proj $ pytest ===================== test session starts ====================== collected 57 items tests/func/test_add.py ... tests/func/test_add_variety.py ............................ tests/func/test_add_variety2.py ............ tests/func/test_api_exceptions.py .F....... tests/func/test_unique_id.py . tests/unit/test_task.py .... =========================== FAILURES =========================== __________________ TestAdd.test_done_not_bool __________________ self = <func.test_api_exceptions.TestAdd object at 0x103a71a20> def test_done_not_bool(self): """Should raise an exception if done is not a bool.""" with pytest.raises(ValueError): > tasks.add(Task(summary='summary', done='True')) E Failed: DID NOT RAISE <class 'ValueError'> tests/func/test_api_exceptions.py:20: Failed ============= 1 failed, 56 passed in 0.28 seconds ==============

विवरण के लिए -v के साथ इसे फिर से चलाते हैं। चूँकि आप पहले ही ट्रेस देख चुके हैं, आप इसे बंद कर सकते हैं - --tb=no ।

अब आइए -k TestAdd साथ नए परीक्षणों पर ध्यान केंद्रित करें, जो काम करता है क्योंकि "TestAdd" नाम वाले कोई अन्य परीक्षण नहीं हैं।

हम "सब कुछ छोड़ सकते हैं" और इस परीक्षण को ठीक करने की कोशिश कर सकते हैं (और हम इसे बाद में करेंगे), लेकिन अब हम डेवलपर्स के लिए विफलताओं को और अधिक सुखद बनाने की कोशिश पर ध्यान केंद्रित करेंगे।

चलिए हेडर के लिए एक धन्यवाद संदेश जोड़कर शुरू करते हैं, जिसे आप pytest_report_header() नामक एक पाइस्टेस्ट हुक के साथ कर सकते हैं।

ch5 / b / task_proj / परीक्षण / conftest.py

 def pytest_report_header(): """    .""" return "Thanks for running the tests."

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

फिर हम OPPORTUNITY for improvement F से O और FAILED को OPPORTUNITY for improvement बदलने के लिए टेस्ट स्टेटस रिपोर्ट को बदल देंगे। एक हुक है जो इस संबंध की अनुमति देता है: pytest_report_teststatus() :

ch5 / b / task_proj / परीक्षण / conftest.py

 def pytest_report_teststatus(report): """   .""" if report.when == 'call' and report.failed: return (report.outcome, 'O', 'OPPORTUNITY for improvement')

और अब हमारे पास बस वह उपाय है जिसकी हम तलाश कर रहे थे। --verbose फ़्लैग के बिना एक परीक्षण सत्र विफलताओं के लिए O दिखाता है, अर्थात, सुधार संभव हैं:

 $ cd /path/to/code/ch5/b/tasks_proj/tests/func $ pytest --tb=no test_api_exceptions.py -k TestAdd ===================== test session starts ====================== Thanks for running the tests. collected 9 items test_api_exceptions.py .O ====================== 7 tests deselected ====================== ======= 1 failed, 1 passed, 7 deselected in 0.06 seconds =======

-v या --verbose ध्वज के साथ बेहतर होगा:

 $ pytest -v --tb=no test_api_exceptions.py -k TestAdd ===================== test session starts ====================== Thanks for running the tests. collected 9 items test_api_exceptions.py::TestAdd::test_missing_summary PASSED test_api_exceptions.py::TestAdd::test_done_not_bool OPPORTUNITY for improvement ====================== 7 tests deselected ====================== ======= 1 failed, 1 passed, 7 deselected in 0.07 seconds =======

अंतिम बदलाव हम एक कमांड लाइन पैरामीटर, --nice, को जोड़ने के लिए करते हैं --nice, ताकि हमारी स्थिति में परिवर्तन तभी हो जब आप स्थानापन्न --nice : -

 def pytest_addoption(parser): """ nice    --nice.""" group = parser.getgroup('nice') group.addoption("--nice", action="store_true", help="nice: turn failures into opportunities") def pytest_report_header(): """    .""" if pytest.config.getoption('nice'): return "Thanks for running the tests." def pytest_report_teststatus(report): """   .""" if report.when == 'call': if report.failed and pytest.config.getoption('nice'): return (report.outcome, 'O', 'OPPORTUNITY for improvement')

यह ध्यान देने योग्य है कि इस प्लगइन के लिए हम केवल एक-दो हुक का उपयोग करते हैं। कई अन्य हैं जो मुख्य पाइस्टेस्ट प्रलेखन साइट पर पाए जा सकते हैं।

अब हम अपने प्लगइन को मैन्युअल रूप से अपने उदाहरण में चलाकर परीक्षण कर सकते हैं। पहला, बिना --nice विकल्प के, यह सुनिश्चित करने के लिए कि केवल उपयोगकर्ता नाम प्रदर्शित किया गया है:

 $ cd /path/to/code/ch5/c/tasks_proj/tests/func $ pytest --tb=no test_api_exceptions.py -k TestAdd ===================== test session starts ====================== collected 9 items test_api_exceptions.py .F ====================== 7 tests deselected ====================== ======= 1 failed, 1 passed, 7 deselected in 0.07 seconds =======

अब साथ - --nice :

 $ pytest --nice --tb=no test_api_exceptions.py -k TestAdd ===================== test session starts ====================== Thanks for running the tests. collected 9 items test_api_exceptions.py .O ====================== 7 tests deselected ====================== ======= 1 failed, 1 passed, 7 deselected in 0.07 seconds =======

अब साथ --nice और --verbose :

 $ pytest -v --nice --tb=no test_api_exceptions.py -k TestAdd ===================== test session starts ====================== Thanks for running the tests. collected 9 items test_api_exceptions.py::TestAdd::test_missing_summary PASSED test_api_exceptions.py::TestAdd::test_done_not_bool OPPORTUNITY for improvement ====================== 7 tests deselected ====================== ======= 1 failed, 1 passed, 7 deselected in 0.06 seconds =======

बहुत बढ़िया! सभी बदलाव जो हम करना चाहते थे, वे लगभग दस लाइनों के conftest.py फ़ाइल के लिए किए गए थे। आगे हम इस कोड को प्लगइन स्ट्रक्चर में ले जाएंगे।

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

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

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

सबसे पहले, हमें अपने प्लगइन कोड को होस्ट करने के लिए एक नई निर्देशिका बनाने की आवश्यकता है। इससे कोई फर्क नहीं पड़ता कि आप इसे क्या कहते हैं, लेकिन जब से हम अच्छे झंडे के लिए एक प्लगइन बना रहे हैं, तो हम इसे सबसे अच्छा कहते हैं। इस नई निर्देशिका में हमारे पास दो फाइलें होंगी: pytest_nice.py और setup.py। (परीक्षण सूची पृष्ठ 105 पर "टेस्ट प्लगइन्स" अनुभाग में चर्चा की जाएगी।)

 │ LICENSE │ pytest_nice.py │ setup.py │ └───tests │ conftest.py │ test_nice.py

pytest_nice.py , हम अपने conftest.py की सटीक सामग्री डालते हैं जो इस फ़ंक्शन से जुड़ी हुई थी (और इसे tasks_proj/tests/conftest.py ):

ch5 / pytest-nice / pytest_nice.py

 """  pytest-nice .""" import pytest def pytest_addoption(parser): """ nice    --nice.""" group = parser.getgroup('nice') group.addoption("--nice", action="store_true", help="nice: turn FAILED into OPPORTUNITY for improvement") def pytest_report_header(): """    .""" if pytest.config.getoption('nice'): return "Thanks for running the tests." def pytest_report_teststatus(report): """   .""" if report.when == 'call': if report.failed and pytest.config.getoption('nice'): return (report.outcome, 'O', 'OPPORTUNITY for improvement')

setup.py हमें setup() लिए सबसे न्यूनतम कॉल की आवश्यकता है setup() :

ch5 / pytest-nice / setup.py

 """Setup  pytest-nice plugin.""" from setuptools import setup setup( name='pytest-nice', version='0.1.0', description=' Pytest,   FAILURE into OPPORTUNITY', url='https:////////', author=' ', author_email='your_email@somewhere.com', license='proprietary', py_modules=['pytest_nice'], install_requires=['pytest'], entry_points={'pytest11': ['nice = pytest_nice', ], }, )

यदि आपको इसे व्यापक दर्शकों या इंटरनेट पर वितरित करने जा रहे हैं, तो आपको सेटिंग्स में अधिक जानकारी की आवश्यकता होगी। हालांकि, एक छोटी टीम के लिए या सिर्फ अपने लिए, यह काफी होगा।

आप setup() लिए कुछ अन्य पैरामीटर शामिल कर सकते हैं setup() ; और यहाँ हमारे पास केवल आवश्यक क्षेत्र हैं। संस्करण फ़ील्ड इस प्लगइन का संस्करण है। और यह पूरी तरह से आप पर निर्भर है जब आप संस्करण को लाते हैं। URL फ़ील्ड आवश्यक है। आप इसे खाली छोड़ सकते हैं, लेकिन आपको एक चेतावनी मिलेगी। author और author_email को maintainer और author_email साथ प्रतिस्थापित किया जा सकता है, लेकिन इनमें से एक जोड़ा होना चाहिए। license फ़ील्ड एक छोटा टेक्स्ट फ़ील्ड है। यह कई खुले स्रोत लाइसेंसों में से एक हो सकता है, आपका नाम या कंपनी, या आपके लिए उपयुक्त कुछ। py_modules pytest_nice को इस प्लगइन के लिए हमारे एकमात्र मॉड्यूल के रूप में सूचीबद्ध pytest_nice । हालांकि यह एक सूची है, और आप एक से अधिक मॉड्यूल शामिल कर सकते हैं, अगर मेरे पास एक से अधिक था, तो मैं पैकेज का उपयोग करूंगा और सभी मॉड्यूल को एक निर्देशिका में डालूंगा।

अब तक, सभी setup() विकल्प मानक हैं और सभी पायथन इंस्टॉलर द्वारा उपयोग किए जाते हैं। पाइस्टेस्ट प्लगइन्स के लिए अलग-अलग हिस्सा एंट्री_ entry_points पैरामीटर है। हमने entry_points={'pytest11': ['nice = pytest_nice', ], },. को सूचीबद्ध किया है entry_points={'pytest11': ['nice = pytest_nice', ], },. entry_points फ़ंक्शन entry_points लिए मानक है, लेकिन pytest11 वह विशेष पहचानकर्ता है जिसे pytest खोज रहा है। इस पंक्ति में, हम pytest को बताते हैं कि nice हमारे प्लगइन का नाम है, और pytest_nice उस मॉड्यूल का नाम है जिसमें हमारा प्लगइन रहता है। यदि हम पैकेज का उपयोग करते हैं, तो यहां हमारा प्रवेश होगा:

मैंने README.rst फ़ाइल के बारे में बात नहीं की README.rst । आरईएडीएमई का कुछ रूप सेटपूल की आवश्यकता है। यदि आप इसे याद करते हैं, तो आपको यह मिलेगा:

 ... warning: sdist: standard file not found: should have one of README, README.rst, README.txt ...

README को कुछ प्रोजेक्ट जानकारी शामिल करने के मानक तरीके के रूप में रखना वैसे भी एक अच्छा विचार है। यहाँ मैं pytest-अच्छा के लिए फ़ाइल में क्या रखा है:

ch5 / pytest-nice / README.rst

 pytest-nice : A pytest plugin =============================   pytest     .  -------- -   ,     pytest. -  ``--nice`` , : -  ``F``  ``O`` -  ``-v``,  ``FAILURE``  ``OPPORTUNITY for improvement``  ------------ ,    Pytest    .tar.gz    PATH,  : :: $ pip install PATH/pytest-nice-0.1.0.tar.gz $ pip install --no-index --find-links PATH pytest-nice  ----- :: $ pytest --nice

README फाइल में क्या होना चाहिए, इस पर कई राय हैं। यह एक भारी फसली संस्करण है, लेकिन यह काम करता है।

परीक्षण प्लगइन्स

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

Pytest-nice: conftest.py और test_nice.py लिए हमारी परीक्षण निर्देशिका में दो फाइलें हैं। pytester उपयोग करने के लिए, हमें pytester लिए केवल एक पंक्ति जोड़ने की आवश्यकता है:

ch5 / pytest-nice / परीक्षण / conftest.py

 """pytester is needed for testing plugins.""" pytest_plugins = 'pytester'

इस लाइन में pytester plugin शामिल है। हम testdir नामक एक स्थिरता का उपयोग करेंगे, जो तब उपलब्ध हो जाता है जब pytester चालू होता है।
प्लगइन्स के लिए अक्सर परीक्षण उस रूप को लेते हैं जो हमने स्वयं वर्णित किया था:

एक उदाहरण परीक्षण फ़ाइल बनाएँ।
निर्देशिका फ़ाइल में कुछ मापदंडों के साथ या उसके बिना pytest चलाएँ।
आउटपुट की जाँच करें।
संभव है, परिणाम कोड की जांच करने के लिए सभी पासों के लिए 0 है, कुछ विफलताओं के लिए 1 है।

आइए एक उदाहरण देखें:

ch5 / pytest-nice / परीक्षण / test_nice.py

 def test_pass_fail(testdir): #     Pytest testdir.makepyfile(""" def test_pass(): assert 1 == 1 def test_fail(): assert 1 == 2 """) #  pytest result = testdir.runpytest() # fnmatch_lines    result.stdout.fnmatch_lines([ '*.F', # .  Pass, F  Fail ]) # ,      '1'  testsuite assert result.ret == 1

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

हम testdir.runpytest() का उपयोग करके एक नई परीक्षण फ़ाइल के लिए पाइस्टेस्ट चलाते हैं। आप चाहें तो पैरामीटर पास कर सकते हैं। वापसी मान बाद में माना जा सकता है और RunResult प्रकार का है।

आमतौर पर मैं stdout और ret देखता हूं। , , , fnmatch_lines , , , , ret 0 1 . , fnmatch_lines , . . , , :

ch5/pytest-nice/tests/test_nice.py

 @pytest.fixture() def sample_test(testdir): testdir.makepyfile(""" def test_pass(): assert 1 == 1 def test_fail(): assert 1 == 2 """) return testdir

, , sample_test , . :

ch5/pytest-nice/tests/test_nice.py

 def test_with_nice(sample_test): result = sample_test.runpytest('--nice') result.stdout.fnmatch_lines(['*.O', ]) # . for Pass, O for Fail assert result.ret == 1 def test_with_nice_verbose(sample_test): result = sample_test.runpytest('-v', '--nice') result.stdout.fnmatch_lines([ '*::test_fail OPPORTUNITY for improvement', ]) assert result.ret == 1 def test_not_nice_verbose(sample_test): result = sample_test.runpytest('-v') result.stdout.fnmatch_lines(['*::test_fail FAILED']) assert result.ret == 1

. , :

ch5/pytest-nice/tests/test_nice.py

 def test_header(sample_test): result = sample_test.runpytest('--nice') result.stdout.fnmatch_lines(['Thanks for running the tests.']) def test_header_not_nice(sample_test): result = sample_test.runpytest() thanks_message = 'Thanks for running the tests.' assert thanks_message not in result.stdout.str()

, , .

ch5/pytest-nice/tests/test_nice.py

 def test_help_message(testdir): result = testdir.runpytest('--help') # fnmatch_lines    result.stdout.fnmatch_lines([ 'nice:', '*--nice*nice: turn FAILED into OPPORTUNITY for improvement', ])

, , , .

pytest-nice , . .zip.gz , :

 $ cd /path/to/code/ch5/pytest-nice/ $ pip install . Processing /path/to/code/ch5/pytest-nice Requirement already satisfied: pytest in /path/to/venv/lib/python3.6/site-packages (from pytest-nice==0.1.0) Requirement already satisfied: py>=1.4.33 in /path/to/venv/lib/python3.6/site-packages (from pytest->pytest-nice==0.1.0) Requirement already satisfied: setuptools in /path/to/venv/lib/python3.6/site-packages (from pytest->pytest-nice==0.1.0) Building wheels for collected packages: pytest-nice Running setup.py bdist_wheel for pytest-nice ... done ... Successfully built pytest-nice Installing collected packages: pytest-nice Successfully installed pytest-nice-0.1.0

, , :

 $ pytest -v ===================== test session starts ====================== plugins: nice-0.1.0 collected 7 items tests/test_nice.py::test_pass_fail PASSED tests/test_nice.py::test_with_nice PASSED tests/test_nice.py::test_with_nice_verbose PASSED tests/test_nice.py::test_not_nice_verbose PASSED tests/test_nice.py::test_header PASSED tests/test_nice.py::test_header_not_nice PASSED tests/test_nice.py::test_help_message PASSED =================== 7 passed in 0.34 seconds ===================

. : , . .

 platform win32 -- Python 3.6.5, pytest-3.9.3, py-1.7.0, pluggy-0.8.0 -- c:\venv36\scripts\python.exe collected 7 items tests/test_nice.py::test_pass_fail FAILED [ 14%] tests/test_nice.py::test_with_nice OPPORTUNITY for improvement [ 28%] tests/test_nice.py::test_with_nice_verbose OPPORTUNITY for improvement [ 42%] tests/test_nice.py::test_not_nice_verbose FAILED [ 57%] tests/test_nice.py::test_header PASSED [ 71%] tests/test_nice.py::test_header_not_nice PASSED [ 85%] tests/test_nice.py::test_help_message PASSED [100%] ================================== FAILURES =================================== _______________________________ test_pass_fail ________________________________

  result.stdout.fnmatch_lines([ '*.F', # . for Pass, F for Fail ])

पर

  result.stdout.fnmatch_lines([ '*.F*', # . for Pass, F for Fail ])

* F

test_with_nice , test_with_nice_verbose , test_not_nice_verbose

pytest.
c
'test_with_nice.py .O [100%]'
.
,

RemovedInPytest4Warning: usage of Session.Class is deprecated, please use pytest.Class instead

!

 (venv36) c:\_BOOKS_\pytest_si\bopytest-code\code\ch5\pytest-nice>pytest -v ============================= test session starts ============================= platform win32 -- Python 3.6.5, pytest-3.9.3, py-1.7.0, pluggy-0.8.0 -- c:\venv36\scripts\python.exe cachedir: .pytest_cache rootdir: c:\_BOOKS_\pytest_si\bopytest-code\code\ch5\pytest-nice, inifile: plugins: nice-0.1.0 collected 7 items tests/test_nice.py::test_pass_fail PASSED [ 14%] tests/test_nice.py::test_with_nice PASSED [ 28%] tests/test_nice.py::test_with_nice_verbose PASSED [ 42%] tests/test_nice.py::test_not_nice_verbose PASSED [ 57%] tests/test_nice.py::test_header PASSED [ 71%] tests/test_nice.py::test_header_not_nice PASSED [ 85%] tests/test_nice.py::test_help_message PASSED [100%] ============================== warnings summary =============================== tests/test_nice.py::test_pass_fail c:\venv36\lib\site-packages\_pytest\compat.py:332: RemovedInPytest4Warning: usage of Session.Class is deprecated, please use pytest.Class instead return getattr(object, name, default)

हुर्रे! . (pytest-nice), Python
pytest-:

 $ pip uninstall pytest-nice Uninstalling pytest-nice-0.1.0: Would remove: \path\to\venv\lib\site-packages\pytest_nice-0.1.0.dist-info\* ... Proceed (y/n)? y Successfully uninstalled pytest-nice-0.1.0

— , pytest, PyPI.

, . , setup.py :

 $ cd /path/to/code/ch5/pytest-nice $ python setup.py sdist running sdist running egg_info creating pytest_nice.egg-info ... running check creating pytest-nice-0.1.0 ... creating dist Creating tar archive ... $ ls dist pytest-nice-0.1.0.tar.gz

( , sdist source distribution — “ .”)

pytest-nice dist pytest-nice-0.1.0.tar.gz .

, , :

 $ pip install dist/pytest-nice-0.1.0.tar.gz Processing ./dist/pytest-nice-0.1.0.tar.gz ... Installing collected packages: pytest-nice Successfully installed pytest-nice-0.1.0

.tar.gz , .

pip , , , , , , .tar.gz . , pytest-nice-0.1.0.tar.gz myplugins .

pytest-nice myplugins :

 $ pip install --no-index --find-links myplugins pytest-nice

--no-index pip PyPI, , .
The --find-links myplugins tells PyPI to look in myplugins for packages to install. And of course, pytest-nice is what we want to install.
--find-links myplugins PyPI myplugins . , pytest-nice — , .

myplugins , , --upgrade :

 $ pip install --upgrade --no-index --find-links myplugins pytest-nice

pip , --no-index --find-links myplugins .

PyPI

, , . , . , , , Python Packaging .

pytest, — cookiecutter-pytest-plugin :

 $ pip install cookiecutter $ cookiecutter https://github.com/pytest-dev/cookiecutter-pytest-plugin

. , . ; , , . pytest, , .

अभ्यास

ch4/cache/test_slower.py autouse fixture, check_duration() . 4. .

pytest-slower, , , « » . 102.
, pytest-slower , .
प्लगइन के लिए कुछ परीक्षण कोड लिखें।
पायथन पैकेज इंडेक्स पर एक नज़र डालें और "पाइस्टेस्ट-" देखें। एक दिलचस्प प्लगइन खोजें जो आपको दिलचस्प लगता है।
अपनी पसंद का प्लगइन स्थापित करें और इसे कार्य परीक्षण पर आज़माएं।

आगे क्या है

आपने अब तक conftest.pyइस पुस्तक में कई बार उपयोग किया है । उदाहरण के लिए, पाइस्टेस्ट निष्पादन को प्रभावित करने वाली कॉन्फ़िगरेशन फाइलें भी हैं pytest.ini। अगले अध्याय में, आप अपने आप को विभिन्न कॉन्फ़िगरेशन फ़ाइलों से परिचित कराएँगे और यह पता लगाएंगे कि परीक्षण करते समय आप अपने जीवन को आसान बनाने के लिए क्या कर सकते हैं।

पीछे अगला

पायथन के साथ पायथन परीक्षण। प्लगइन्स अध्याय 5

और आगे चलते हैं!

प्लगइन्स खोजें

प्लगइन स्थापना

PyPI से स्थापित करें

PyPI से एक विशिष्ट संस्करण स्थापित करना

.Tar.gz या .whl फ़ाइल से स्थापित करें

स्थानीय निर्देशिका से स्थापना

Git भंडार से स्थापित करें

अपने खुद के प्लगइन्स लिखना

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

परीक्षण प्लगइन्स

PyPI

अभ्यास

आगे क्या है

More articles: