aiq.tool.github_tools.get_github_pr#

Classes#

`GithubListPullsModel`
`GithubListPullsModelList`
`GithubListPullsToolConfig`	Tool that lists GitHub Pull Requests based on various filter parameters
`GithubGetPullModel`
`GithubGetPullToolConfig`	Tool that fetches a particular pull request in a GitHub repository asynchronously.
`GithubGetPullCommitsToolConfig`	Configuration for the GitHub Get Pull Commits Tool.
`GithubGetPullFilesToolConfig`	Configuration for the GitHub Get Pull Files Tool.

Functions#

`list_github_pulls_async`(config, builder)	Lists GitHub Pull Requests based on various filter parameters
`get_github_pull_async`(config, builder)	Fetches a particular pull request in a GitHub repository asynchronously.
`get_github_pull_commits_async`(config, builder)	Fetches the commits associated with a particular pull request in a GitHub repository asynchronously.
`get_github_pull_files_async`(config, builder)	Fetches the files associated with a particular pull request in a GitHub repository asynchronously.

Module Contents#

class GithubListPullsModel(/, **data: Any)#

Bases: pydantic.BaseModel

state: Literal['open', 'closed', 'all'] | None = None#

head: str | None = None#

base: str | None = None#

class GithubListPullsModelList(/, **data: Any)#

Bases: pydantic.BaseModel

filter_params: GithubListPullsModel = None#

class GithubListPullsToolConfig(/, **data: Any)#

Bases: aiq.data_models.function.FunctionBaseConfig

Tool that lists GitHub Pull Requests based on various filter parameters

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.

repo_name: str = None#

timeout: int = None#

async list_github_pulls_async( config: GithubListPullsToolConfig, builder: aiq.builder.builder.Builder, )#: Lists GitHub Pull Requests based on various filter parameters

class GithubGetPullModel(/, **data: Any)#

Bases: pydantic.BaseModel

pull_number: str = None#

class GithubGetPullToolConfig(/, **data: Any)#

Bases: aiq.data_models.function.FunctionBaseConfig

Tool that fetches a particular pull request in a GitHub repository asynchronously.

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.

repo_name: str = "The repository name in the format 'owner/repo'"#

timeout: int = 300#

async get_github_pull_async( config: GithubGetPullToolConfig, builder: aiq.builder.builder.Builder, )#: Fetches a particular pull request in a GitHub repository asynchronously.

class GithubGetPullCommitsToolConfig(/, **data: Any)#

Bases: aiq.data_models.function.FunctionBaseConfig

Configuration for the GitHub Get Pull Commits Tool.

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.

repo_name: str = "The repository name in the format 'owner/repo'"#

timeout: int = 300#

async get_github_pull_commits_async( config: GithubGetPullCommitsToolConfig, builder: aiq.builder.builder.Builder, )#: Fetches the commits associated with a particular pull request in a GitHub repository asynchronously.

class GithubGetPullFilesToolConfig(/, **data: Any)#

Bases: aiq.data_models.function.FunctionBaseConfig

Configuration for the GitHub Get Pull Files Tool.

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.

repo_name: str = "The repository name in the format 'owner/repo'"#

timeout: int = 300#

async get_github_pull_files_async( config: GithubGetPullFilesToolConfig, builder: aiq.builder.builder.Builder, )#: Fetches the files associated with a particular pull request in a GitHub repository asynchronously.