aiq.registry_handlers.schemas.pull#

Attributes#

Classes#

PulledPackage

Represents a data model of a pulled package containing the package wheel and its name.

PullResponse

Represents a data model of the expected respones from a AgentIQ pull request, including detailed status information.

PullPackageWhl

Local path to wheel (.whl) file.

PullRequestPackage

Represents all data for a single package needed to download an install its components.

PullRequestPackages

Represents a list of all packages th download and install in the local AgentIQ environment.

Module Contents#

logger#
class PulledPackage(/, **data: Any)#

Bases: pydantic.BaseModel

Represents a data model of a pulled package containing the package wheel and its name.

Args:

whl (str): Base64 encoded string of the AgentIQ python package wheel (.whl). whl_name (str): A string representing the wheel filename.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

whl: str#
whl_name: str#
class PullResponse(/, **data: Any)#

Bases: pydantic.BaseModel

Represents a data model of the expected respones from a AgentIQ pull request, including detailed status information.

Args:

packages (list[PulledPackage]): A list of pulled packages included in the pull request. status (StatusMessage): Provides metadata describing the success or errors that occurred when making to pull in a package.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

packages: list[PulledPackage] = []#
status: aiq.registry_handlers.schemas.status.StatusMessage#
class PullPackageWhl(/, **data: Any)#

Bases: pydantic.BaseModel

Local path to wheel (.whl) file.

Args:

whl_path (str): The local path the wheel (.whl) file.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

whl_path: str#
class PullRequestPackage(/, **data: Any)#

Bases: pydantic.BaseModel

Represents all data for a single package needed to download an install its components.

Args:
package (typing.Union[PackageNameVersion, PullPackageWhl]): Attributes of a single package necessary

to download and install its components.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

package: aiq.registry_handlers.schemas.package.PackageNameVersion | PullPackageWhl#
class PullRequestPackages(/, **data: Any)#

Bases: pydantic.BaseModel

Represents a list of all packages th download and install in the local AgentIQ environment.

Args:
packages (list[typing.Union[PackageNameVersion, PullPackageWhl]]): A list of packages that can be

downloaded and installed in the local AgentIQ environment.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

packages: list[aiq.registry_handlers.schemas.package.PackageNameVersion | PullPackageWhl]#