template_ctx

नाइटली रिलीज़ · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7
यह एक कॉन्टेक्स्ट ऑब्जेक्ट है, जिसे ऐक्शन टेंप्लेट एक्सपैंशन फ़ंक्शन को पास किया जाता है.

सदस्य

args

Args template_ctx.args()

यह एक Args ऑब्जेक्ट दिखाता है. इसका इस्तेमाल, कम मेमोरी इस्तेमाल करने वाली कमांड लाइन बनाने के लिए किया जा सकता है.

declare_file

File template_ctx.declare_file(filename, *, directory)

इससे यह पता चलता है कि लागू करने पर, दी गई डायरेक्ट्री में दिए गए नाम की फ़ाइल बन जाती है.

ध्यान रखें कि फ़ाइल का एलान करने के साथ-साथ, आपको एक ऐसी कार्रवाई भी बनानी होगी जो फ़ाइल को जनरेट करे. उस कार्रवाई को बनाने के लिए, कार्रवाई के कंस्ट्रक्शन फ़ंक्शन में दिखाए गए File ऑब्जेक्ट को पास करना होगा.

पैरामीटर

पैरामीटर ब्यौरा
filename string; required
The relative path of the file within the directory.
directory फ़ाइल; ज़रूरी है
वह डायरेक्ट्री जिसमें फ़ाइल बनाई जानी चाहिए.

declare_subdirectory

File template_ctx.declare_subdirectory(subdirectory, *, directory)

इससे यह एलान किया जाता है कि लागू करने पर, दी गई डायरेक्ट्री में बताए गए नाम की एक सबडायरेक्ट्री बन जाएगी.

ध्यान रखें कि सबडायरेक्ट्री का एलान करने के साथ-साथ, आपको एक ऐसी कार्रवाई भी बनानी होगी जो सबडायरेक्ट्री को ट्रिगर करे. उस कार्रवाई को बनाने के लिए, कार्रवाई के कंस्ट्रक्शन फ़ंक्शन में दिखाए गए File ऑब्जेक्ट को पास करना होगा.

पैरामीटर

पैरामीटर ब्यौरा
subdirectory string; ज़रूरी है
डायरेक्ट्री में मौजूद सबडायरेक्ट्री का रिलेटिव पाथ.
directory File; required
वह डायरेक्ट्री जिसमें सबडायरेक्ट्री बनाई जानी चाहिए.

रन

None template_ctx.run(*, outputs, inputs=[], executable, tools=None, arguments=[], progress_message=None)

यह एक ऐसा ऐक्शन बनाता है जो किसी एक्ज़ीक्यूटेबल को चलाता है.

पैरामीटर

पैरामीटर ब्यौरा
outputs sequence of Files; ज़रूरी है
कार्रवाई की आउटपुट फ़ाइलों की सूची.
inputs sequence of Files; या depset; डिफ़ॉल्ट वैल्यू []
है कार्रवाई के इनपुट फ़ाइलों की सूची या depset.
executable File या string या FilesToRunProvider; ज़रूरी है
यह एक ऐसी एक्ज़ीक्यूटेबल फ़ाइल होती है जिसे ऐक्शन के ज़रिए कॉल किया जाता है.
tools sequence; या depset; या None; डिफ़ॉल्ट तौर पर None
होता है कार्रवाई के लिए ज़रूरी टूल की सूची या depset. टूल, ऐसे इनपुट होते हैं जिन्हें एक्ज़ीक्यूट किया जा सकता है. इनमें अपनी रनफ़ाइलें हो सकती हैं. ये रनफ़ाइलें, कार्रवाई के लिए अपने-आप उपलब्ध हो जाती हैं.

सूची में अलग-अलग तरह के ये आइटम शामिल हो सकते हैं:

  • File सेकंड
  • FilesToRunProviderइंस्टेंस
  • depsetसे File तक
ctx.executable और सूची में मौजूद FilesToRunProvider की रनफ़ाइलें अपने-आप जुड़ जाएंगी.File सभी टूल को इनपुट के तौर पर अपने-आप जोड़ दिया जाता है.

arguments sequence; डिफ़ॉल्ट तौर पर []
होता है कार्रवाई के कमांड लाइन आर्ग्युमेंट. यह स्ट्रिंग या actions.args() ऑब्जेक्ट की सूची होनी चाहिए.
progress_message string; या None; डिफ़ॉल्ट तौर पर None
है बिल्ड के दौरान उपयोगकर्ता को दिखाने के लिए प्रोग्रेस मैसेज.