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
AbstractPythonMainSourceDefaultTask
- Class in
com.linkedin.gradle.python.tasks
This class is used to make sure that the up-to-date logic works.
AbstractPythonTestSourceDefaultTask
- Class in
com.linkedin.gradle.python.tasks
Add's lazy evaluation of the tests directory, see
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
args(Collection<String>)
- Method in
AbstractPythonMainSourceDefaultTask
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.
buildWheels(Project, Collection<File>, PythonExtension)
- Method in
BuildWheelsTask
A helper function that builds wheels.
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
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
CONFIGURATION_BOOTSTRAP_REQS
- Field in
PythonPlugin
CONFIGURATION_BUILD_REQS
- Field in
PythonPlugin
CONFIGURATION_DEFAULT
- Field in
PythonPlugin
CONFIGURATION_PYDOCS
- Field in
PythonPlugin
CONFIGURATION_PYTHON
- Field in
PythonPlugin
CONFIGURATION_SETUP_REQS
- Field in
PythonPlugin
CONFIGURATION_TEST
- Field in
PythonPlugin
CONFIGURATION_VENV
- Field in
PythonPlugin
CONFIGURATION_WHEEL
- Field in
PythonPlugin
configureExecution(ExecSpec)
- Method in
AbstractPythonMainSourceDefaultTask
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
createPrettyLine(String, String)
- Method in
PythonHelpers
createSetupPy()
- Method in
GenerateSetupPyTask
D
DeployableExtension
- Class in
com.linkedin.gradle.python.extension
DeployableExtension(Project)
- Constructor in
DeployableExtension
docsDir
- Field in
PythonExtension
The location of this project's Sphinx documentation directory.
DOCUMENTATION_GROUP
- Field in
PythonPlugin
E
enableConsole(boolean)
- Method in
PyTestTask
Enable console logging / debugging
EntryPointHelpers
- Class in
com.linkedin.gradle.python.util
EntryPointWriter
- Class in
com.linkedin.gradle.python.util.entrypoint
EntryPointWriter(Project, String)
- Constructor in
EntryPointWriter
errOut
- Field in
AbstractPythonMainSourceDefaultTask
execute(DependencyResolveDetails)
- Method in
PyGradleDependencyResolveDetails
execute(Tar)
- Method in
PythonPlugin.PackageDocumentationAction
executePythonProcess()
- Method in
AbstractPythonMainSourceDefaultTask
ExtensionUtils
- Class in
com.linkedin.gradle.python.util
F
FatPexGenerator
- Class in
com.linkedin.gradle.python.util.internal.pex
FatPexGenerator(Project)
- 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
findExecutable(PythonExtension, String)
- Method in
VirtualEnvExecutableHelper
findPythonComponentExtension(Project, 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
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
getComponent()
- Method in
AbstractPythonMainSourceDefaultTask
getComponent()
- Method in
InstallVirtualEnvironmentTask
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
getEnvironment()
- Method in
PythonExtension
getErrorNumber()
- Method in
StyleViolation
getEtcDir()
- Method in
GenerateCompletionsTask
getExecutable(PythonExtension, String)
- Method in
VirtualEnvExecutableHelper
getLineNumber()
- Method in
StyleViolation
getMessage()
- Method in
StyleViolation
getPex(PythonExtension)
- Method in
VirtualEnvExecutableHelper
getPexCache()
- Method in
PexExtension
getPinnedFile()
- Method in
PythonExtension
getPip(PythonExtension)
- Method in
VirtualEnvExecutableHelper
getPyGradleBootstrap()
- Method in
InstallVirtualEnvironmentTask
getPythonComponentExtension(Project, Class<T>)
- Method in
ExtensionUtils
getPythonExtension(Project)
- Method in
ExtensionUtils
getPythonInterpreter(PythonExtension)
- Method in
VirtualEnvExecutableHelper
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'.
getPythonVersion()
- Method in
PythonDetails
getPythonVersion()
- Method in
PythonVersion
@return The exact version of Python this project uses, such as '2.7.11'.
getSdistOutput()
- Method in
SourceDistTask
getSourceFiles()
- Method in
AbstractPythonMainSourceDefaultTask
getSystemPythonInterpreter()
- Method in
PythonDetails
getViolations()
- Method in
FileStyleViolationsContainer
getViolationType()
- Method in
StyleViolation
getVirtualEnv()
- Method in
AbstractPythonMainSourceDefaultTask
getVirtualEnv()
- Method in
PythonDetails
getVirtualEnvDir()
- Method in
InstallVirtualEnvironmentTask
getVirtualEnvInterpreter()
- Method in
PythonDetails
getVirtualEnvPrompt()
- Method in
PythonDetails
getWheelCache()
- Method in
WheelExtension
GUNICORN_ENTRYPOINT
- Field in
PythonWebApplicationPlugin
H
I
ignoreExitValue
- Field in
AbstractPythonMainSourceDefaultTask
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
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.
J
K
L
LINE_WIDTH
- Field in
PythonHelpers
M
makeSymLink(File, File)
- Method in
FileSystemUtils
Make a link
maybeCreateCliExtension(Project)
- Method in
ExtensionUtils
maybeCreateDeployableExtension(Project)
- Method in
ExtensionUtils
maybeCreatePexExtension(Project)
- Method in
ExtensionUtils
maybeCreateWheelExtension(Project)
- Method in
ExtensionUtils
N
O
P
PackageInfo
- Class in
com.linkedin.gradle.python.util
packageSdist()
- Method in
SourceDistTask
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.
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
preExecution()
- Method in
AbstractPythonMainSourceDefaultTask
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
AbstractPythonMainSourceDefaultTask
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
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)
- 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
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
setPexCache(File)
- Method in
PexExtension
setPinnedFile(File)
- Method in
PythonExtension
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
SourceDistTask
- Class in
com.linkedin.gradle.python.tasks
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.
standardExcludes()
- Method in
AbstractPythonMainSourceDefaultTask
stdOut
- Field in
AbstractPythonMainSourceDefaultTask
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_DOCS
- Field in
PythonPlugin
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_CHECK
- Field in
PythonPlugin
TASK_CHECKSTYLE
- Field in
PythonPlugin
TASK_COVERAGE
- Field in
PythonPlugin
TASK_FLAKE
- Field in
PythonPlugin
TASK_GENERATE_COMPLETIONS
- Field in
PythonCliDistributionPlugin
TASK_INSTALL_BUILD_REQS
- Field in
PythonPlugin
TASK_INSTALL_PROJECT
- Field in
PythonPlugin
TASK_INSTALL_PYTHON_REQS
- Field in
PythonPlugin
TASK_INSTALL_SETUP_REQS
- Field in
PythonPlugin
TASK_INSTALL_TEST_REQS
- Field in
PythonPlugin
TASK_PACKAGE_DEPLOYABLE
- Field in
PythonPexDistributionPlugin
TASK_PACKAGE_DOCS
- Field in
PythonPlugin
TASK_PACKAGE_JSON_DOCS
- Field in
PythonPlugin
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_PIN_REQUIREMENTS
- Field in
PythonPlugin
TASK_PYTEST
- Field in
PythonPlugin
TASK_SETUP_LINKS
- Field in
PythonPlugin
TASK_SETUP_PY_WRITER
- Field in
PythonPlugin
TASK_SETUP_RESOURCE_LINK
- Field in
PythonFlyerPlugin
TASK_VENV_CREATE
- Field in
PythonPlugin
testDir
- Field in
PythonExtension
The location of this project's tests directory.
type
- Field in
SphinxDocumentationTask
The type of documentation that will be generated
U
V
VirtualEnvExecutableHelper
- Class in
com.linkedin.gradle.python.util
W
WheelExtension
- Class in
com.linkedin.gradle.python.extension
WheelExtension(Project)
- Constructor in
WheelExtension
writeEntryPoint(File, Map<String, String>)
- Method in
EntryPointWriter
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