com.facebook.buck.features.python

Class PythonLibraryDescription

java.lang.Object

com.facebook.buck.features.python.PythonLibraryDescription

All Implemented Interfaces:

BaseDescription<PythonLibraryDescriptionArg>, Description<PythonLibraryDescriptionArg>, MetadataProvidingDescription<PythonLibraryDescriptionArg>, Flavored, DescriptionWithTargetGraph<PythonLibraryDescriptionArg>, VersionPropagator<PythonLibraryDescriptionArg>

public class PythonLibraryDescription
extends Object
implements DescriptionWithTargetGraph<PythonLibraryDescriptionArg>, VersionPropagator<PythonLibraryDescriptionArg>, MetadataProvidingDescription<PythonLibraryDescriptionArg>, Flavored

Python library rule description

Constructor Summary

Constructors

Constructor and Description
PythonLibraryDescription(ToolchainProvider toolchainProvider)

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, PythonLibraryDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
<U> Optional<U>	createMetadata(BuildTarget buildTarget, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, PythonLibraryDescriptionArg args, Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions, Class<U> metadataClass)
Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>>	flavorDomains(TargetConfiguration toolchainTargetConfiguration)
Class<PythonLibraryDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
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.core.description.BaseDescription

getConfigurationDeps

Methods inherited from interface com.facebook.buck.core.model.Flavored

hasFlavors

Constructor Detail

PythonLibraryDescription

public PythonLibraryDescription(ToolchainProvider toolchainProvider)

Method Detail

flavorDomains

public Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>> flavorDomains(TargetConfiguration toolchainTargetConfiguration)

Specified by:

flavorDomains in interface Flavored

getConstructorArgType

public Class<PythonLibraryDescriptionArg> 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<PythonLibraryDescriptionArg>

createBuildRule

public BuildRule createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                 BuildTarget buildTarget,
                                 BuildRuleParams params,
                                 PythonLibraryDescriptionArg 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<PythonLibraryDescriptionArg>

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

Returns:

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

createMetadata

public <U> Optional<U> createMetadata(BuildTarget buildTarget,
                                      ActionGraphBuilder graphBuilder,
                                      CellPathResolver cellRoots,
                                      PythonLibraryDescriptionArg args,
                                      Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions,
                                      Class<U> metadataClass)

Specified by:

createMetadata in interface MetadataProvidingDescription<PythonLibraryDescriptionArg>

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<PythonLibraryDescriptionArg>

Specified by:

producesCacheableSubgraph in interface DescriptionWithTargetGraph<PythonLibraryDescriptionArg>