| # Copyright 2023 The Bazel Authors. All rights reserved. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| """Implementation of PyCcToolchainInfo.""" |
| |
| PyCcToolchainInfo = provider( |
| doc = "C/C++ information about the Python runtime.", |
| fields = { |
| "headers": """\ |
| (struct) Information about the header files, with fields: |
| * providers_map: a dict of string to provider instances. The key should be |
| a fully qualified name (e.g. `@rules_foo//bar:baz.bzl#MyInfo`) of the |
| provider to uniquely identify its type. |
| |
| The following keys are always present: |
| * CcInfo: the CcInfo provider instance for the headers. |
| * DefaultInfo: the DefaultInfo provider instance for the headers. |
| |
| A map is used to allow additional providers from the originating headers |
| target (typically a `cc_library`) to be propagated to consumers (directly |
| exposing a Target object can cause memory issues and is an anti-pattern). |
| |
| When consuming this map, it's suggested to use `providers_map.values()` to |
| return all providers; or copy the map and filter out or replace keys as |
| appropriate. Note that any keys beginning with `_` (underscore) are |
| considered private and should be forward along as-is (this better allows |
| e.g. `:current_py_cc_headers` to act as the underlying headers target it |
| represents). |
| """, |
| "libs": """\ |
| (struct) Information about C libraries, with fields: |
| * providers_map: A dict of string to provider instances. The key should be |
| a fully qualified name (e.g. `@rules_foo//bar:baz.bzl#MyInfo`) of the |
| provider to uniquely identify its type. |
| |
| The following keys are always present: |
| * CcInfo: the CcInfo provider instance for the libraries. |
| * DefaultInfo: the DefaultInfo provider instance for the headers. |
| |
| A map is used to allow additional providers from the originating libraries |
| target (typically a `cc_library`) to be propagated to consumers (directly |
| exposing a Target object can cause memory issues and is an anti-pattern). |
| |
| When consuming this map, it's suggested to use `providers_map.values()` to |
| return all providers; or copy the map and filter out or replace keys as |
| appropriate. Note that any keys beginning with `_` (underscore) are |
| considered private and should be forward along as-is (this better allows |
| e.g. `:current_py_cc_headers` to act as the underlying headers target it |
| represents). |
| """, |
| "python_version": "(str) The Python Major.Minor version.", |
| }, |
| ) |