Dagger
Search

python

No long description provided.

Installation

dagger install github.com/felipepimentel/daggerverse/python@v1.4.0

Entrypoint

Return Type 
Python
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \

func (m *MyModule) Example() *dagger.Python  {
	return dag.
			Python()
}
@function
def example() -> dagger.Python:
	return (
		dag.python()
	)
@func()
example(): Python {
	return dag
		.python()
}

Types

Python 🔗

Python represents a Python module with Poetry support

pythonVersion() 🔗

PythonVersion specifies the Python version to use (default: “3.12”)

Return Type 
String !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 python-version
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Python().
			PythonVersion(ctx)
}
@function
async def example() -> str:
	return await (
		dag.python()
		.python_version()
	)
@func()
async example(): Promise<string> {
	return dag
		.python()
		.pythonVersion()
}

packagePath() 🔗

PackagePath specifies the path to the package within the source (default: “.”)

Return Type 
String !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 package-path
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Python().
			PackagePath(ctx)
}
@function
async def example() -> str:
	return await (
		dag.python()
		.package_path()
	)
@func()
async example(): Promise<string> {
	return dag
		.python()
		.packagePath()
}

pyPiconfig() 🔗

PyPIConfig holds the PyPI deployment configuration

Return Type 
PyPiconfig !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 py-piconfig
func (m *MyModule) Example() *dagger.PythonPyPiconfig  {
	return dag.
			Python().
			PyPiconfig()
}
@function
def example() -> dagger.PythonPyPiconfig:
	return (
		dag.python()
		.py_piconfig()
	)
@func()
example(): PythonPyPiconfig {
	return dag
		.python()
		.pyPiconfig()
}

testConfig() 🔗

TestConfig holds the test configuration

Return Type 
TestConfig !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 test-config
func (m *MyModule) Example() *dagger.PythonTestConfig  {
	return dag.
			Python().
			TestConfig()
}
@function
def example() -> dagger.PythonTestConfig:
	return (
		dag.python()
		.test_config()
	)
@func()
example(): PythonTestConfig {
	return dag
		.python()
		.testConfig()
}

buildConfig() 🔗

BuildConfig holds the build configuration

Return Type 
BuildConfig !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 build-config
func (m *MyModule) Example() *dagger.PythonBuildConfig  {
	return dag.
			Python().
			BuildConfig()
}
@function
def example() -> dagger.PythonBuildConfig:
	return (
		dag.python()
		.build_config()
	)
@func()
example(): PythonBuildConfig {
	return dag
		.python()
		.buildConfig()
}

lintConfig() 🔗

LintConfig holds the linting configuration

Return Type 
LintConfig !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 lint-config
func (m *MyModule) Example() *dagger.PythonLintConfig  {
	return dag.
			Python().
			LintConfig()
}
@function
def example() -> dagger.PythonLintConfig:
	return (
		dag.python()
		.lint_config()
	)
@func()
example(): PythonLintConfig {
	return dag
		.python()
		.lintConfig()
}

formatConfig() 🔗

FormatConfig holds the formatting configuration

Return Type 
FormatConfig !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 format-config
func (m *MyModule) Example() *dagger.PythonFormatConfig  {
	return dag.
			Python().
			FormatConfig()
}
@function
def example() -> dagger.PythonFormatConfig:
	return (
		dag.python()
		.format_config()
	)
@func()
example(): PythonFormatConfig {
	return dag
		.python()
		.formatConfig()
}

docsConfig() 🔗

DocsConfig holds the documentation configuration

Return Type 
DocsConfig !
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 docs-config
func (m *MyModule) Example() *dagger.PythonDocsConfig  {
	return dag.
			Python().
			DocsConfig()
}
@function
def example() -> dagger.PythonDocsConfig:
	return (
		dag.python()
		.docs_config()
	)
@func()
example(): PythonDocsConfig {
	return dag
		.python()
		.docsConfig()
}

withPythonVersion() 🔗

WithPythonVersion sets the Python version to use

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
versionString !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 with-python-version --version string
func (m *MyModule) Example(version string) *dagger.Python  {
	return dag.
			Python().
			WithPythonVersion(version)
}
@function
def example(version: str) -> dagger.Python:
	return (
		dag.python()
		.with_python_version(version)
	)
@func()
example(version: string): Python {
	return dag
		.python()
		.withPythonVersion(version)
}

withPackagePath() 🔗

WithPackagePath sets the package path within the source

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
pathString !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 with-package-path --path string
func (m *MyModule) Example(path string) *dagger.Python  {
	return dag.
			Python().
			WithPackagePath(path)
}
@function
def example(path: str) -> dagger.Python:
	return (
		dag.python()
		.with_package_path(path)
	)
@func()
example(path: string): Python {
	return dag
		.python()
		.withPackagePath(path)
}

withPyPiconfig() 🔗

WithPyPIConfig sets the PyPI deployment configuration

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
configPyPiconfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.PythonPyPiconfig) *dagger.Python  {
	return dag.
			Python().
			WithPyPiconfig(config)
}
@function
def example(config: dagger.PythonPyPiconfig) -> dagger.Python:
	return (
		dag.python()
		.with_py_piconfig(config)
	)
@func()
example(config: PythonPyPiconfig): Python {
	return dag
		.python()
		.withPyPiconfig(config)
}

withTestConfig() 🔗

WithTestConfig sets the test configuration

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
configTestConfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.PythonTestConfig) *dagger.Python  {
	return dag.
			Python().
			WithTestConfig(config)
}
@function
def example(config: dagger.PythonTestConfig) -> dagger.Python:
	return (
		dag.python()
		.with_test_config(config)
	)
@func()
example(config: PythonTestConfig): Python {
	return dag
		.python()
		.withTestConfig(config)
}

withBuildConfig() 🔗

WithBuildConfig sets the build configuration

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
configBuildConfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.PythonBuildConfig) *dagger.Python  {
	return dag.
			Python().
			WithBuildConfig(config)
}
@function
def example(config: dagger.PythonBuildConfig) -> dagger.Python:
	return (
		dag.python()
		.with_build_config(config)
	)
@func()
example(config: PythonBuildConfig): Python {
	return dag
		.python()
		.withBuildConfig(config)
}

withLintConfig() 🔗

WithLintConfig sets the linting configuration

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
configLintConfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.PythonLintConfig) *dagger.Python  {
	return dag.
			Python().
			WithLintConfig(config)
}
@function
def example(config: dagger.PythonLintConfig) -> dagger.Python:
	return (
		dag.python()
		.with_lint_config(config)
	)
@func()
example(config: PythonLintConfig): Python {
	return dag
		.python()
		.withLintConfig(config)
}

withFormatConfig() 🔗

WithFormatConfig sets the formatting configuration

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
configFormatConfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.PythonFormatConfig) *dagger.Python  {
	return dag.
			Python().
			WithFormatConfig(config)
}
@function
def example(config: dagger.PythonFormatConfig) -> dagger.Python:
	return (
		dag.python()
		.with_format_config(config)
	)
@func()
example(config: PythonFormatConfig): Python {
	return dag
		.python()
		.withFormatConfig(config)
}

withDocsConfig() 🔗

WithDocsConfig sets the documentation configuration

Return Type 
Python !
Arguments
NameTypeDefault ValueDescription
configDocsConfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.PythonDocsConfig) *dagger.Python  {
	return dag.
			Python().
			WithDocsConfig(config)
}
@function
def example(config: dagger.PythonDocsConfig) -> dagger.Python:
	return (
		dag.python()
		.with_docs_config(config)
	)
@func()
example(config: PythonDocsConfig): Python {
	return dag
		.python()
		.withDocsConfig(config)
}

publish() 🔗

Publish builds, tests and publishes the Python package to a registry

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
tokenSecret !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 publish --source DIR_PATH --token env:MYSECRET
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory, token *dagger.Secret) string  {
	return dag.
			Python().
			Publish(ctx, source, token)
}
@function
async def example(source: dagger.Directory, token: dagger.Secret) -> str:
	return await (
		dag.python()
		.publish(source, token)
	)
@func()
async example(source: Directory, token: Secret): Promise<string> {
	return dag
		.python()
		.publish(source, token)
}

build() 🔗

Build creates a Python package using Poetry

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 build --source DIR_PATH
func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			Python().
			Build(source)
}
@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.python()
		.build(source)
	)
@func()
example(source: Directory): Container {
	return dag
		.python()
		.build(source)
}

test() 🔗

Test runs the test suite using pytest with coverage reporting

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 test --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Python().
			Test(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.python()
		.test(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.python()
		.test(source)
}

buildEnv() 🔗

BuildEnv prepares a Python development environment with Poetry

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 build-env --source DIR_PATH
func (m *MyModule) Example(source *dagger.Directory) *dagger.Container  {
	return dag.
			Python().
			BuildEnv(source)
}
@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.python()
		.build_env(source)
	)
@func()
example(source: Directory): Container {
	return dag
		.python()
		.buildEnv(source)
}

lint() 🔗

Lint runs code linting using ruff

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 lint --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Python().
			Lint(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.python()
		.lint(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.python()
		.lint(source)
}

format() 🔗

Format runs code formatting using black

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 format --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Python().
			Format(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.python()
		.format(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.python()
		.format(source)
}

buildDocs() 🔗

BuildDocs generates documentation using Sphinx or MkDocs

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/python@f6f4cbf96252f2d7003fb4b6b232d585247665e3 call \
 build-docs --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Python().
			BuildDocs(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.python()
		.build_docs(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.python()
		.buildDocs(source)
}

PyPiconfig 🔗

PyPIConfig holds PyPI deployment configuration

registry() 🔗

Registry URL (default: https://upload.pypi.org/legacy/)

Return Type 
String !
Example
Function PythonPyPiconfig.registry is not accessible from the python module
Function PythonPyPiconfig.registry is not accessible from the python module
Function PythonPyPiconfig.registry is not accessible from the python module
Function PythonPyPiconfig.registry is not accessible from the python module

token() 🔗

Token for authentication

Return Type 
Secret !
Example
Function PythonPyPiconfig.token is not accessible from the python module
Function PythonPyPiconfig.token is not accessible from the python module
Function PythonPyPiconfig.token is not accessible from the python module
Function PythonPyPiconfig.token is not accessible from the python module

skipExisting() 🔗

Skip existing versions (default: false)

Return Type 
Boolean !
Example
Function PythonPyPiconfig.skipExisting is not accessible from the python module
Function PythonPyPiconfig.skipExisting is not accessible from the python module
Function PythonPyPiconfig.skipExisting is not accessible from the python module
Function PythonPyPiconfig.skipExisting is not accessible from the python module

allowDirty() 🔗

Allow dirty versions (default: false)

Return Type 
Boolean !
Example
Function PythonPyPiconfig.allowDirty is not accessible from the python module
Function PythonPyPiconfig.allowDirty is not accessible from the python module
Function PythonPyPiconfig.allowDirty is not accessible from the python module
Function PythonPyPiconfig.allowDirty is not accessible from the python module

extraArgs() 🔗

Additional publish arguments

Return Type 
[String ! ] !
Example
Function PythonPyPiconfig.extraArgs is not accessible from the python module
Function PythonPyPiconfig.extraArgs is not accessible from the python module
Function PythonPyPiconfig.extraArgs is not accessible from the python module
Function PythonPyPiconfig.extraArgs is not accessible from the python module

env() 🔗

Environment variables for publishing

Return Type 
[KeyValue ! ] !
Example
Function PythonPyPiconfig.env is not accessible from the python module
Function PythonPyPiconfig.env is not accessible from the python module
Function PythonPyPiconfig.env is not accessible from the python module
Function PythonPyPiconfig.env is not accessible from the python module

repositoryName() 🔗

Repository name in Poetry config (default: “pypi”)

Return Type 
String !
Example
Function PythonPyPiconfig.repositoryName is not accessible from the python module
Function PythonPyPiconfig.repositoryName is not accessible from the python module
Function PythonPyPiconfig.repositoryName is not accessible from the python module
Function PythonPyPiconfig.repositoryName is not accessible from the python module

skipBuild() 🔗

Skip build before publishing (default: false)

Return Type 
Boolean !
Example
Function PythonPyPiconfig.skipBuild is not accessible from the python module
Function PythonPyPiconfig.skipBuild is not accessible from the python module
Function PythonPyPiconfig.skipBuild is not accessible from the python module
Function PythonPyPiconfig.skipBuild is not accessible from the python module

skipVerify() 🔗

Skip verification before publishing (default: false)

Return Type 
Boolean !
Example
Function PythonPyPiconfig.skipVerify is not accessible from the python module
Function PythonPyPiconfig.skipVerify is not accessible from the python module
Function PythonPyPiconfig.skipVerify is not accessible from the python module
Function PythonPyPiconfig.skipVerify is not accessible from the python module

TestConfig 🔗

TestConfig holds pytest configuration options

verbose() 🔗

Verbose output (default: true)

Return Type 
Boolean !
Example
Function PythonTestConfig.verbose is not accessible from the python module
Function PythonTestConfig.verbose is not accessible from the python module
Function PythonTestConfig.verbose is not accessible from the python module
Function PythonTestConfig.verbose is not accessible from the python module

workers() 🔗

Number of parallel workers (default: auto)

Return Type 
Integer !
Example
Function PythonTestConfig.workers is not accessible from the python module
Function PythonTestConfig.workers is not accessible from the python module
Function PythonTestConfig.workers is not accessible from the python module
Function PythonTestConfig.workers is not accessible from the python module

coverage() 🔗

Coverage configuration

Return Type 
CoverageConfig !
Example
Function PythonTestConfig.coverage is not accessible from the python module
Function PythonTestConfig.coverage is not accessible from the python module
Function PythonTestConfig.coverage is not accessible from the python module
Function PythonTestConfig.coverage is not accessible from the python module

extraArgs() 🔗

Additional pytest arguments

Return Type 
[String ! ] !
Example
Function PythonTestConfig.extraArgs is not accessible from the python module
Function PythonTestConfig.extraArgs is not accessible from the python module
Function PythonTestConfig.extraArgs is not accessible from the python module
Function PythonTestConfig.extraArgs is not accessible from the python module

env() 🔗

Environment variables for tests

Return Type 
[KeyValue ! ] !
Example
Function PythonTestConfig.env is not accessible from the python module
Function PythonTestConfig.env is not accessible from the python module
Function PythonTestConfig.env is not accessible from the python module
Function PythonTestConfig.env is not accessible from the python module

markers() 🔗

Test markers to select

Return Type 
[String ! ] !
Example
Function PythonTestConfig.markers is not accessible from the python module
Function PythonTestConfig.markers is not accessible from the python module
Function PythonTestConfig.markers is not accessible from the python module
Function PythonTestConfig.markers is not accessible from the python module

testPaths() 🔗

Test paths to run (default: “.”)

Return Type 
[String ! ] !
Example
Function PythonTestConfig.testPaths is not accessible from the python module
Function PythonTestConfig.testPaths is not accessible from the python module
Function PythonTestConfig.testPaths is not accessible from the python module
Function PythonTestConfig.testPaths is not accessible from the python module

skipInstall() 🔗

Skip installing test dependencies (default: false)

Return Type 
Boolean !
Example
Function PythonTestConfig.skipInstall is not accessible from the python module
Function PythonTestConfig.skipInstall is not accessible from the python module
Function PythonTestConfig.skipInstall is not accessible from the python module
Function PythonTestConfig.skipInstall is not accessible from the python module

junitXml() 🔗

JUnit XML report path

Return Type 
String !
Example
Function PythonTestConfig.junitXml is not accessible from the python module
Function PythonTestConfig.junitXml is not accessible from the python module
Function PythonTestConfig.junitXml is not accessible from the python module
Function PythonTestConfig.junitXml is not accessible from the python module

maxTestTime() 🔗

Maximum test duration in seconds (0 for no limit)

Return Type 
Integer !
Example
Function PythonTestConfig.maxTestTime is not accessible from the python module
Function PythonTestConfig.maxTestTime is not accessible from the python module
Function PythonTestConfig.maxTestTime is not accessible from the python module
Function PythonTestConfig.maxTestTime is not accessible from the python module

failFast() 🔗

Stop on first failure (default: false)

Return Type 
Boolean !
Example
Function PythonTestConfig.failFast is not accessible from the python module
Function PythonTestConfig.failFast is not accessible from the python module
Function PythonTestConfig.failFast is not accessible from the python module
Function PythonTestConfig.failFast is not accessible from the python module

BuildConfig 🔗

BuildConfig holds Poetry build configuration

buildArgs() 🔗

Additional build arguments

Return Type 
[String ! ] !
Example
Function PythonBuildConfig.buildArgs is not accessible from the python module
Function PythonBuildConfig.buildArgs is not accessible from the python module
Function PythonBuildConfig.buildArgs is not accessible from the python module
Function PythonBuildConfig.buildArgs is not accessible from the python module

extraDependencies() 🔗

Additional dependencies to install

Return Type 
[String ! ] !
Example
Function PythonBuildConfig.extraDependencies is not accessible from the python module
Function PythonBuildConfig.extraDependencies is not accessible from the python module
Function PythonBuildConfig.extraDependencies is not accessible from the python module
Function PythonBuildConfig.extraDependencies is not accessible from the python module

poetryConfig() 🔗

Poetry configuration options

Return Type 
[KeyValue ! ] !
Example
Function PythonBuildConfig.poetryConfig is not accessible from the python module
Function PythonBuildConfig.poetryConfig is not accessible from the python module
Function PythonBuildConfig.poetryConfig is not accessible from the python module
Function PythonBuildConfig.poetryConfig is not accessible from the python module

env() 🔗

Environment variables for build

Return Type 
[KeyValue ! ] !
Example
Function PythonBuildConfig.env is not accessible from the python module
Function PythonBuildConfig.env is not accessible from the python module
Function PythonBuildConfig.env is not accessible from the python module
Function PythonBuildConfig.env is not accessible from the python module

cache() 🔗

Cache configuration

Return Type 
CacheConfig !
Example
Function PythonBuildConfig.cache is not accessible from the python module
Function PythonBuildConfig.cache is not accessible from the python module
Function PythonBuildConfig.cache is not accessible from the python module
Function PythonBuildConfig.cache is not accessible from the python module

dependencyGroups() 🔗

Poetry dependency groups to install (default: [“dev”])

Return Type 
[String ! ] !
Example
Function PythonBuildConfig.dependencyGroups is not accessible from the python module
Function PythonBuildConfig.dependencyGroups is not accessible from the python module
Function PythonBuildConfig.dependencyGroups is not accessible from the python module
Function PythonBuildConfig.dependencyGroups is not accessible from the python module

optionalDependencies() 🔗

Poetry optional dependencies to install

Return Type 
[String ! ] !
Example
Function PythonBuildConfig.optionalDependencies is not accessible from the python module
Function PythonBuildConfig.optionalDependencies is not accessible from the python module
Function PythonBuildConfig.optionalDependencies is not accessible from the python module
Function PythonBuildConfig.optionalDependencies is not accessible from the python module

skipDependencies() 🔗

Skip installing dependencies (default: false)

Return Type 
Boolean !
Example
Function PythonBuildConfig.skipDependencies is not accessible from the python module
Function PythonBuildConfig.skipDependencies is not accessible from the python module
Function PythonBuildConfig.skipDependencies is not accessible from the python module
Function PythonBuildConfig.skipDependencies is not accessible from the python module

onlyGroups() 🔗

Install only selected dependency groups (default: false)

Return Type 
Boolean !
Example
Function PythonBuildConfig.onlyGroups is not accessible from the python module
Function PythonBuildConfig.onlyGroups is not accessible from the python module
Function PythonBuildConfig.onlyGroups is not accessible from the python module
Function PythonBuildConfig.onlyGroups is not accessible from the python module

skipRoot() 🔗

Skip installing the root package (default: true)

Return Type 
Boolean !
Example
Function PythonBuildConfig.skipRoot is not accessible from the python module
Function PythonBuildConfig.skipRoot is not accessible from the python module
Function PythonBuildConfig.skipRoot is not accessible from the python module
Function PythonBuildConfig.skipRoot is not accessible from the python module

LintConfig 🔗

LintConfig holds configuration for code linting

enabled() 🔗

Enable ruff linting (default: true)

Return Type 
Boolean !
Example
Function PythonLintConfig.enabled is not accessible from the python module
Function PythonLintConfig.enabled is not accessible from the python module
Function PythonLintConfig.enabled is not accessible from the python module
Function PythonLintConfig.enabled is not accessible from the python module

select() 🔗

Linting rules to enable

Return Type 
[String ! ] !
Example
Function PythonLintConfig.select is not accessible from the python module
Function PythonLintConfig.select is not accessible from the python module
Function PythonLintConfig.select is not accessible from the python module
Function PythonLintConfig.select is not accessible from the python module

ignore() 🔗

Linting rules to ignore

Return Type 
[String ! ] !
Example
Function PythonLintConfig.ignore is not accessible from the python module
Function PythonLintConfig.ignore is not accessible from the python module
Function PythonLintConfig.ignore is not accessible from the python module
Function PythonLintConfig.ignore is not accessible from the python module

exclude() 🔗

Files or directories to exclude

Return Type 
[String ! ] !
Example
Function PythonLintConfig.exclude is not accessible from the python module
Function PythonLintConfig.exclude is not accessible from the python module
Function PythonLintConfig.exclude is not accessible from the python module
Function PythonLintConfig.exclude is not accessible from the python module

lineLength() 🔗

Maximum line length (default: 88)

Return Type 
Integer !
Example
Function PythonLintConfig.lineLength is not accessible from the python module
Function PythonLintConfig.lineLength is not accessible from the python module
Function PythonLintConfig.lineLength is not accessible from the python module
Function PythonLintConfig.lineLength is not accessible from the python module

fix() 🔗

Fix issues automatically (default: false)

Return Type 
Boolean !
Example
Function PythonLintConfig.fix is not accessible from the python module
Function PythonLintConfig.fix is not accessible from the python module
Function PythonLintConfig.fix is not accessible from the python module
Function PythonLintConfig.fix is not accessible from the python module

showSource() 🔗

Show source code for each error (default: true)

Return Type 
Boolean !
Example
Function PythonLintConfig.showSource is not accessible from the python module
Function PythonLintConfig.showSource is not accessible from the python module
Function PythonLintConfig.showSource is not accessible from the python module
Function PythonLintConfig.showSource is not accessible from the python module

format() 🔗

Format output (options: text, json, junit)

Return Type 
String !
Example
Function PythonLintConfig.format is not accessible from the python module
Function PythonLintConfig.format is not accessible from the python module
Function PythonLintConfig.format is not accessible from the python module
Function PythonLintConfig.format is not accessible from the python module

output() 🔗

Output file path

Return Type 
String !
Example
Function PythonLintConfig.output is not accessible from the python module
Function PythonLintConfig.output is not accessible from the python module
Function PythonLintConfig.output is not accessible from the python module
Function PythonLintConfig.output is not accessible from the python module

extraArgs() 🔗

Additional ruff arguments

Return Type 
[String ! ] !
Example
Function PythonLintConfig.extraArgs is not accessible from the python module
Function PythonLintConfig.extraArgs is not accessible from the python module
Function PythonLintConfig.extraArgs is not accessible from the python module
Function PythonLintConfig.extraArgs is not accessible from the python module

FormatConfig 🔗

FormatConfig holds configuration for code formatting

enabled() 🔗

Enable black formatting (default: true)

Return Type 
Boolean !
Example
Function PythonFormatConfig.enabled is not accessible from the python module
Function PythonFormatConfig.enabled is not accessible from the python module
Function PythonFormatConfig.enabled is not accessible from the python module
Function PythonFormatConfig.enabled is not accessible from the python module

lineLength() 🔗

Line length (default: 88)

Return Type 
Integer !
Example
Function PythonFormatConfig.lineLength is not accessible from the python module
Function PythonFormatConfig.lineLength is not accessible from the python module
Function PythonFormatConfig.lineLength is not accessible from the python module
Function PythonFormatConfig.lineLength is not accessible from the python module

skipStringNormalization() 🔗

Skip string normalization (default: false)

Return Type 
Boolean !
Example
Function PythonFormatConfig.skipStringNormalization is not accessible from the python module
Function PythonFormatConfig.skipStringNormalization is not accessible from the python module
Function PythonFormatConfig.skipStringNormalization is not accessible from the python module
Function PythonFormatConfig.skipStringNormalization is not accessible from the python module

targetVersion() 🔗

Target specific Python versions

Return Type 
[String ! ] !
Example
Function PythonFormatConfig.targetVersion is not accessible from the python module
Function PythonFormatConfig.targetVersion is not accessible from the python module
Function PythonFormatConfig.targetVersion is not accessible from the python module
Function PythonFormatConfig.targetVersion is not accessible from the python module

include() 🔗

Include files/patterns

Return Type 
[String ! ] !
Example
Function PythonFormatConfig.include is not accessible from the python module
Function PythonFormatConfig.include is not accessible from the python module
Function PythonFormatConfig.include is not accessible from the python module
Function PythonFormatConfig.include is not accessible from the python module

exclude() 🔗

Exclude files/patterns

Return Type 
[String ! ] !
Example
Function PythonFormatConfig.exclude is not accessible from the python module
Function PythonFormatConfig.exclude is not accessible from the python module
Function PythonFormatConfig.exclude is not accessible from the python module
Function PythonFormatConfig.exclude is not accessible from the python module

check() 🔗

Check only (no changes) (default: false)

Return Type 
Boolean !
Example
Function PythonFormatConfig.check is not accessible from the python module
Function PythonFormatConfig.check is not accessible from the python module
Function PythonFormatConfig.check is not accessible from the python module
Function PythonFormatConfig.check is not accessible from the python module

showDiff() 🔗

Show diff of changes (default: true)

Return Type 
Boolean !
Example
Function PythonFormatConfig.showDiff is not accessible from the python module
Function PythonFormatConfig.showDiff is not accessible from the python module
Function PythonFormatConfig.showDiff is not accessible from the python module
Function PythonFormatConfig.showDiff is not accessible from the python module

extraArgs() 🔗

Additional black arguments

Return Type 
[String ! ] !
Example
Function PythonFormatConfig.extraArgs is not accessible from the python module
Function PythonFormatConfig.extraArgs is not accessible from the python module
Function PythonFormatConfig.extraArgs is not accessible from the python module
Function PythonFormatConfig.extraArgs is not accessible from the python module

DocsConfig 🔗

DocsConfig holds configuration for documentation generation

enabled() 🔗

Enable documentation generation (default: true)

Return Type 
Boolean !
Example
Function PythonDocsConfig.enabled is not accessible from the python module
Function PythonDocsConfig.enabled is not accessible from the python module
Function PythonDocsConfig.enabled is not accessible from the python module
Function PythonDocsConfig.enabled is not accessible from the python module

tool() 🔗

Documentation tool to use (options: sphinx, mkdocs)

Return Type 
String !
Example
Function PythonDocsConfig.tool is not accessible from the python module
Function PythonDocsConfig.tool is not accessible from the python module
Function PythonDocsConfig.tool is not accessible from the python module
Function PythonDocsConfig.tool is not accessible from the python module

sourceDir() 🔗

Documentation source directory (default: “docs”)

Return Type 
String !
Example
Function PythonDocsConfig.sourceDir is not accessible from the python module
Function PythonDocsConfig.sourceDir is not accessible from the python module
Function PythonDocsConfig.sourceDir is not accessible from the python module
Function PythonDocsConfig.sourceDir is not accessible from the python module

outputDir() 🔗

Documentation output directory (default: “site”)

Return Type 
String !
Example
Function PythonDocsConfig.outputDir is not accessible from the python module
Function PythonDocsConfig.outputDir is not accessible from the python module
Function PythonDocsConfig.outputDir is not accessible from the python module
Function PythonDocsConfig.outputDir is not accessible from the python module

format() 🔗

Documentation format (options: html, pdf, epub)

Return Type 
String !
Example
Function PythonDocsConfig.format is not accessible from the python module
Function PythonDocsConfig.format is not accessible from the python module
Function PythonDocsConfig.format is not accessible from the python module
Function PythonDocsConfig.format is not accessible from the python module

theme() 🔗

Documentation theme

Return Type 
String !
Example
Function PythonDocsConfig.theme is not accessible from the python module
Function PythonDocsConfig.theme is not accessible from the python module
Function PythonDocsConfig.theme is not accessible from the python module
Function PythonDocsConfig.theme is not accessible from the python module

projectName() 🔗

Project name

Return Type 
String !
Example
Function PythonDocsConfig.projectName is not accessible from the python module
Function PythonDocsConfig.projectName is not accessible from the python module
Function PythonDocsConfig.projectName is not accessible from the python module
Function PythonDocsConfig.projectName is not accessible from the python module

version() 🔗

Project version

Return Type 
String !
Example
Function PythonDocsConfig.version is not accessible from the python module
Function PythonDocsConfig.version is not accessible from the python module
Function PythonDocsConfig.version is not accessible from the python module
Function PythonDocsConfig.version is not accessible from the python module

author() 🔗

Project author

Return Type 
String !
Example
Function PythonDocsConfig.author is not accessible from the python module
Function PythonDocsConfig.author is not accessible from the python module
Function PythonDocsConfig.author is not accessible from the python module
Function PythonDocsConfig.author is not accessible from the python module

extensions() 🔗

Additional extensions to enable

Return Type 
[String ! ] !
Example
Function PythonDocsConfig.extensions is not accessible from the python module
Function PythonDocsConfig.extensions is not accessible from the python module
Function PythonDocsConfig.extensions is not accessible from the python module
Function PythonDocsConfig.extensions is not accessible from the python module

extraDependencies() 🔗

Additional dependencies to install

Return Type 
[String ! ] !
Example
Function PythonDocsConfig.extraDependencies is not accessible from the python module
Function PythonDocsConfig.extraDependencies is not accessible from the python module
Function PythonDocsConfig.extraDependencies is not accessible from the python module
Function PythonDocsConfig.extraDependencies is not accessible from the python module

env() 🔗

Environment variables for documentation build

Return Type 
[KeyValue ! ] !
Example
Function PythonDocsConfig.env is not accessible from the python module
Function PythonDocsConfig.env is not accessible from the python module
Function PythonDocsConfig.env is not accessible from the python module
Function PythonDocsConfig.env is not accessible from the python module

extraArgs() 🔗

Additional build arguments

Return Type 
[String ! ] !
Example
Function PythonDocsConfig.extraArgs is not accessible from the python module
Function PythonDocsConfig.extraArgs is not accessible from the python module
Function PythonDocsConfig.extraArgs is not accessible from the python module
Function PythonDocsConfig.extraArgs is not accessible from the python module

KeyValue 🔗

KeyValue represents a key-value pair

key() 🔗

Return Type 
String !
Example
Function PythonKeyValue.key is not accessible from the python module
Function PythonKeyValue.key is not accessible from the python module
Function PythonKeyValue.key is not accessible from the python module
Function PythonKeyValue.key is not accessible from the python module

value() 🔗

Return Type 
String !
Example
Function PythonKeyValue.value is not accessible from the python module
Function PythonKeyValue.value is not accessible from the python module
Function PythonKeyValue.value is not accessible from the python module
Function PythonKeyValue.value is not accessible from the python module

CoverageConfig 🔗

CoverageConfig holds coverage reporting configuration

enabled() 🔗

Enable coverage reporting (default: true)

Return Type 
Boolean !
Example
Function PythonCoverageConfig.enabled is not accessible from the python module
Function PythonCoverageConfig.enabled is not accessible from the python module
Function PythonCoverageConfig.enabled is not accessible from the python module
Function PythonCoverageConfig.enabled is not accessible from the python module

formats() 🔗

Coverage report formats (default: [“term”, “xml”])

Return Type 
[String ! ] !
Example
Function PythonCoverageConfig.formats is not accessible from the python module
Function PythonCoverageConfig.formats is not accessible from the python module
Function PythonCoverageConfig.formats is not accessible from the python module
Function PythonCoverageConfig.formats is not accessible from the python module

minCoverage() 🔗

Minimum coverage percentage (default: 0)

Return Type 
Integer !
Example
Function PythonCoverageConfig.minCoverage is not accessible from the python module
Function PythonCoverageConfig.minCoverage is not accessible from the python module
Function PythonCoverageConfig.minCoverage is not accessible from the python module
Function PythonCoverageConfig.minCoverage is not accessible from the python module

outputDir() 🔗

Coverage output directory (default: “coverage”)

Return Type 
String !
Example
Function PythonCoverageConfig.outputDir is not accessible from the python module
Function PythonCoverageConfig.outputDir is not accessible from the python module
Function PythonCoverageConfig.outputDir is not accessible from the python module
Function PythonCoverageConfig.outputDir is not accessible from the python module

include() 🔗

Paths to include in coverage

Return Type 
[String ! ] !
Example
Function PythonCoverageConfig.include is not accessible from the python module
Function PythonCoverageConfig.include is not accessible from the python module
Function PythonCoverageConfig.include is not accessible from the python module
Function PythonCoverageConfig.include is not accessible from the python module

exclude() 🔗

Paths to exclude from coverage

Return Type 
[String ! ] !
Example
Function PythonCoverageConfig.exclude is not accessible from the python module
Function PythonCoverageConfig.exclude is not accessible from the python module
Function PythonCoverageConfig.exclude is not accessible from the python module
Function PythonCoverageConfig.exclude is not accessible from the python module

showMissing() 🔗

Show missing lines in report (default: true)

Return Type 
Boolean !
Example
Function PythonCoverageConfig.showMissing is not accessible from the python module
Function PythonCoverageConfig.showMissing is not accessible from the python module
Function PythonCoverageConfig.showMissing is not accessible from the python module
Function PythonCoverageConfig.showMissing is not accessible from the python module

branch() 🔗

Branch coverage (default: false)

Return Type 
Boolean !
Example
Function PythonCoverageConfig.branch is not accessible from the python module
Function PythonCoverageConfig.branch is not accessible from the python module
Function PythonCoverageConfig.branch is not accessible from the python module
Function PythonCoverageConfig.branch is not accessible from the python module

context() 🔗

Context lines in report (default: 0)

Return Type 
Integer !
Example
Function PythonCoverageConfig.context is not accessible from the python module
Function PythonCoverageConfig.context is not accessible from the python module
Function PythonCoverageConfig.context is not accessible from the python module
Function PythonCoverageConfig.context is not accessible from the python module

CacheConfig 🔗

CacheConfig holds cache configuration

pipCache() 🔗

Enable pip cache (default: true)

Return Type 
Boolean !
Example
Function PythonCacheConfig.pipCache is not accessible from the python module
Function PythonCacheConfig.pipCache is not accessible from the python module
Function PythonCacheConfig.pipCache is not accessible from the python module
Function PythonCacheConfig.pipCache is not accessible from the python module

poetryCache() 🔗

Enable poetry cache (default: true)

Return Type 
Boolean !
Example
Function PythonCacheConfig.poetryCache is not accessible from the python module
Function PythonCacheConfig.poetryCache is not accessible from the python module
Function PythonCacheConfig.poetryCache is not accessible from the python module
Function PythonCacheConfig.poetryCache is not accessible from the python module

pipCacheVolume() 🔗

Custom cache volume names

Return Type 
String !
Example
Function PythonCacheConfig.pipCacheVolume is not accessible from the python module
Function PythonCacheConfig.pipCacheVolume is not accessible from the python module
Function PythonCacheConfig.pipCacheVolume is not accessible from the python module
Function PythonCacheConfig.pipCacheVolume is not accessible from the python module

poetryCacheVolume() 🔗

Return Type 
String !
Example
Function PythonCacheConfig.poetryCacheVolume is not accessible from the python module
Function PythonCacheConfig.poetryCacheVolume is not accessible from the python module
Function PythonCacheConfig.poetryCacheVolume is not accessible from the python module
Function PythonCacheConfig.poetryCacheVolume is not accessible from the python module