com.facebook.buck.features.python

Class PythonBinaryDescription

java.lang.Object

com.facebook.buck.features.python.PythonBinaryDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.features.python.PythonBinaryDescription.AbstractPythonBinaryDescriptionArg>, BaseDescription<PythonBinaryDescriptionArg>, Description<PythonBinaryDescriptionArg>, DescriptionWithTargetGraph<PythonBinaryDescriptionArg>, VersionRoot<PythonBinaryDescriptionArg>

public class PythonBinaryDescription
extends Object
implements DescriptionWithTargetGraph<PythonBinaryDescriptionArg>, ImplicitDepsInferringDescription<com.facebook.buck.features.python.PythonBinaryDescription.AbstractPythonBinaryDescriptionArg>, VersionRoot<PythonBinaryDescriptionArg>

Constructor Summary

Constructors

Constructor and Description
PythonBinaryDescription(ToolchainProvider toolchainProvider, PythonBuckConfig pythonBuckConfig, CxxBuckConfig cxxBuckConfig)

Method Summary

Modifier and Type	Method and Description
static com.google.common.collect.ImmutableMap<Path,SourcePath>	addMissingInitModules(com.google.common.collect.ImmutableMap<Path,SourcePath> modules, SourcePath emptyInit)
PythonBinary	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, PythonBinaryDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
static SourcePath	createEmptyInitModule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, ActionGraphBuilder graphBuilder)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.features.python.PythonBinaryDescription.AbstractPythonBinaryDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
Class<PythonBinaryDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
static BuildTarget	getEmptyInitTarget(BuildTarget baseTarget)
boolean	producesCacheableSubgraph() Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.versions.VersionRoot

isVersionRoot

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps

Constructor Detail

PythonBinaryDescription

public PythonBinaryDescription(ToolchainProvider toolchainProvider,
                               PythonBuckConfig pythonBuckConfig,
                               CxxBuckConfig cxxBuckConfig)

Method Detail

getConstructorArgType

public Class<PythonBinaryDescriptionArg> getConstructorArgType()

Description copied from interface: BaseDescription

The type of the constructor argument that is used by this description to create a rule

Specified by:

getConstructorArgType in interface BaseDescription<PythonBinaryDescriptionArg>

getEmptyInitTarget

public static BuildTarget getEmptyInitTarget(BuildTarget baseTarget)

createEmptyInitModule

public static SourcePath createEmptyInitModule(BuildTarget buildTarget,
                                               ProjectFilesystem projectFilesystem,
                                               ActionGraphBuilder graphBuilder)

addMissingInitModules

public static com.google.common.collect.ImmutableMap<Path,SourcePath> addMissingInitModules(com.google.common.collect.ImmutableMap<Path,SourcePath> modules,
                                                                                            SourcePath emptyInit)

createBuildRule

public PythonBinary createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                    BuildTarget buildTarget,
                                    BuildRuleParams params,
                                    PythonBinaryDescriptionArg args)

Description copied from interface: DescriptionWithTargetGraph

Create a BuildRule for the given BuildRuleParams. Note that the BuildTarget referred to in the params contains the Flavor to create.

Specified by:

createBuildRule in interface DescriptionWithTargetGraph<PythonBinaryDescriptionArg>

args - A constructor argument, of type as returned by BaseDescription.getConstructorArgType().

Returns:

The BuildRule that describes the default flavour of the rule being described.

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 com.facebook.buck.features.python.PythonBinaryDescription.AbstractPythonBinaryDescriptionArg constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<com.facebook.buck.features.python.PythonBinaryDescription.AbstractPythonBinaryDescriptionArg>

producesCacheableSubgraph

public boolean producesCacheableSubgraph()

Description copied from interface: DescriptionWithTargetGraph

Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Specified by:

producesCacheableSubgraph in interface Description<PythonBinaryDescriptionArg>

Specified by:

producesCacheableSubgraph in interface DescriptionWithTargetGraph<PythonBinaryDescriptionArg>