harnest.compatibility

All Python modules · Import and compatibility guidance

Exports

Name	Kind
`FRAMEWORK_COMPATIBILITY`	Value or type alias
`FrameworkCompatibility`	Class
`FrameworkCompatibilityError`	Class
`ResolvedFrameworkCompatibility`	Class
`current_harnest_version`	Function
`validate_framework_compatibility`	Function

FRAMEWORK_COMPATIBILITY

FRAMEWORK_COMPATIBILITY = mappingproxy({'adk': FrameworkCompatibility(framework='adk', distribution='google-adk', versions='>=2.8,<3', install_extra='adk'), 'langgraph': FrameworkCompatibility(framework='langgraph', distribution='langgraph', versions='>=1.2,<2', install_extra='langgraph')})

Example

from harnest.compatibility import FRAMEWORK_COMPATIBILITY

FrameworkCompatibility

Supported distribution range for one framework backend.

FrameworkCompatibility(framework: str, distribution: str, versions: str, install_extra: str) -> None

Fields (— means no declared default):

Field	Type	Default
`framework`	`str`	`—`
`distribution`	`str`	`—`
`versions`	`str`	`—`
`install_extra`	`str`	`—`

Parameters and example

Parameter	Type	Default
`framework`	`str`	Required
`distribution`	`str`	Required
`versions`	`str`	Required
`install_extra`	`str`	Required

from harnest.compatibility import FrameworkCompatibility

compatibility = FrameworkCompatibility(
    framework=...,
    distribution=...,
    versions=...,
    install_extra=...,
)

FrameworkCompatibilityError

An installed framework is absent or unsupported by this release.

Example

from harnest.compatibility import FrameworkCompatibilityError

try:
    ...
except FrameworkCompatibilityError as error:
    ...

ResolvedFrameworkCompatibility

Versions resolved and validated for one compilation.

ResolvedFrameworkCompatibility(
    harnest_version: str,
    framework: str,
    distribution: str,
    distribution_version: str,
    supported_versions: str,
) -> None

Fields (— means no declared default):

Field	Type	Default
`harnest_version`	`str`	`—`
`framework`	`str`	`—`
`distribution`	`str`	`—`
`distribution_version`	`str`	`—`
`supported_versions`	`str`	`—`

Parameters and example

Parameter	Type	Default
`harnest_version`	`str`	Required
`framework`	`str`	Required
`distribution`	`str`	Required
`distribution_version`	`str`	Required
`supported_versions`	`str`	Required

from harnest.compatibility import ResolvedFrameworkCompatibility

compatibility = ResolvedFrameworkCompatibility(
    harnest_version=...,
    framework=...,
    distribution=...,
    distribution_version=...,
    supported_versions=...,
)

current_harnest_version

Return the installed Harnest distribution version. The fallback keeps source-tree execution useful before an editable install; release automation must keep it aligned with pyproject.toml.

current_harnest_version() -> str

Example

from harnest.compatibility import current_harnest_version

result = current_harnest_version()

validate_framework_compatibility

Resolve and validate the framework distribution installed at compile time.

validate_framework_compatibility(framework: str) -> ResolvedFrameworkCompatibility

Parameters and example

Parameter	Type	Default
`framework`	`str`	Required

from harnest.compatibility import validate_framework_compatibility

compatibility = validate_framework_compatibility(framework=...)

Overview

Get started

Harnest Studio

Guides

API reference

harnest.compatibility

Exports

FRAMEWORK_COMPATIBILITY

FrameworkCompatibility

FrameworkCompatibilityError

ResolvedFrameworkCompatibility

current_harnest_version

validate_framework_compatibility

​Exports

​FRAMEWORK_COMPATIBILITY

​FrameworkCompatibility

​FrameworkCompatibilityError

​ResolvedFrameworkCompatibility

​current_harnest_version

​validate_framework_compatibility

Exports

FRAMEWORK_COMPATIBILITY

FrameworkCompatibility

FrameworkCompatibilityError

ResolvedFrameworkCompatibility

current_harnest_version

validate_framework_compatibility