com.facebook.buck.features.python

Class PythonLibrary

java.lang.Object

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

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

com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.features.python.PythonLibrary

All Implemented Interfaces:

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

public class PythonLibrary
extends NoopBuildRuleWithDeclaredAndExtraDeps
implements PythonPackagable, HasRuntimeDeps

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.
Optional<PythonComponents>	getPythonBytecode(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Compiled Python bytecode (e.g.
Optional<PythonMappedComponents>	getPythonModules(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Python modules (i.e.
Iterable<BuildRule>	getPythonPackageDeps(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
Optional<PythonMappedComponents>	getPythonResources(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Resources (e.g.
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
Optional<Boolean>	isPythonZipSafe()

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

getBuildSteps, getSourcePathToOutput, hasBuildSteps, isCacheable

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, hashCode, injectFields, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

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

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

getBuildTarget

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

compareTo, getBuildDeps, getBuildSteps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, getSourcePathToOutput, hasBuildSteps, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString, updateBuildRuleResolver

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

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

getType

Method Detail

getPythonPackageDeps

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

Specified by:

getPythonPackageDeps in interface PythonPackagable

getPythonModules

public Optional<PythonMappedComponents> 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<PythonMappedComponents> 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).

isPythonZipSafe

public Optional<Boolean> isPythonZipSafe()

Specified by:

isPythonZipSafe in interface PythonPackagable

Returns:

whether the modules in this rule can be imported/run transparently from a Zip file (e.g. via zipimport). This is almost always the case, but in rare situations (e.g. execution expects to find packaged files in disk) rules can opt-out.

getRuntimeDeps

public java.util.stream.Stream<BuildTarget> getRuntimeDeps(BuildRuleResolver buildRuleResolver)

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

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.