JavaScript is disabled on your browser.
Overview
Package
Class
Deprecated
Index
Help
Frames
No Frames
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
_
A
AbstractPythonTestSourceDefaultTask
- Class in
com.linkedin.gradle.python.tasks
Add's lazy evaluation of the tests directory, see com.linkedin.gradle.python.tasks.AbstractPythonMainSourceDefaultTask for more details.
ANSI_BLACK
- Field in
ColorHelper
ANSI_BLUE
- Field in
ColorHelper
ANSI_CYAN
- Field in
ColorHelper
ANSI_GREEN
- Field in
ColorHelper
ANSI_PURPLE
- Field in
ColorHelper
ANSI_RED
- Field in
ColorHelper
ANSI_RESET
- Field in
ColorHelper
ANSI_WHITE
- Field in
ColorHelper
ANSI_YELLOW
- Field in
ColorHelper
appendExecutableDirectory(File)
- Method in
PythonDetails
Adds a new directory to search for an executable.
apply(Project)
- Method in
PythonBasePlugin
apply(Project)
- Method in
PythonFlyerPlugin
apply(Project)
- Method in
PythonPlugin
applyTo(Project)
- Method in
PythonBasePlugin
applyTo(Project)
- Method in
PythonCliDistributionPlugin
applyTo(Project)
- Method in
PythonPexDistributionPlugin
applyTo(Project)
- Method in
PythonSourceDistributionPlugin
applyTo(Project)
- Method in
PythonWebApplicationPlugin
applyTo(Project)
- Method in
PythonWheelDistributionPlugin
B
buildEntryPoints()
- Method in
FatPexGenerator
buildEntryPoints()
- Method in
PexGenerator
When called will generate entry point files for a pex.
buildPexFile(Project, File, String, File, String, String)
- Method in
PexFileUtil
Build a pex file.
buildPipConfFile()
- Method in
PipConfFile
Writes a new pip.conf file.
BuildWheelsTask
- Class in
com.linkedin.gradle.python.tasks
buildWheelsTask()
- Method in
BuildWheelsTask
C
CheckStyleGeneratorTask
- Class in
com.linkedin.gradle.python.tasks
This has slightly different behavior from
Flake8Task
in that, if the inputs fail violation this will continue.
CheckStyleGeneratorTask()
- Constructor in
CheckStyleGeneratorTask
CheckStyleXmlReporter
- Class in
com.linkedin.gradle.python.checkstyle
CheckStyleXmlReporter(FileStyleViolationsContainer)
- Constructor in
CheckStyleXmlReporter
cleanProject()
- Method in
CleanSaveVenvTask
CleanSaveVenvTask
- Class in
com.linkedin.gradle.python.tasks
CliExtension
- Class in
com.linkedin.gradle.python.extension
collectEntryPoints(Project)
- Method in
EntryPointHelpers
Run ``setup.py entrypoints`` and return the results.
ColorHelper
- Class in
com.linkedin.gradle.python.util
configureExecution(ExecSpec)
- Method in
GenerateCompletionsTask
ConsoleOutput
- Enum in
com.linkedin.gradle.python.util
consoleOutput
- Field in
PythonExtension
CoverageXmlReporter
- Class in
com.linkedin.gradle.python.coverage
CoverageXmlReporter(String)
- Constructor in
CoverageXmlReporter
createCheckstyleMap()
- Method in
StyleViolation
createFatPexFilename(String)
- Method in
PexFileUtil
createPrettyLine(String, String)
- Method in
PythonHelpers
createSetupPy()
- Method in
GenerateSetupPyTask
createThinPexFilename(String)
- Method in
PexFileUtil
current()
- Method in
OperatingSystem
D
DefaultEntryPointTemplateProvider
- Class in
com.linkedin.gradle.python.util.pex
DefaultTemplateProviderOptions
- Class in
com.linkedin.gradle.python.util.internal.pex
Provides some values to help pick which template to use
DefaultTemplateProviderOptions(Project, PythonExtension, String)
- Constructor in
DefaultTemplateProviderOptions
DeployableExtension
- Class in
com.linkedin.gradle.python.extension
DeployableExtension(Project)
- Constructor in
DeployableExtension
details(Closure)
- Method in
PythonExtension
Configures the
PythonDetails
for the project.
docsDir
- Field in
PythonExtension
The location of this project's Sphinx documentation directory.
E
enableConsole(boolean)
- Method in
PyTestTask
Enable console logging / debugging
EntryPointHelpers
- Class in
com.linkedin.gradle.python.util
EntryPointTemplateProvider
- Interface in
com.linkedin.gradle.python.util.pex
Used to get a template to use for the entry points
EntryPointWriter
- Class in
com.linkedin.gradle.python.util.entrypoint
EntryPointWriter(Project, String)
- Constructor in
EntryPointWriter
execute(DependencyResolveDetails)
- Method in
PyGradleDependencyResolveDetails
execute(Tar)
- Method in
PythonPlugin.PackageDocumentationAction
ExtensionUtils
- Class in
com.linkedin.gradle.python.util
F
FailureReasonProvider
- Interface in
com.linkedin.gradle.python.tasks.execution
Used by tasks that will provide output messages when something goes wrong.
FatPexGenerator
- Class in
com.linkedin.gradle.python.util.internal.pex
FatPexGenerator(Project, List<String>)
- Constructor in
FatPexGenerator
FileStyleViolationsContainer
- Class in
com.linkedin.gradle.python.checkstyle.model
This will contain all of the violations, handling adding violations to existing files, and adding new files.
FileSystemUtils
- Class in
com.linkedin.gradle.python.util
filterFiles(String)
- Method in
PyTestTask
Run tests on single file
filterTestCase(String)
- Method in
PyTestTask
Only test one file
findAllInPath(String)
- Method in
OperatingSystem
findExecutable(String)
- Method in
VirtualEnvironment
findInPath(List<File>, String)
- Method in
OperatingSystem
Locates the given executable in the system path.
findPythonComponentExtension(PythonExtension, Class<T>)
- Method in
ExtensionUtils
Flake8Task
- Class in
com.linkedin.gradle.python.tasks
forcedVersions
- Field in
PythonExtension
A way to define forced versions of libraries
forceVersion(String)
- Method in
PythonExtension
forName(String)
- Method in
OperatingSystem
FREE_BSD
- Field in
OperatingSystem
fromPath(String)
- Method in
PackageInfo
Derives a Python package's name and version from its path.
G
GenerateCompletionsTask
- Class in
com.linkedin.gradle.python.tasks
Generates completion files.
GenerateSetupPyTask
- Class in
com.linkedin.gradle.python.tasks
GenerateSetupPyTask()
- Constructor in
GenerateSetupPyTask
generateXml()
- Method in
CheckStyleXmlReporter
generateXML()
- Method in
CoverageXmlReporter
getActivateLink()
- Method in
PythonDetails
getColumnNumber()
- Method in
StyleViolation
getCommandOutput()
- Method in
TeeOutputContainer
getConfigurationFiles()
- Method in
PipInstallTask
Returns a set of configuration files in the insert order or sorted.
getDeployableBinDir()
- Method in
DeployableExtension
getDeployableBuildDir()
- Method in
DeployableExtension
getDeployableEtcDir()
- Method in
DeployableExtension
getDetails()
- Method in
PythonExtension
getDocDir()
- Method in
SphinxDocumentationTask
getDocFiles()
- Method in
SphinxDocumentationTask
getEntryPoint()
- Method in
DefaultTemplateProviderOptions
getEntryPoint()
- Method in
TemplateProviderOptions
getEnvironment()
- Method in
PythonExtension
getErrorNumber()
- Method in
StyleViolation
getEtcDir()
- Method in
GenerateCompletionsTask
getExecutable(String)
- Method in
VirtualEnvironment
getExecutableName(String)
- Method in
OperatingSystem
getExtension()
- Method in
DefaultTemplateProviderOptions
getExtension()
- Method in
TemplateProviderOptions
getFamilyName()
- Method in
OperatingSystem
getLineNumber()
- Method in
StyleViolation
getMessage()
- Method in
StyleViolation
getName()
- Method in
OperatingSystem
getNativePrefix()
- Method in
OperatingSystem
getPath()
- Method in
OperatingSystem
getPathVar()
- Method in
OperatingSystem
getPex()
- Method in
VirtualEnvironment
getPexCache()
- Method in
PexExtension
getPinnedFile()
- Method in
PinRequirementsTask
getPinnedFile()
- Method in
PythonExtension
getPip()
- Method in
VirtualEnvironment
getProject()
- Method in
DefaultTemplateProviderOptions
getProject()
- Method in
TemplateProviderOptions
getPyGradleBootstrap()
- Method in
InstallVirtualEnvironmentTask
getPythonApplicationDirectory()
- Method in
VirtualEnvironment
getPythonComponentExtension(PythonExtension, Class<T>)
- Method in
ExtensionUtils
getPythonConfiguration()
- Method in
PinRequirementsTask
getPythonDetails()
- Method in
BuildWheelsTask
getPythonDetails()
- Method in
InstallVirtualEnvironmentTask
getPythonExtension()
- Method in
BuildWheelsTask
getPythonExtension(Project)
- Method in
ExtensionUtils
getPythonMajor()
- Method in
PythonVersion
@return The major version of Python this project uses, such as '2'.
getPythonMajorMinor()
- Method in
PythonVersion
@return The short version of Python this project uses, such as '2.7'.
getPythonMinor()
- Method in
PythonVersion
@return The minor version of Python this project uses, such as '7'.
getPythonPatch()
- Method in
PythonVersion
@return The patch version of Python this project uses, such as '11'.
getPythonVersion()
- Method in
PythonDetails
getPythonVersion()
- Method in
PythonVersion
@return The exact version of Python this project uses, such as '2.7.11'.
getReason()
- Method in
FailureReasonProvider
@return the message for what went wrong
getReason()
- Method in
InstallVirtualEnvironmentTask
getReason()
- Method in
PipInstallTask
getScript(String)
- Method in
VirtualEnvironment
getScriptName(String)
- Method in
OperatingSystem
getSdistOutput()
- Method in
SourceDistTask
getSharedLibraryName(String)
- Method in
OperatingSystem
getStaticLibraryName(String)
- Method in
OperatingSystem
getSystemPythonInterpreter()
- Method in
PythonDetails
getValue()
- Method in
StandardTextValues
getVersion()
- Method in
OperatingSystem
getViolations()
- Method in
FileStyleViolationsContainer
getViolationType()
- Method in
StyleViolation
getVirtualEnv()
- Method in
PythonDetails
getVirtualEnvDir()
- Method in
InstallVirtualEnvironmentTask
getVirtualEnvInterpreter()
- Method in
PythonDetails
getVirtualEnvironment()
- Method in
PythonDetails
getVirtualEnvPrompt()
- Method in
PythonDetails
getWheelCache()
- Method in
WheelExtension
GUNICORN_ENTRYPOINT
- Field in
PythonWebApplicationPlugin
H
I
installVEnv()
- Method in
InstallVirtualEnvironmentTask
InstallVirtualEnvironmentTask
- Class in
com.linkedin.gradle.python.tasks
isFatPex()
- Method in
PexExtension
@return when
true
, then skinny pex's will be used.
isGenerateCompletions()
- Method in
CliExtension
isLinux()
- Method in
OperatingSystem
isMacOsX()
- Method in
OperatingSystem
isPythonWrapper()
- Method in
PexExtension
TODO: Revisit if this is needed.
isTty(Project)
- Method in
PythonHelpers
Detect if we're connected to a TTY and support color.
isUnix()
- Method in
OperatingSystem
isWindows()
- Method in
OperatingSystem
J
K
L
LINE_WIDTH
- Field in
PythonHelpers
LINUX
- Field in
OperatingSystem
M
MAC_OS
- Field in
OperatingSystem
makeSymLink(File, File)
- Method in
FileSystemUtils
Make a link
maybeCreate(PythonExtension, String, Class<T>, Object)
- Method in
ExtensionUtils
maybeCreateCliExtension(Project)
- Method in
ExtensionUtils
maybeCreateDeployableExtension(Project)
- Method in
ExtensionUtils
maybeCreatePexExtension(Project)
- Method in
ExtensionUtils
maybeCreateWheelExtension(Project)
- Method in
ExtensionUtils
MissingInterpreterException
- Class in
com.linkedin.gradle.python.exception
Failed to find Python interpreter in PATH.
MissingInterpreterException(String)
- Constructor in
MissingInterpreterException
N
O
OperatingSystem
- Class in
com.linkedin.gradle.python.util
This class was take verbatim from Gradle (org.gradle.internal.os.OperatingSystem).
P
PackageInfo
- Class in
com.linkedin.gradle.python.util
parseLine(String)
- Method in
FileStyleViolationsContainer
parsePythonVersion(Project, File)
- Method in
PythonVersionParser
PexExtension
- Class in
com.linkedin.gradle.python.extension
PexExtension(Project)
- Constructor in
PexExtension
PexFileUtil
- Class in
com.linkedin.gradle.python.util
PexGenerator
- Interface in
com.linkedin.gradle.python.util.internal.pex
pinnedFile
- Field in
PythonExtension
The name of the pinned requirements file.
PinRequirementsTask
- Class in
com.linkedin.gradle.python.tasks
PipConfFile
- Class in
com.linkedin.gradle.python.util.pip
PipConfFile(Project, PythonDetails)
- Constructor in
PipConfFile
pipConfig
- Field in
PythonExtension
Settings that can be put into the pip.conf file in the venv
pipFreeze(Project)
- Method in
PexFileUtil
Run ``pip freeze`` and return the results.
pipInstall()
- Method in
PipInstallTask
Install things into a virtual environment.
PipInstallTask
- Class in
com.linkedin.gradle.python.tasks
Execute pip install
PipInstallTask.PipInstallException
- Class in
com.linkedin.gradle.python.tasks
PipInstallTask.PipInstallException(String)
- Constructor in
PipInstallTask.PipInstallException
preExecution()
- Method in
Flake8Task
preExecution()
- Method in
GenerateCompletionsTask
preExecution()
- Method in
PyCoverageTask
Include coverage data
preExecution()
- Method in
PyTestTask
preExecution()
- Method in
SphinxDocumentationTask
prependExecutableDirectory(File)
- Method in
PythonDetails
Adds a new directory to search for an executable.
processResults(ExecResult)
- Method in
CheckStyleGeneratorTask
processResults(ExecResult)
- Method in
Flake8Task
processResults(ExecResult)
- Method in
GenerateCompletionsTask
processResults(ExecResult)
- Method in
PyCoverageTask
processResults(ExecResult)
- Method in
PyTestTask
processResults(ExecResult)
- Method in
SourceDistTask
processResults(ExecResult)
- Method in
SphinxDocumentationTask
processStream(String)
- Method in
PyCoverageTask.ParseOutputStream
project
- Field in
PythonBasePlugin
PyCoverageTask
- Class in
com.linkedin.gradle.python.tasks
Run coverage and generate outputs.
PyCoverageTask.ParseOutputStream
- Class in
com.linkedin.gradle.python.tasks
PyCoverageTask()
- Constructor in
PyCoverageTask
PyGradleDependencyResolveDetails
- Class in
com.linkedin.gradle.python.plugin
PyGradleDependencyResolveDetails(Map<String, Map<String, String>>)
- Constructor in
PyGradleDependencyResolveDetails
PyTestTask
- Class in
com.linkedin.gradle.python.tasks
Run py.test on test directory
PyTestTask()
- Constructor in
PyTestTask
PythonBasePlugin
- Class in
com.linkedin.gradle.python.plugin
PythonCliDistributionPlugin
- Class in
com.linkedin.gradle.python.plugin
PythonDetails
- Class in
com.linkedin.gradle.python.extension
PythonDetails(Project, File)
- Constructor in
PythonDetails
pythonEnvironment
- Field in
PythonExtension
The environment to use for all Python commands.
pythonEnvironmentDistgradle
- Field in
PythonExtension
The environment to use for Python commands run on the project being developed.
PythonExtension
- Class in
com.linkedin.gradle.python
Configuration settings for Python products.
PythonExtension(Project)
- Constructor in
PythonExtension
PythonFlyerPlugin
- Class in
com.linkedin.gradle.python.plugin
A Flyer plugin.
PythonHelpers
- Class in
com.linkedin.gradle.python.plugin
PythonPexDistributionPlugin
- Class in
com.linkedin.gradle.python.plugin
PythonPlugin
- Class in
com.linkedin.gradle.python.plugin
PythonPlugin.PackageDocumentationAction
- Class in
com.linkedin.gradle.python.plugin
Install virtualenv.
PythonPlugin.PackageDocumentationAction(SphinxDocumentationTask)
- Constructor in
PythonPlugin.PackageDocumentationAction
PythonSourceDistributionPlugin
- Class in
com.linkedin.gradle.python.plugin
PythonVersion
- Class in
com.linkedin.gradle.python.extension
PythonVersion(String)
- Constructor in
PythonVersion
PythonVersionParser
- Class in
com.linkedin.gradle.python.extension
PythonWebApplicationPlugin
- Class in
com.linkedin.gradle.python.plugin
PythonWheelDistributionPlugin
- Class in
com.linkedin.gradle.python.plugin
Q
R
retrieveTemplate(TemplateProviderOptions)
- Method in
DefaultEntryPointTemplateProvider
retrieveTemplate(TemplateProviderOptions)
- Method in
EntryPointTemplateProvider
Returns a template to be used for an entry point.
S
setActivateLink(File)
- Method in
PythonDetails
setDeployableBinDir(File)
- Method in
DeployableExtension
setDeployableBuildDir(File)
- Method in
DeployableExtension
setDeployableEtcDir(File)
- Method in
DeployableExtension
setFatPex(boolean)
- Method in
PexExtension
@param fatPex when
true
, wrappers will be made all pointing to a single pex file.
setGenerateCompletions(boolean)
- Method in
CliExtension
setOutputs(ExecSpec)
- Method in
TeeOutputContainer
setPexCache(File)
- Method in
PexExtension
setPinnedFile(File)
- Method in
PythonExtension
setPythonDetails(PythonDetails)
- Method in
InstallVirtualEnvironmentTask
setPythonVersion(String)
- Method in
PythonDetails
setPythonWrapper(boolean)
- Method in
PexExtension
setSystemPythonInterpreter(String)
- Method in
PythonDetails
settings
- Field in
PythonBasePlugin
setupCfg
- Field in
PythonExtension
The location of this project's setup.cfg file.
setVirtualEnvPrompt(String)
- Method in
PythonDetails
setWheelCache(File)
- Method in
WheelExtension
SOLARIS
- Field in
OperatingSystem
SourceDistTask
- Class in
com.linkedin.gradle.python.tasks
SourceDistTask()
- Constructor in
SourceDistTask
SphinxDocumentationTask
- Class in
com.linkedin.gradle.python.tasks
Generates Sphinx Documentation
SphinxDocumentationTask.DocType
- Enum in
com.linkedin.gradle.python.tasks
Types of documentation that are supported by Sphinx
SphinxDocumentationTask.DocType(String)
- Constructor in
SphinxDocumentationTask.DocType
srcDir
- Field in
PythonExtension
The location of this project's source directory.
StandardTextValues
- Enum in
com.linkedin.gradle.python.util
CodeNarc is complaining that some classes exceed 350 lines.
StandardTextValues(String)
- Constructor in
StandardTextValues
StyleViolation
- Class in
com.linkedin.gradle.python.checkstyle.model
StyleViolation.ViolationType
- Enum in
com.linkedin.gradle.python.checkstyle.model
StyleViolation(Integer, Integer, String, String)
- Constructor in
StyleViolation
successFlair(Project, PythonExtension)
- Method in
PythonHelpers
Return a string that indicates success!
T
TASK_BUILD_PEX
- Field in
PythonPexDistributionPlugin
TASK_BUILD_PEX
- Field in
PythonWebApplicationPlugin
TASK_BUILD_WEB_APPLICATION
- Field in
PythonWebApplicationPlugin
TASK_BUILD_WHEELS
- Field in
PythonPexDistributionPlugin
TASK_GENERATE_COMPLETIONS
- Field in
PythonCliDistributionPlugin
TASK_PACKAGE_DEPLOYABLE
- Field in
PythonPexDistributionPlugin
TASK_PACKAGE_RESOURCE_FILES
- Field in
PythonFlyerPlugin
TASK_PACKAGE_SDIST
- Field in
PythonSourceDistributionPlugin
TASK_PACKAGE_WEB_APPLICATION
- Field in
PythonWebApplicationPlugin
TASK_PACKAGE_WHEEL
- Field in
PythonWheelDistributionPlugin
TASK_SETUP_RESOURCE_LINK
- Field in
PythonFlyerPlugin
TeeOutputContainer
- Class in
com.linkedin.gradle.python.tasks.execution
Collects all the output of commands so they can be used elsewhere
TeeOutputContainer()
- Constructor in
TeeOutputContainer
TemplateProviderOptions
- Interface in
com.linkedin.gradle.python.util.pex
testDir
- Field in
PythonExtension
The location of this project's tests directory.
toString()
- Method in
OperatingSystem
toString()
- Method in
StandardTextValues
type
- Field in
SphinxDocumentationTask
The type of documentation that will be generated
U
UNIX
- Field in
OperatingSystem
V
validateFileExists(Path)
- Method in
VirtualEnvironment
VirtualEnvironment
- Class in
com.linkedin.gradle.python.extension
VirtualEnvironment(PythonDetails)
- Constructor in
VirtualEnvironment
W
WheelExtension
- Class in
com.linkedin.gradle.python.extension
WheelExtension(Project)
- Constructor in
WheelExtension
WINDOWS
- Field in
OperatingSystem
writeEntryPoint(File, Map<String, String>)
- Method in
EntryPointWriter
writeOutPinnedFile()
- Method in
PinRequirementsTask
X
Y
Z
_
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
_
Overview
Package
Class
Deprecated
Index
Help
Frames
No Frames
Groovy Documentation