com.facebook.buck.features.python

Class CxxPythonExtension

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.CxxPythonExtension

All Implemented Interfaces:

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

public abstract class CxxPythonExtension
extends NoopBuildRuleWithDeclaredAndExtraDeps
implements PythonPackagable, HasRuntimeDeps

Constructor Summary

Constructors

Constructor and Description
CxxPythonExtension(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params)

Method Summary

Modifier and Type	Method and Description
protected abstract BuildRule	getExtension(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder)
abstract Path	getModule()
abstract NativeLinkTarget	getNativeLinkTarget(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder, boolean includePrivateLinkerFlags)
abstract Optional<PythonMappedComponents>	getPythonModules(PythonPlatform pythonPlatform, CxxPlatform cxxPlatform, ActionGraphBuilder graphBuilder) Python modules (i.e.
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.features.python.PythonPackagable

doesPythonPackageDisallowOmnibus, getPythonBytecode, getPythonPackageDeps, getPythonResources

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

getBuildTarget

Methods inherited from interface com.facebook.buck.core.rules.attr.HasRuntimeDeps

getRuntimeDeps

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

Constructor Detail

CxxPythonExtension

public CxxPythonExtension(BuildTarget buildTarget,
                          ProjectFilesystem projectFilesystem,
                          BuildRuleParams params)

Method Detail

getExtension

protected abstract BuildRule getExtension(PythonPlatform pythonPlatform,
                                          CxxPlatform cxxPlatform,
                                          ActionGraphBuilder graphBuilder)

getModule

public abstract Path getModule()

getPythonModules

public abstract 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).

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.

getNativeLinkTarget

public abstract NativeLinkTarget getNativeLinkTarget(PythonPlatform pythonPlatform,
                                                     CxxPlatform cxxPlatform,
                                                     ActionGraphBuilder graphBuilder,
                                                     boolean includePrivateLinkerFlags)