com.facebook.buck.features.python

Class PexStep

java.lang.Object

com.facebook.buck.shell.ShellStep

com.facebook.buck.features.python.PexStep

All Implemented Interfaces:

Step

public class PexStep
extends ShellStep

Field Summary

Fields inherited from class com.facebook.buck.shell.ShellStep

workingDirectory

Constructor Summary

Constructors

Constructor and Description
PexStep(ProjectFilesystem filesystem, com.google.common.collect.ImmutableMap<String,String> environment, com.google.common.collect.ImmutableList<String> commandPrefix, Path pythonPath, PythonVersion pythonVersion, Path destination, String entry, com.facebook.buck.features.python.PythonResolvedPackageComponents components, com.google.common.collect.ImmutableSet<String> preloadLibraries)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.collect.ImmutableList<String>	getCommandPrefix()
com.google.common.collect.ImmutableMap<String,String>	getEnvironmentVariables(ExecutionContext context) Returns the environment variables to include when running this ShellStep.
protected com.google.common.collect.ImmutableList<String>	getShellCommandInternal(ExecutionContext context) Implementations of this method should not have any observable side-effects.
String	getShortName()
protected Optional<String>	getStdin(ExecutionContext context) Return the manifest as a JSON blob to write to the pex processes stdin.

Methods inherited from class com.facebook.buck.shell.ShellStep

addOptions, execute, getDescription, getDuration, getExitCodeFromResult, getShellCommand, getShellCommandArgsForDescription, getStderr, getStdout, getTimeout, getTimeoutHandler, shouldPrintStderr, shouldPrintStdout

Methods inherited from class java.lang.Object

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

Constructor Detail

PexStep

public PexStep(ProjectFilesystem filesystem,
               com.google.common.collect.ImmutableMap<String,String> environment,
               com.google.common.collect.ImmutableList<String> commandPrefix,
               Path pythonPath,
               PythonVersion pythonVersion,
               Path destination,
               String entry,
               com.facebook.buck.features.python.PythonResolvedPackageComponents components,
               com.google.common.collect.ImmutableSet<String> preloadLibraries)

Method Detail

getShortName

public String getShortName()

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getStdin

protected Optional<String> getStdin(ExecutionContext context)
                             throws IOException

Return the manifest as a JSON blob to write to the pex processes stdin.

We use stdin rather than passing as an argument to the processes since manifest files can occasionally get extremely large, and surpass exec/shell limits on arguments.

Overrides:

getStdin in class ShellStep

Throws:

IOException

getShellCommandInternal

protected com.google.common.collect.ImmutableList<String> getShellCommandInternal(ExecutionContext context)

Description copied from class: ShellStep

Implementations of this method should not have any observable side-effects.

Specified by:

getShellCommandInternal in class ShellStep

getEnvironmentVariables

public com.google.common.collect.ImmutableMap<String,String> getEnvironmentVariables(ExecutionContext context)

Description copied from class: ShellStep

Returns the environment variables to include when running this ShellStep.

By default, this method returns an empty map.

Overrides:

getEnvironmentVariables in class ShellStep

Parameters:

context - that may be useful when determining environment variables to include.

getCommandPrefix

protected com.google.common.collect.ImmutableList<String> getCommandPrefix()