com.facebook.buck.features.python

Class PrebuiltPythonLibrary

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.features.python.PrebuiltPythonLibrary

All Implemented Interfaces:

BuildEngineAction, HasBuildTarget, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, PythonPackagable, Comparable<BuildRule>

public class PrebuiltPythonLibrary
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements PythonPackagable

Constructor Summary

Constructors

Constructor and Description
PrebuiltPythonLibrary(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, SourcePath binarySrc, boolean excludeDepsFromOmnibus, boolean compile)

Method Summary

Modifier and Type	Method and Description
boolean	doesPythonPackageDisallowOmnibus(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Allow this rule to opt-out it's transitive dependencies from omnibus linking.
com.google.common.collect.ImmutableList<? extends Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Optional<PythonComponents>	getPythonBytecode(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Compiled Python bytecode (e.g.
Optional<PythonComponents>	getPythonModules(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Python modules (i.e.
Iterable<BuildRule>	getPythonPackageDeps(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
Optional<PythonComponents>	getPythonResources(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Resources (e.g.
SourcePath	getSourcePathToOutput()

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.features.python.PythonPackagable

isPythonZipSafe

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

getBuildTarget

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

PrebuiltPythonLibrary

public PrebuiltPythonLibrary(BuildTarget buildTarget,
                             ProjectFilesystem projectFilesystem,
                             BuildRuleParams params,
                             SourcePath binarySrc,
                             boolean excludeDepsFromOmnibus,
                             boolean compile)

Method Detail

getPythonPackageDeps

public Iterable<BuildRule> getPythonPackageDeps(PythonPlatform pythonPlatform,
                                                CxxPlatform cxxPlatform,
                                                ActionGraphBuilder graphBuilder)

Specified by:

getPythonPackageDeps in interface PythonPackagable

getPythonModules

public Optional<PythonComponents> getPythonModules(PythonPlatform pythonPlatform,
                                                   CxxPlatform cxxPlatform,
                                                   ActionGraphBuilder graphBuilder)

Description copied from interface: PythonPackagable

Python modules (i.e. sources, bytecode, or native extensions) associated with this rule.

Specified by:

getPythonModules in interface PythonPackagable

Returns:

a map of modules, where the key is the module in Path form (including extension).

getPythonResources

public Optional<PythonComponents> getPythonResources(PythonPlatform pythonPlatform,
                                                     CxxPlatform cxxPlatform,
                                                     ActionGraphBuilder graphBuilder)

Description copied from interface: PythonPackagable

Resources (e.g. data files) associated with this rule.

Specified by:

getPythonResources in interface PythonPackagable

Returns:

a map of native libraries, where the key is the soname wrapped as a Path.

getPythonBytecode

public Optional<PythonComponents> getPythonBytecode(PythonPlatform pythonPlatform,
                                                    CxxPlatform cxxPlatform,
                                                    ActionGraphBuilder graphBuilder)

Description copied from interface: PythonPackagable

Compiled Python bytecode (e.g. `.pyc`) associated with this rule.

Specified by:

getPythonBytecode in interface PythonPackagable

Returns:

a map of compiled Python bytecode, where the key is the module in Path form (including extension).

getBuildSteps

public com.google.common.collect.ImmutableList<? extends Step> getBuildSteps(BuildContext context,
                                                                             BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

doesPythonPackageDisallowOmnibus

public boolean doesPythonPackageDisallowOmnibus(PythonPlatform pythonPlatform,
                                                CxxPlatform cxxPlatform,
                                                ActionGraphBuilder graphBuilder)

Description copied from interface: PythonPackagable

Allow this rule to opt-out it's transitive dependencies from omnibus linking. This is mainly useful for the case of prebuilt python packages including prebuilt native extensions in their sources parameter, which expect any native library dependencies to not be merged.

Specified by:

doesPythonPackageDisallowOmnibus in interface PythonPackagable

Returns:

whether this PythonPackagable's transitive deps must be excluded from omnibus linking.