वास्तव में 'python setup.py check` क्या करता है?

Question

वास्तव में python setup.py check वास्तव में क्या करता है?

Answer 1

सबसे पहले बंद, distutils package documentation:

जांच आदेश एक पैकेज की मेटा डेटा पर कुछ परीक्षण करता है। उदाहरण के लिए, यह सत्यापित करता है कि सभी आवश्यक मेटा-डेटा setup() फ़ंक्शन पर दिए गए तर्क के रूप में प्रदान किए जाते हैं।

तो यह परीक्षण करता है कि आपने अपने मेटाडेटा को सही तरीके से भर दिया है; पाइथन पैकेज बनाते समय इसे गुणवत्ता नियंत्रण चरण के रूप में देखें।

इसके बाद, हम देख सकते हैं कि कमांड लाइन किसी भी मदद प्रदान करता है:

$ python setup.py --help-commands | grep check 
    check    perform some checks on the package 
$ python setup.py check --help 
# ... 
Options for 'check' command: 
    --metadata (-m)   Verify meta-data 
    --restructuredtext (-r) Checks if long string meta-data syntax are 
          reStructuredText-compliant 
    --strict (-s)   Will exit with an error if a check fails 

तो हम मेटाडाटा के लिए जाँच करें और reStructuredText रूप में लंबे समय विवरण सत्यापित कर सकें। उत्तरार्द्ध की आवश्यकता है आप docutils स्थापित है:

$ python setup.py check -rs 
running check 
error: The docutils package is needed. 

आप इसे स्थापित की क्या ज़रूरत है और वहाँ कोई समस्या नहीं हैं, तो स्क्रिप्ट बस चलाता है और कोई संदेश के साथ बाहर निकलता है:

$ python setup.py check -r 
running check 

लेकिन आवश्यक मेटाडेटा है अगर आप करने के लापता चेतावनी संदेश:

$ python setup.py check -r 
running check 
warning: check: missing required meta-data: url 

warning: check: missing meta-data: either (author and author_email) or (maintainer and maintainer_email) must be supplied 

जो एक त्रुटि हो जाता है, जब आपके पास -s झंडा दिया:

$ python setup.py check -rs 
running check 
warning: check: missing required meta-data: url 

warning: check: missing meta-data: either (author and author_email) or (maintainer and maintainer_email) must be supplied 

error: Please correct your package. 

डिफ़ॉल्ट रूप से, -m सक्षम किया गया है, -r और -s अक्षम हैं।

command source code भी देखें।