-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add helper for abstracting over Python provider representation and de…
…faults This creates PyProviderUtils, a collection of helpers that take in a TransitiveInfoCollection and return fields obtained from the Python provider. Currently this just dispatches to PyStructUtils to retrieve from the legacy "py" struct provider. In a follow-up CL, we'll add a modern PyInfo type, and PyProviderUtils will access either one as appropriate. PyProviderUtils also takes over the default logic from PyCommon, for when no Python provider information is available. Work toward #7010. RELNOTES: None PiperOrigin-RevId: 230791581
- Loading branch information
Showing
8 changed files
with
388 additions
and
213 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
150 changes: 150 additions & 0 deletions
150
src/main/java/com/google/devtools/build/lib/rules/python/PyProviderUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| // Copyright 2019 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. | ||
|
|
||
| package com.google.devtools.build.lib.rules.python; | ||
|
|
||
| import com.google.devtools.build.lib.actions.Artifact; | ||
| import com.google.devtools.build.lib.analysis.FileProvider; | ||
| import com.google.devtools.build.lib.analysis.TransitiveInfoCollection; | ||
| import com.google.devtools.build.lib.collect.nestedset.NestedSet; | ||
| import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; | ||
| import com.google.devtools.build.lib.collect.nestedset.Order; | ||
| import com.google.devtools.build.lib.packages.StructImpl; | ||
| import com.google.devtools.build.lib.rules.cpp.CppFileTypes; | ||
| import com.google.devtools.build.lib.syntax.EvalException; | ||
| import com.google.devtools.build.lib.syntax.SkylarkType; | ||
| import com.google.devtools.build.lib.util.FileType; | ||
|
|
||
| /** | ||
| * Static helper class for creating and accessing Python provider information. | ||
| * | ||
| * <p>This class exposes a unified view over both the legacy and modern Python providers. | ||
| */ | ||
| public class PyProviderUtils { | ||
|
|
||
| // Disable construction. | ||
| private PyProviderUtils() {} | ||
|
|
||
| /** Returns whether a given target has the py provider. */ | ||
| public static boolean hasProvider(TransitiveInfoCollection target) { | ||
| return target.get(PyStructUtils.PROVIDER_NAME) != null; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the struct representing the py provider, from the given target info. | ||
| * | ||
| * @throws EvalException if the provider does not exist or has the wrong type. | ||
| */ | ||
| public static StructImpl getProvider(TransitiveInfoCollection target) throws EvalException { | ||
| Object info = target.get(PyStructUtils.PROVIDER_NAME); | ||
| if (info == null) { | ||
| throw new EvalException(/*location=*/ null, "Target does not have 'py' provider"); | ||
| } | ||
| return SkylarkType.cast( | ||
| info, | ||
| StructImpl.class, | ||
| null, | ||
| "'%s' provider should be a struct", | ||
| PyStructUtils.PROVIDER_NAME); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the transitive sources of a given target. | ||
| * | ||
| * <p>If the target has a py provider, the value from that provider is used. Otherwise, we fall | ||
| * back on collecting .py source files from the target's filesToBuild. | ||
| * | ||
| * @throws EvalException if the legacy struct provider is present but malformed | ||
| */ | ||
| // TODO(bazel-team): Eliminate the fallback behavior by returning an appropriate py provider from | ||
| // the relevant rules. | ||
| public static NestedSet<Artifact> getTransitiveSources(TransitiveInfoCollection target) | ||
| throws EvalException { | ||
| if (hasProvider(target)) { | ||
| return PyStructUtils.getTransitiveSources(getProvider(target)); | ||
| } else { | ||
| NestedSet<Artifact> files = target.getProvider(FileProvider.class).getFilesToBuild(); | ||
| return NestedSetBuilder.<Artifact>compileOrder() | ||
| .addAll(FileType.filter(files, PyRuleClasses.PYTHON_SOURCE)) | ||
| .build(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns whether a target uses shared libraries. | ||
| * | ||
| * <p>If the target has a py provider, the value from that provider is used. Otherwise, we fall | ||
| * back on checking whether the target's filesToBuild contains a shared library file type (e.g., a | ||
| * .so file). | ||
| * | ||
| * @throws EvalException if the legacy struct provider is present but malformed | ||
| */ | ||
| public static boolean getUsesSharedLibraries(TransitiveInfoCollection target) | ||
| throws EvalException { | ||
| if (hasProvider(target)) { | ||
| return PyStructUtils.getUsesSharedLibraries(getProvider(target)); | ||
| } else { | ||
| NestedSet<Artifact> files = target.getProvider(FileProvider.class).getFilesToBuild(); | ||
| return FileType.contains(files, CppFileTypes.SHARED_LIBRARY); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns the transitive import paths of a target. | ||
| * | ||
| * <p>Imports are not currently propagated correctly (#7054). Currently the behavior is to return | ||
| * the imports contained in the target's {@link PythonImportsProvider}, ignoring the py provider, | ||
| * or no imports if there is no {@code PythonImportsProvider}. When #7054 is fixed, we'll instead | ||
| * return the imports specified by the py provider, or those from {@code PythonImportsProvider} if | ||
| * the py provider is not present, with an eventual goal of removing {@code | ||
| * PythonImportsProvider}. | ||
| */ | ||
| // TODO(#7054) Implement the above change. | ||
| public static NestedSet<String> getImports(TransitiveInfoCollection target) throws EvalException { | ||
| PythonImportsProvider importsProvider = target.getProvider(PythonImportsProvider.class); | ||
| if (importsProvider != null) { | ||
| return importsProvider.getTransitivePythonImports(); | ||
| } else { | ||
| return NestedSetBuilder.emptySet(Order.COMPILE_ORDER); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns whether the target has transitive sources requiring Python 2. | ||
| * | ||
| * <p>If the target has a py provider, the value from that provider is used. Otherwise, we default | ||
| * to false. | ||
| */ | ||
| public static boolean getHasPy2OnlySources(TransitiveInfoCollection target) throws EvalException { | ||
| if (hasProvider(target)) { | ||
| return PyStructUtils.getHasPy2OnlySources(getProvider(target)); | ||
| } else { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns whether the target has transitive sources requiring Python 3. | ||
| * | ||
| * <p>If the target has a py provider, the value from that provider is used. Otherwise, we default | ||
| * to false. | ||
| */ | ||
| public static boolean getHasPy3OnlySources(TransitiveInfoCollection target) throws EvalException { | ||
| if (hasProvider(target)) { | ||
| return PyStructUtils.getHasPy3OnlySources(getProvider(target)); | ||
| } else { | ||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.