अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
मॉड्यूल एक्सटेंशन का कॉन्टेक्स्ट, जिसमें हेल्पर फ़ंक्शन और डिपेंडेंसी ग्राफ़ में ज़रूरी टैग के बारे में जानकारी शामिल है. मॉड्यूल एक्सटेंशन बनाते समय, आपको implementation फ़ंक्शन में आर्ग्युमेंट के तौर पर एकModul_ctx ऑब्जेक्ट मिलता है.
सदस्य
- डाउनलोड करें
- download_and_extract
- लागू करें
- extension_metadata
- एक्सट्रैक्ट
- फ़ाइल
- getenv
- is_dev_dependency
- मॉड्यूल
- ओएस
- पाथ
- पढ़ें
- report_progress
- root_module_has_non_dev_dependency
- देखें
- कौनसा
डाउनलोड करें
unknown module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)success वाला एक स्ट्रक्चर देता है. यह एक फ़्लैग होता है, जो डाउनलोड पूरा होने पर true होता है. साथ ही, sha256 और integrity फ़ील्ड वाली फ़ाइल का हैश करता है.
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
url
|
string; या स्ट्रिंग को दोहराया जा सकता है;
ज़रूरी है एक ही फ़ाइल का रेफ़रंस देने वाले डुप्लीकेट यूआरएल की सूची. |
output
|
string; या लेबल; या पाथ;
डिफ़ॉल्ट ''है रिपॉज़िटरी डायरेक्ट्री से मिलता-जुलता आउटपुट फ़ाइल पाथ. |
sha256
|
डिफ़ॉल्ट रूप से ''है डाउनलोड की गई फ़ाइल का अनुमानित SHA-256 हैश. यह डाउनलोड की गई फ़ाइल के SHA-256 हैश से मेल खाना चाहिए. रिमोट फ़ाइलों में बदलाव हो सकता है, इसलिए SHA-256 को हटा देना सुरक्षा के लिए जोखिम हो सकता है. इस फ़ील्ड को छोड़ने से आपका बिल्ड नॉन-हर्मेटिक हो जाएगा. डेवलपमेंट को आसान बनाना ज़रूरी नहीं है. हालांकि, इसे शिपिंग से पहले सेट किया जाना चाहिए. अगर यह दिया जाता है, तो सबसे पहले दिए गए हैश वाली फ़ाइल के लिए, रिपॉज़िटरी कैश मेमोरी की जांच की जाएगी; डाउनलोड करने की कोशिश सिर्फ़ तब की जाएगी, जब कैश मेमोरी में फ़ाइल न मिले. डाउनलोड हो जाने के बाद, फ़ाइल को कैश मेमोरी में जोड़ दिया जाएगा. |
executable
|
डिफ़ॉल्ट रूप से Falseहै बनाई गई फ़ाइल पर एक्ज़ीक्यूटेबल फ़्लैग सेट करें, जो डिफ़ॉल्ट रूप से 'गलत' पर सेट होता है. |
allow_fail
|
डिफ़ॉल्ट रूप से Falseहै अगर यह नीति सेट की जाती है, तो सफल न होने वाले डाउनलोड के लिए गड़बड़ी बढ़ाने के बजाय, रिटर्न वैल्यू में गड़बड़ी बताएं |
canonical_id
|
डिफ़ॉल्ट रूप से ''है अगर यह नीति सेट की जाती है, तो कैश मेमोरी हिट को उन मामलों में सीमित करें जहां फ़ाइल को उसी कैननिकल आईडी के साथ कैश मेमोरी में जोड़ा गया था. डिफ़ॉल्ट रूप से कैश मेमोरी में चेकसम( sha256 या integrity) का इस्तेमाल किया जाता है.
|
auth
|
डिफ़ॉल्ट रूप से {}है कुछ यूआरएल के लिए, पुष्टि करने की जानकारी देने वाला ऐसा डिक्शनरी जो ज़रूरी नहीं है. |
headers
|
डिफ़ॉल्ट रूप से {}है सभी यूआरएल के लिए एचटीटीपी हेडर तय करने वाला एक वैकल्पिक लिखवाने की सुविधा. |
integrity
|
डिफ़ॉल्ट रूप से ''है सबरिसॉर्स इंटेग्रिटी फ़ॉर्मैट में, डाउनलोड की गई फ़ाइल का अनुमानित चेकसम. यह डाउनलोड की गई फ़ाइल के चेकसम से मेल खाना चाहिए. चेकसम को हटाने से सुरक्षा जोखिम हो सकता है, क्योंकि रिमोट फ़ाइलें बदल सकती हैं. इस फ़ील्ड को छोड़ने से आपका बिल्ड नॉन-हर्मेटिक हो जाएगा. डेवलपमेंट को आसान बनाना ज़रूरी नहीं है. हालांकि, इसे शिपिंग से पहले सेट किया जाना चाहिए. अगर यह दिया जाता है, तो सबसे पहले दिए गए चेकसम वाली फ़ाइल के लिए, रिपॉज़िटरी कैश मेमोरी की जांच की जाएगी; डाउनलोड करने की कोशिश सिर्फ़ तब की जाएगी, जब कैश मेमोरी में फ़ाइल न मिले. डाउनलोड हो जाने के बाद, फ़ाइल को कैश मेमोरी में जोड़ दिया जाएगा. |
block
|
डिफ़ॉल्ट रूप से Trueहै अगर 'गलत है' पर सेट किया जाता है, तो कॉल तुरंत वापस लौटता है और सामान्य रिटर्न वैल्यू के बजाय, यह एक तरीके, wai() वाले टोकन के बारे में बताता है, जो डाउनलोड पूरा होने तक ब्लॉक होता है और सामान्य रिटर्न वैल्यू दिखाता है या सामान्य वैल्यू दिखाता है. |
download_and_extract
struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})
success वाला एक स्ट्रक्चर लौटाता है, जो डाउनलोड पूरा होने पर true होता है. साथ ही, अगर सफल होता है, तो sha256 और integrity फ़ील्ड वाली फ़ाइल का हैश.
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
url
|
string; या स्ट्रिंग को दोहराया जा सकता है;
ज़रूरी है एक ही फ़ाइल का रेफ़रंस देने वाले डुप्लीकेट यूआरएल की सूची. |
output
|
string; या लेबल; या पाथ;
डिफ़ॉल्ट ''है उस डायरेक्ट्री का पाथ जहां संग्रह को अनपैक किया जाएगा. यह पाथ, रिपॉज़िटरी डायरेक्ट्री से मिलता-जुलता होगा. |
sha256
|
डिफ़ॉल्ट रूप से ''है डाउनलोड की गई फ़ाइल का अनुमानित SHA-256 हैश. यह डाउनलोड की गई फ़ाइल के SHA-256 हैश से मेल खाना चाहिए. रिमोट फ़ाइलों में बदलाव हो सकता है, इसलिए SHA-256 को हटा देना सुरक्षा के लिए जोखिम हो सकता है. इस फ़ील्ड को छोड़ने से आपका बिल्ड नॉन-हर्मेटिक हो जाएगा. डेवलपमेंट को आसान बनाना ज़रूरी नहीं है. हालांकि, इसे शिपिंग से पहले सेट किया जाना चाहिए. अगर यह दिया जाता है, तो सबसे पहले दिए गए हैश वाली फ़ाइल के लिए, रिपॉज़िटरी कैश मेमोरी की जांच की जाएगी; डाउनलोड करने की कोशिश सिर्फ़ तब की जाएगी, जब कैश मेमोरी में फ़ाइल न मिले. डाउनलोड हो जाने के बाद, फ़ाइल को कैश मेमोरी में जोड़ दिया जाएगा. |
type
|
डिफ़ॉल्ट रूप से ''है डाउनलोड की गई फ़ाइल का संग्रह टाइप. डिफ़ॉल्ट रूप से, संग्रह का टाइप, यूआरएल के फ़ाइल एक्सटेंशन से तय होता है. अगर फ़ाइल का कोई एक्सटेंशन नहीं है, तो साफ़ तौर पर "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" या ".tbz" बताएं यहां. |
stripPrefix
|
डिफ़ॉल्ट रूप से ''है निकाली गई फ़ाइलों से निकालने के लिए एक डायरेक्ट्री प्रीफ़िक्स. कई संग्रह में एक शीर्ष-स्तरीय निर्देशिका होती है जिसमें संग्रह की सभी फ़ाइलें होती हैं. build_file में, इस प्रीफ़िक्स को बार-बार बताने के बजाय, इस फ़ील्ड का इस्तेमाल करके निकाली गई फ़ाइलों से इसे हटाया जा सकता है.
|
allow_fail
|
डिफ़ॉल्ट रूप से Falseहै अगर यह नीति सेट की जाती है, तो सफल न होने वाले डाउनलोड के लिए गड़बड़ी बढ़ाने के बजाय, रिटर्न वैल्यू में गड़बड़ी बताएं |
canonical_id
|
डिफ़ॉल्ट रूप से ''है अगर यह नीति सेट की जाती है, तो कैश मेमोरी हिट को उन मामलों में सीमित करें जहां फ़ाइल को उसी कैननिकल आईडी के साथ कैश मेमोरी में जोड़ा गया था. डिफ़ॉल्ट रूप से कैश मेमोरी में चेकसम( sha256 या integrity) का इस्तेमाल किया जाता है.
|
auth
|
डिफ़ॉल्ट रूप से {}है कुछ यूआरएल के लिए, पुष्टि करने की जानकारी देने वाला ऐसा डिक्शनरी जो ज़रूरी नहीं है. |
headers
|
डिफ़ॉल्ट रूप से {}है सभी यूआरएल के लिए एचटीटीपी हेडर तय करने वाला एक वैकल्पिक लिखवाने की सुविधा. |
integrity
|
डिफ़ॉल्ट रूप से ''है सबरिसॉर्स इंटेग्रिटी फ़ॉर्मैट में, डाउनलोड की गई फ़ाइल का अनुमानित चेकसम. यह डाउनलोड की गई फ़ाइल के चेकसम से मेल खाना चाहिए. चेकसम को हटाने से सुरक्षा जोखिम हो सकता है, क्योंकि रिमोट फ़ाइलें बदल सकती हैं. इस फ़ील्ड को छोड़ने से आपका बिल्ड नॉन-हर्मेटिक हो जाएगा. डेवलपमेंट को आसान बनाना ज़रूरी नहीं है. हालांकि, इसे शिपिंग से पहले सेट किया जाना चाहिए. अगर यह दिया जाता है, तो सबसे पहले दिए गए चेकसम वाली फ़ाइल के लिए, रिपॉज़िटरी कैश मेमोरी की जांच की जाएगी; डाउनलोड करने की कोशिश सिर्फ़ तब की जाएगी, जब कैश मेमोरी में फ़ाइल न मिले. डाउनलोड हो जाने के बाद, फ़ाइल को कैश मेमोरी में जोड़ दिया जाएगा. |
rename_files
|
डिफ़ॉल्ट रूप से {}है एक्सट्रैक्शन के दौरान नाम बदलने वाली फ़ाइलों के बारे में बताने वाला एक वैकल्पिक डिक्शनरी. किसी कुंजी से पूरी तरह मेल खाने वाले नामों वाली संग्रह एंट्री का नाम बदलकर, वैल्यू के तौर पर सेट कर दिया जाएगा. ऐसा, डायरेक्ट्री प्रीफ़िक्स अडजस्टमेंट से पहले किया जाएगा. इसका इस्तेमाल, ऐसे संग्रह को एक्सट्रैक्ट करने के लिए किया जा सकता है जिनमें गैर-यूनिकोड फ़ाइल नाम होते हैं या जिनमें ऐसी फ़ाइलें होती हैं जो केस-इनसेंसिटिव फ़ाइल सिस्टम के उसी पाथ पर ले जाती हैं. |
लागू करना
exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")
timeout से तय होता है (सेकंड में, डिफ़ॉल्ट रूप से 600 सेकंड). यह तरीका, कमांड के आउटपुट वाला exec_result स्ट्रक्चर दिखाता है. environment मैप का इस्तेमाल, कुछ एनवायरमेंट वैरिएबल को बदलने के लिए किया जा सकता है, ताकि प्रोसेस को पास किया जा सके.
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
arguments
|
ज़रूरी है आर्ग्युमेंट की सूची. सबसे पहले एलिमेंट का इस्तेमाल, प्रोग्राम का पाथ होना चाहिए. |
timeout
|
डिफ़ॉल्ट रूप से 600है निर्देश की ज़्यादा से ज़्यादा अवधि सेकंड में हो सकती है (डिफ़ॉल्ट अवधि 600 सेकंड होती है). |
environment
|
डिफ़ॉल्ट रूप से {}है कुछ एनवायरमेंट वैरिएबल को प्रोसेस में पास करने के लिए ज़बरदस्ती सेट करें. |
quiet
|
डिफ़ॉल्ट रूप से Trueहै अगर stdout और stderr को टर्मिनल पर प्रिंट किया जाना चाहिए. |
working_directory
|
डिफ़ॉल्ट रूप से ""है निर्देश लागू करने के लिए, वर्किंग डायरेक्ट्री. यह रिपॉज़िटरी रूट या ऐब्सलूट के हिसाब से हो सकता है. |
extension_metadata
extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None, reproducible=False)
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
root_module_direct_deps
|
स्ट्रिंग का सीक्वेंस; या स्ट्रिंग; या None;
डिफ़ॉल्ट Noneहै डेटा स्टोर करने की उन जगहों के नाम जिन्हें एक्सटेंशन, रूट मॉड्यूल के लिए डायरेक्ट डिपेंडेंसी मानता है. अगर रूट मॉड्यूल अतिरिक्त डेटा स्टोर करने की जगह इंपोर्ट करता है या use_repo के ज़रिए ये सभी डेटा स्टोर करने की जगह इंपोर्ट नहीं करता है, तो एक्सटेंशन का आकलन होने पर Baज़ल, डेटा स्टोर करने की जगह को एक चेतावनी प्रिंट कर देगा. इसमें उपयोगकर्ता को bazel mod tidy चलाने के लिए निर्देश दिया जाएगा, ताकि वह use_repo कॉल को अपने-आप ठीक कर सके. अगर अगर
|
root_module_direct_dev_deps
|
स्ट्रिंग का सीक्वेंस; या स्ट्रिंग; या None;
डिफ़ॉल्ट Noneहै डेटा स्टोर करने की उन जगहों के नाम जिन्हें एक्सटेंशन, रूट मॉड्यूल के लिए डायरेक्ट डेवलपर डिपेंडेंसी मानता है. अगर रूट मॉड्यूल अतिरिक्त रिपॉज़िटरी इंपोर्ट करता है या use_extension(..., dev_dependency = True) के साथ बनाए गए एक्सटेंशन प्रॉक्सी पर use_repo के ज़रिए ये सभी रिपॉज़िटरी इंपोर्ट नहीं करता है, तो एक्सटेंशन का आकलन होने पर Basel एक चेतावनी प्रिंट कर देगा. साथ ही, उपयोगकर्ता को use_repo कॉल को अपने-आप ठीक करने के लिए bazel mod tidy चलाने के लिए निर्देश देगा. अगर
|
reproducible
|
bool;
डिफ़ॉल्ट रूप से Falseहै यह बताता है कि यह मॉड्यूल एक्सटेंशन पूरी तरह से दोबारा बनाया जा सकता है. इसलिए, इसे लॉकफ़ाइल में सेव नहीं किया जाना चाहिए. |
निकालें
None module_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
archive
|
string; या लेबल; या पाथ;
ज़रूरी है का पाथ, रिपॉज़िटरी डायरेक्ट्री से मिलता-जुलता है. इसे पैक नहीं किया जाएगा. |
output
|
string; या लेबल; या पाथ;
डिफ़ॉल्ट ''है उस डायरेक्ट्री का पाथ जहां संग्रह को अनपैक किया जाएगा. यह पाथ, रिपॉज़िटरी डायरेक्ट्री से मिलता-जुलता होगा. |
stripPrefix
|
डिफ़ॉल्ट रूप से ''है निकाली गई फ़ाइलों से निकालने के लिए एक डायरेक्ट्री प्रीफ़िक्स. कई संग्रह में एक शीर्ष-स्तरीय निर्देशिका होती है जिसमें संग्रह की सभी फ़ाइलें होती हैं. build_file में, इस प्रीफ़िक्स को बार-बार बताने के बजाय, इस फ़ील्ड का इस्तेमाल करके निकाली गई फ़ाइलों से इसे हटाया जा सकता है.
|
rename_files
|
डिफ़ॉल्ट रूप से {}है एक्सट्रैक्शन के दौरान नाम बदलने वाली फ़ाइलों के बारे में बताने वाला एक वैकल्पिक डिक्शनरी. किसी कुंजी से पूरी तरह मेल खाने वाले नामों वाली संग्रह एंट्री का नाम बदलकर, वैल्यू के तौर पर सेट कर दिया जाएगा. ऐसा, डायरेक्ट्री प्रीफ़िक्स अडजस्टमेंट से पहले किया जाएगा. इसका इस्तेमाल, ऐसे संग्रह को एक्सट्रैक्ट करने के लिए किया जा सकता है जिनमें गैर-यूनिकोड फ़ाइल नाम होते हैं या जिनमें ऐसी फ़ाइलें होती हैं जो केस-इनसेंसिटिव फ़ाइल सिस्टम के उसी पाथ पर ले जाती हैं. |
watch_archive
|
डिफ़ॉल्ट रूप से 'auto'है क्या संग्रहित फ़ाइल को देखना है. यह स्ट्रिंग 'हां', 'नहीं' या 'ऑटो' स्ट्रिंग हो सकती है. 'हां' पास हो रहा है watch() तरीके को तुरंत इस्तेमाल करने के बराबर है; 'नहीं' में पास फ़ाइल को देखने की कोशिश नहीं करता हो; 'ऑटो' पास हो रहा है फ़ाइल को देखने की कोशिश सिर्फ़ तब की जाएगी, जब ऐसा करना कानूनी होगा. ज़्यादा जानकारी के लिए, watch() दस्तावेज़ देखें.
|
फ़ाइल
None module_ctx.file(path, content='', executable=True, legacy_utf8=True)पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
path
|
string; या लेबल; या पाथ;
ज़रूरी है रिपॉज़िटरी डायरेक्ट्री के हिसाब से, फ़ाइल बनाने का पाथ. |
content
|
डिफ़ॉल्ट रूप से ''है फ़ाइल की सामग्री बनाने के लिए, डिफ़ॉल्ट रूप से खाली होती है. |
executable
|
डिफ़ॉल्ट रूप से Trueहै बनाई गई फ़ाइल पर एक्ज़ीक्यूटेबल फ़्लैग को डिफ़ॉल्ट रूप से सही पर सेट करें. |
legacy_utf8
|
डिफ़ॉल्ट रूप से Trueहै फ़ाइल के कॉन्टेंट को UTF-8 में एन्कोड करें. यह डिफ़ॉल्ट रूप से सही होता है. आने वाले समय में डिफ़ॉल्ट सेटिंग, इस पैरामीटर को हटा देगी. |
गेटेनव
string module_ctx.getenv(name, default=None)
name का मान स्ट्रिंग के रूप में दिखाता है. अगर ऐसा नहीं है, तो यह default दिखाता है.अगर वैरिएबल की वैल्यू को बढ़ाया जाता है, तो name के नाम वाले वैरिएबल की वैल्यू में कोई भी बदलाव करने पर, डेटा स्टोर करने की इस जगह को फिर से फ़ेच किया जाएगा.
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
name
|
string;
ज़रूरी है पसंदीदा एनवायरमेंट वैरिएबल का नाम |
default
|
string; या None;
डिफ़ॉल्ट रूप से Noneहै `नाम` नहीं मिलने पर, डिफ़ॉल्ट वैल्यू दिखती है |
None को वापस किया जा सकता है.
is_dev_dependency
bool module_ctx.is_dev_dependency(tag)
devDependency = True के साथ use_extension कॉल के नतीजे में तय हुआ था या नहीं.
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
tag
|
bazel_module_tag;
ज़रूरी है bazel_module.tags से मिला टैग. |
मॉड्यूल
list module_ctx.modules
os
repository_os module_ctx.os
पाथ
path module_ctx.path(path)
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
path
|
string; या लेबल; या पाथ;
ज़रूरी है वह स्ट्रिंग, लेबल या पाथ जिससे पाथ बनाना है |
पढ़ा गया
string module_ctx.read(path, *, watch='auto')
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
path
|
string; या लेबल; या पाथ;
ज़रूरी है जिस फ़ाइल से पढ़ना है उसका पाथ. |
watch
|
डिफ़ॉल्ट रूप से 'auto'है तय करें कि फ़ाइल देखनी है या नहीं. यह स्ट्रिंग 'हां', 'नहीं' या 'ऑटो' स्ट्रिंग हो सकती है. 'हां' पास हो रहा है watch() तरीके को तुरंत इस्तेमाल करने के बराबर है; 'नहीं' में पास फ़ाइल को देखने की कोशिश नहीं करता हो; 'ऑटो' पास हो रहा है फ़ाइल को देखने की कोशिश सिर्फ़ तब की जाएगी, जब ऐसा करना कानूनी होगा. ज़्यादा जानकारी के लिए, watch() दस्तावेज़ देखें.
|
report_progress
None module_ctx.report_progress(status='')पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
status
|
string;
डिफ़ॉल्ट रूप से ''है फ़ेच करने की प्रोसेस की मौजूदा स्थिति के बारे में जानकारी देने वाली स्ट्रिंग |
root_module_has_non_dev_dependency
bool module_ctx.root_module_has_non_dev_dependency
देखें
None module_ctx.watch(path)"बदलाव" फ़ाइल की सामग्री में बदलाव शामिल करना होगा (अगर पाथ एक फ़ाइल है); अगर पाथ एक फ़ाइल था, लेकिन अब यह डायरेक्ट्री है या अगर पाथ एक फ़ाइल है, लेकिन अब यह डायरेक्ट्री है; और पाथ मौजूदा से शुरू या बंद होता है. ध्यान दें, अगर पाथ एक डायरेक्ट्री है, तो इसमें डायरेक्ट्री के तहत आने वाली किसी भी फ़ाइल में किए गए बदलाव शामिल नहीं होते. इसके लिए, path.readdir() का इस्तेमाल करें.
ध्यान दें कि इस समय फ़ेच किए जा रहे रेपो या मौजूदा मॉड्यूल एक्सटेंशन की काम करने वाली डायरेक्ट्री के अंदर पाथ को देखने की कोशिश करने पर गड़बड़ी हो सकती है. मौजूदा बेज़ल फ़ाइल फ़ोल्डर के बाहर पाथ देखने की कोशिश करने वाले मॉड्यूल एक्सटेंशन की वजह से भी गड़बड़ी हो सकती है.
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
path
|
string; या लेबल; या पाथ;
ज़रूरी है देखने के लिए फ़ाइल का पाथ. |
कौनसा
path module_ctx.which(program)
पैरामीटर
| पैरामीटर | ब्यौरा |
|---|---|
program
|
ज़रूरी है पाथ में ढूंढने के लिए प्रोग्राम करें. |
None को वापस किया जा सकता है.