प्रोटोकॉल बफ़र के नियम

किसी समस्या की शिकायत करें सोर्स देखें Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

नियम

cc_proto_library

नियम का सोर्स देखें 
cc_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

cc_proto_library, .proto फ़ाइलों से C++ कोड जनरेट करता है.

deps, proto_library नियमों पर ले जाना चाहिए.

उदाहरण: 


cc_library(
    name = "lib",
    deps = [":foo_cc_proto"],
)

cc_proto_library(
    name = "foo_cc_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
deps

लेबल की सूची; डिफ़ॉल्ट [] है

C++ कोड जनरेट करने के लिए, proto_library नियमों की सूची.

java_lite_proto_library

नियम का सोर्स देखें 
java_lite_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_lite_proto_library, .proto फ़ाइलों से Java कोड जनरेट करता है.

deps, proto_library नियमों पर ले जाना चाहिए.

उदाहरण: 


java_library(
    name = "lib",
    runtime_deps = [":foo"],
)

java_lite_proto_library(
    name = "foo",
    deps = [":bar"],
)

proto_library(
    name = "bar",
)

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
deps

लेबल की सूची; डिफ़ॉल्ट [] है

Java कोड जनरेट करने के लिए, proto_library नियमों की सूची.

java_proto_library

नियम का सोर्स देखें 
java_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

java_proto_library, .proto फ़ाइलों से Java कोड जनरेट करता है.

deps, proto_library नियमों पर ले जाना चाहिए.

उदाहरण: 


java_library(
    name = "lib",
    runtime_deps = [":foo_java_proto"],
)

java_proto_library(
    name = "foo_java_proto",
    deps = [":foo_proto"],
)

proto_library(
    name = "foo_proto",
)

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
deps

लेबल की सूची; डिफ़ॉल्ट [] है

Java कोड जनरेट करने के लिए, proto_library नियमों की सूची.

proto_library

नियम का सोर्स देखें 
proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, toolchains, visibility)

अगर Bazel का इस्तेमाल किया जा रहा है, तो कृपया नियम को https://github.com/bazelbuild/rules_proto से लोड करें.

प्रोटोकॉल बफ़र की लाइब्रेरी तय करने के लिए proto_library का इस्तेमाल करें. इनका इस्तेमाल कई भाषाओं में किया जा सकता है. proto_library को इस्तेमाल किए जा सकने वाले नियमों के deps क्लॉज़ में शामिल किया जा सकता है, जैसे कि java_proto_library.

कमांड-लाइन पर कंपाइल करने पर, proto_library foo-descriptor-set.proto.bin नाम की एक फ़ाइल बनाता है. यह फ़ाइल, नियम के सोर्स मैसेज के लिए डिस्क्रिप्टर सेट होती है. यह फ़ाइल, क्रम से लगाई गई वैल्यू वाली एक FileDescriptorSet फ़ाइल है. इस बारे में ज़्यादा जानकारी के लिए, https://developers.google.com/protocol-buffers/docs/techniques#self-description पर जाएं.

इसमें सिर्फ़ उन .proto फ़ाइलों की जानकारी होती है जिनके बारे में proto_library नियम में सीधे तौर पर बताया गया हो. ट्रांज़िटिव डिस्क्रिप्टर सेट का कलेक्शन, [ProtoInfo].transitive_descriptor_sets Starlark प्रोवाइडर की मदद से उपलब्ध होता है. proto_info.bzl में दस्तावेज़ देखें.

कोड के लिए सुझाया गया स्ट्रक्चर:

  • हर .proto फ़ाइल के लिए एक proto_library नियम.
  • foo.proto नाम की फ़ाइल, foo_proto नाम के नियम में होगी, जो एक ही पैकेज में मौजूद है.
  • foo_proto नाम वाले proto_library को रैप करने वाले [language]_proto_library को foo_[language]_proto कहा जाना चाहिए. साथ ही, यह एक ही पैकेज में होना चाहिए.

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
deps

लेबल की सूची; डिफ़ॉल्ट [] है

proto_library के अन्य नियमों की सूची, जिन पर टारगेट निर्भर करता है. proto_library सिर्फ़ दूसरे proto_library टारगेट पर निर्भर हो सकता है. ऐसा हो सकता है कि यह भाषा के हिसाब से लाइब्रेरी पर निर्भर न हो.
srcs

लेबल की सूची; डिफ़ॉल्ट [] है

टारगेट बनाने के लिए प्रोसेस की गई .proto और .protodevel फ़ाइलों की सूची. आम तौर पर, यह सूची खाली नहीं होती. अन्य नाम वाली लाइब्रेरी एक ऐसा उदाहरण है जहां srcs खाली हो सकता है. यह एक ऐसा प्रोटो_लाइब्रेरी नियम है जिसमें deps में एक या एक से ज़्यादा अन्य प्रोटो_लाइब्रेरी हैं. इस पैटर्न का इस्तेमाल, किसी सार्वजनिक एपीआई को किसी ऐसे नाम से एक्सपोर्ट करने के लिए किया जा सकता है जो हमेशा मौजूद रहता है.
allow_exports

लेबल; डिफ़ॉल्ट None है

यह एक वैकल्पिक अनुमति वाली सूची है. इससे, प्रोटो लाइब्रेरी को फिर से एक्सपोर्ट करने या सूची में शामिल किसी पैकेज में मौजूद न होने वाली lang_proto_library में इस्तेमाल करने से रोका जा सकता है.
exports

लेबल की सूची; डिफ़ॉल्ट [] है

proto_library टारगेट की सूची, जिन्हें proto सोर्स में "import public" के ज़रिए रेफ़र किया जा सकता है. अगर "import public" का इस्तेमाल किया जाता है, लेकिन एक्सपोर्ट एट्रिब्यूट में उससे जुड़ी लाइब्रेरी की सूची नहीं दी जाती है, तो गड़बड़ी होती है. ध्यान दें कि आपने लाइब्रेरी को डिपेंडेंसी और एक्सपोर्ट, दोनों में शामिल किया है, क्योंकि अब तक सभी lang_proto_library लागू नहीं किए गए हैं.
import_prefix

स्ट्रिंग; डिफ़ॉल्ट रूप से ""

इस नियम में .proto फ़ाइलों के पाथ में जोड़ने के लिए प्रीफ़िक्स.

सेट होने पर, इस नियम के srcs एट्रिब्यूट में मौजूद .proto सोर्स फ़ाइलों को, इस एट्रिब्यूट की वैल्यू पर ऐक्सेस किया जा सकता है. यह वैल्यू, उनकी रिपॉज़िटरी के हिसाब से तय किए गए पाथ के आगे जोड़ी जाती है.

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

strip_import_prefix

स्ट्रिंग; डिफ़ॉल्ट रूप से "/"

इस नियम में, .proto फ़ाइलों के पाथ से हटाने के लिए प्रीफ़िक्स.

सेट होने पर, इस नियम के srcs एट्रिब्यूट में मौजूद .proto सोर्स फ़ाइलों को, उनके पाथ पर ऐक्सेस किया जा सकता है. हालांकि, इस पाथ से प्रीफ़िक्स हटा दिया जाता है.

अगर यह कोई रिलेटिव पाथ है (स्लैश से शुरू नहीं होता), तो इसे पैकेज के हिसाब से रिलेटिव पाथ माना जाता है. अगर यह ऐब्सलूट पाथ है, तो इसे रिपॉज़िटरी से रिलेटिव पाथ माना जाता है.

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

py_proto_library

नियम का सोर्स देखें 
py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
 `.proto` फ़ाइलों से Python लाइब्रेरी जनरेट करने के लिए, `py_proto_library` का इस्तेमाल करें. आम तौर पर, `py_proto_library` नियम को `foo_py_pb2` नाम दिया जाता है, जब वह `proto_library` नियम `foo_proto` को रैप कर रहा हो. `deps` को `proto_library` नियम पर ले जाना चाहिए. उदाहरण: ```starlark py_library( name = "lib", deps = [":foo_py_pb2"], ) py_proto_library( name = "foo_py_pb2", deps = [":foo_proto"], ) proto_library( name = "foo_proto", srcs = ["foo.proto"], ) ```

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
deps

लेबल की सूची; डिफ़ॉल्ट [] है

Python लाइब्रेरी जनरेट करने के लिए, `proto_library` नियमों की सूची. आम तौर पर, यह सिर्फ़ एक टारगेट होता है: आपकी पसंद की प्रोटो लाइब्रेरी. यह `ProtoInfo` उपलब्ध कराने वाला कोई भी टारगेट हो सकता है.

proto_lang_toolchain

नियम का सोर्स देखें 
proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

अगर Bazel का इस्तेमाल किया जा रहा है, तो कृपया नियम को https://github.com/bazelbuild/rules_proto से लोड करें.

इससे पता चलता है कि LANG_proto_library नियम (उदाहरण के लिए, java_proto_library) को प्रोटो-कंपाइलर को कॉल करना चाहिए. LANG_proto_library के कुछ नियमों की मदद से, कमांड-लाइन फ़्लैग का इस्तेमाल करके यह तय किया जा सकता है कि किस टूलचेन का इस्तेमाल करना है. इसके लिए, उनके दस्तावेज़ देखें.

आम तौर पर, आपको इस तरह के नियम तब तक नहीं लिखने चाहिए, जब तक कि आपको अपने Java कंपाइलर को बेहतर नहीं बनाना है.

कोई कंपाइलर नहीं है. प्रोटो-कंपाइलर को proto_library नियम से लिया जाता है, जिसे हम अटैच करते हैं. इसे Blaze को कमांड-लाइन फ़्लैग के तौर पर पास किया जाता है. कई सुविधाओं के लिए, proto_library नियम पर प्रोटो-कंपाइलर को लागू करना ज़रूरी है. LANG_proto_library और proto_library, दोनों एक ही कंपाइलर का इस्तेमाल करते हैं.

उदाहरण

इसका एक आसान उदाहरण यह है: 


proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
allowlist_different_package

लेबल; डिफ़ॉल्ट None है
blacklisted_protos

लेबल की सूची; डिफ़ॉल्ट [] है

blacklisted_protos के srcs एट्रिब्यूट में मौजूद फ़ाइलों के लिए कोई कोड जनरेट नहीं किया जाएगा. इसका इस्तेमाल उन .proto फ़ाइलों के लिए किया जाता है जो पहले से ही any.proto जैसे प्रोटो रनटाइम से लिंक होती हैं.
command_line

स्ट्रिंग; ज़रूरी है

कोड जनरेट करने के लिए, यह वैल्यू प्रोटो-कंपाइलर को भेजी जाएगी. सिर्फ़ इस कोड-जनरेटर/प्लग इन के लिए खास हिस्से शामिल करें (उदाहरण के लिए, -I पैरामीटर शामिल न करें)
  • $(OUT), LANG_proto_library के हिसाब से होता है. नियमों से यह तय होना चाहिए कि वे इस वैरिएबल का विश्लेषण कैसे करते हैं. उदाहरण के लिए, Java के लिए, $(OUT) को बनाए जाने वाले src-jar फ़ाइल नाम से बदल दिया जाएगा.
mnemonic

स्ट्रिंग; डिफ़ॉल्ट रूप से "GenProto"

यह वैल्यू, protoc ऐक्शन पर मेनिमोनिक के तौर पर सेट की जाएगी.
output_files

स्ट्रिंग; डिफ़ॉल्ट रूप से "legacy"

यह कंट्रोल करता है कि command_line में $(OUT) को कैसे फ़ॉर्मैट किया जाए. इसके लिए, एक फ़ाइल के पाथ या एक से ज़्यादा फ़ाइलों के मामले में आउटपुट डायरेक्ट्री का इस्तेमाल किया जाता है. संभावित वैल्यू: "single", "multiple".
plugin

लेबल; डिफ़ॉल्ट None है

अगर यह पैरामीटर दिया गया है, तो इसे प्रोटो-कंपाइलर को कॉल करने वाले ऐक्शन के लिए उपलब्ध कराया जाएगा. साथ ही, इसे प्रोटो-कंपाइलर को पास किया जाएगा: --plugin=protoc-gen-PLUGIN=<executable>.
plugin_format_flag

स्ट्रिंग; डिफ़ॉल्ट रूप से ""

अगर यह वैल्यू दी जाती है, तो प्लग इन का इस्तेमाल करने के लिए, यह वैल्यू प्रोटो-कंपाइलर को भेज दी जाएगी. वैल्यू में एक %s होना चाहिए, जिसे प्लग इन के लिए एक्सीक्यूटेबल फ़ाइल से बदल दिया जाता है. --plugin=protoc-gen-PLUGIN=<executable>.
progress_message

स्ट्रिंग; डिफ़ॉल्ट रूप से "Generating proto_library %{label}"

यह वैल्यू, प्रोटोकॉल ऐक्शन पर प्रोग्रेस मैसेज के तौर पर सेट की जाएगी.
protoc_minimal_do_not_use

लेबल; डिफ़ॉल्ट None है
runtime

लेबल; डिफ़ॉल्ट None है

भाषा के हिसाब से लाइब्रेरी, जिससे जनरेट किया गया कोड कंपाइल किया जाता है. LANG_proto_library के हिसाब से, बिहेवियर अलग-अलग होता है. उदाहरण के लिए, Java को रनटाइम के हिसाब से कंपाइल करना चाहिए.
toolchain_type

लेबल; डिफ़ॉल्ट None है

proto_toolchain

नियम का सोर्स देखें 
proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

तर्क

विशेषताएं
name

नाम; यह ज़रूरी है

इस टारगेट के लिए यूनीक नाम.
command_line

स्ट्रिंग; डिफ़ॉल्ट रूप से "--descriptor_set_out=%s"
mnemonic

स्ट्रिंग; डिफ़ॉल्ट रूप से "GenProtoDescriptorSet"
output_files

स्ट्रिंग; डिफ़ॉल्ट रूप से "single"
progress_message

स्ट्रिंग; डिफ़ॉल्ट रूप से "Generating Descriptor Set proto_library %{label}"
proto_compiler

लेबल; डिफ़ॉल्ट None है