hydra.gradle module

Build configuration for Gradle-built distribution packages.

class hydra.gradle.AntlrConfig(arguments: Annotated[Sequence[str], 'Arguments passed to the ANTLR tool, e.g. ["-visitor"] or ["-visitor", "-listener"]. Faithful to ANTLR\'s command-line interface; covers all ANTLR flags without enumerating them.'], output_directory: Annotated[FilePath, 'Directory into which ANTLR emits generated lexer/parser sources, relative to the package root (e.g. "build/generated-src/antlr/main"). The host also folds this into the main source set.'])

Bases: object

Configuration for the Gradle antlr plugin’s grammar generation (generateGrammarSource).

ARGUMENTS = Name(value='arguments')

class Builder(_arguments: 'Sequence[str]' = None, _output_directory: 'hydra.file.FilePath' = None)

Bases: object

arguments(arguments)

build()

output_directory(output_directory)

OUTPUT_DIRECTORY = Name(value='outputDirectory')

TYPE_ = Name(value='hydra.gradle.AntlrConfig')

arguments: Annotated[Sequence[str], 'Arguments passed to the ANTLR tool, e.g. ["-visitor"] or ["-visitor", "-listener"]. Faithful to ANTLR\'s command-line interface; covers all ANTLR flags without enumerating them.']

static builder()

output_directory: Annotated[FilePath, 'Directory into which ANTLR emits generated lexer/parser sources, relative to the package root (e.g. "build/generated-src/antlr/main"). The host also folds this into the main source set.']

with_arguments(arguments)

with_output_directory(output_directory)

class hydra.gradle.GradleBuildConfiguration(dependencies: Annotated[Sequence[PackageDependency], "Third-party (non-project) dependencies required by the package. Inter-package dependencies within the project are derived separately and are not listed here. Each dependency's scope (api/runtime/test/tool) is significant; its name carries the Maven group and artifact separated by a colon."], excludes: Annotated[Sequence[str], 'Source paths or patterns to exclude from compilation, relative to the package root.'], extra_source_dirs: Annotated[Sequence[FilePath], "Additional source directories to fold into the package's main source set, beyond the generated and overlaid sources (e.g. a directory of build-tool-generated sources)."], plugins: Annotated[Sequence[str], 'Gradle plugin identifiers to apply to the build, e.g. "antlr". Applied in the given order.'], antlr: Annotated[object, 'ANTLR grammar-generation configuration, present when the package uses the antlr plugin. When given, the host emits the generateGrammarSource configuration and the compileJava-depends-on-generateGrammarSource ordering. Modeled as structured vocabulary rather than a raw Groovy fragment.'])

Bases: object

The build configuration for a single Gradle-built distribution package, beyond its generated sources.

ANTLR = Name(value='antlr')

class Builder(_dependencies: 'Sequence[hydra.packaging.PackageDependency]' = None, _excludes: 'Sequence[str]' = None, _extra_source_dirs: 'Sequence[hydra.file.FilePath]' = None, _plugins: 'Sequence[str]' = None, _antlr: 'Optional[AntlrConfig]' = None)

Bases: object

antlr(antlr)

build()

dependencies(dependencies)

excludes(excludes)

extra_source_dirs(extra_source_dirs)

plugins(plugins)

DEPENDENCIES = Name(value='dependencies')

EXCLUDES = Name(value='excludes')

EXTRA_SOURCE_DIRS = Name(value='extraSourceDirs')

PLUGINS = Name(value='plugins')

TYPE_ = Name(value='hydra.gradle.GradleBuildConfiguration')

antlr: Annotated[object, 'ANTLR grammar-generation configuration, present when the package uses the antlr plugin. When given, the host emits the generateGrammarSource configuration and the compileJava-depends-on-generateGrammarSource ordering. Modeled as structured vocabulary rather than a raw Groovy fragment.']

static builder()

dependencies: Annotated[Sequence[PackageDependency], "Third-party (non-project) dependencies required by the package. Inter-package dependencies within the project are derived separately and are not listed here. Each dependency's scope (api/runtime/test/tool) is significant; its name carries the Maven group and artifact separated by a colon."]

excludes: Annotated[Sequence[str], 'Source paths or patterns to exclude from compilation, relative to the package root.']

extra_source_dirs: Annotated[Sequence[FilePath], "Additional source directories to fold into the package's main source set, beyond the generated and overlaid sources (e.g. a directory of build-tool-generated sources)."]

plugins: Annotated[Sequence[str], 'Gradle plugin identifiers to apply to the build, e.g. "antlr". Applied in the given order.']

with_antlr(antlr)

with_dependencies(dependencies)

with_excludes(excludes)

with_extra_source_dirs(extra_source_dirs)

with_plugins(plugins)