Configuration settings for Python products.
These values are added as a plugin extension and can be customized in the build.gradle files of clients.
| Modifiers | Name | Description |
|---|---|---|
ConsoleOutput |
consoleOutput |
|
java.lang.String |
docsDir |
The location of this project's Sphinx documentation directory. |
java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> |
forcedVersions |
A way to define forced versions of libraries |
java.io.File |
pinnedFile |
The name of the pinned requirements file. |
java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>> |
pipConfig |
Settings that can be put into the pip.conf file in the venv |
java.util.Map<java.lang.String, java.lang.String> |
pythonEnvironment |
The environment to use for all Python commands. |
java.util.Map<java.lang.String, java.lang.String> |
pythonEnvironmentDistgradle |
The environment to use for Python commands run on the project being developed. |
java.lang.String |
setupCfg |
The location of this project's setup.cfg file. |
java.lang.String |
srcDir |
The location of this project's source directory. |
java.lang.String |
testDir |
The location of this project's tests directory. |
| Constructor and description |
|---|
PythonExtension
(org.gradle.api.Project project) |
| Type | Name and description |
|---|---|
void |
details(groovy.lang.Closure cl)Configures the PythonDetails for the project. |
void |
forceVersion(java.lang.String group, java.lang.String name, java.lang.String version) |
void |
forceVersion(java.lang.String gav) |
PythonDetails |
getDetails() |
java.util.Map<java.lang.String, java.lang.Object> |
getEnvironment() |
java.io.File |
getPinnedFile() |
void |
setPinnedFile(java.io.File pinnedFile) |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
The location of this project's Sphinx documentation directory.
A way to define forced versions of libraries
The name of the pinned requirements file.
Settings that can be put into the pip.conf file in the venv
The environment to use for all Python commands.
The environment to use for Python commands run on the project being developed.
This environment only applies to the project being developed. In other
words, this environment will only be passed to commands that use a
setup.py file.
The location of this project's setup.cfg file.
The location of this project's source directory.
The location of this project's tests directory.
Configures the PythonDetails for the project.
a - groovy.lang.Closure that will delegate to PythonDetails