prefect_github.repository

This is a module containing: GitHub query_repository* tasks and the GitHub storage block.

GitHubRepository

Bases: ReadableDeploymentStorage

Interact with files stored on GitHub repositories.

Source code in prefect_github/repository.py

class GitHubRepository(ReadableDeploymentStorage):
    """
    Interact with files stored on GitHub repositories.
    """

    _block_type_name = "GitHub Repository"
    _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/41971cfecfea5f79ff334164f06ecb34d1038dd4-250x250.png"  # noqa: E501
    _documentation_url = "https://prefecthq.github.io/prefect-github/repository/#prefect_github.repository.GitHubRepository"  # noqa

    repository_url: str = Field(
        default=...,
        title="Repository URL",
        description=(
            "The URL of a GitHub repository to read from, in either HTTPS or SSH "
            "format. If you are using a private repo, it must be in the HTTPS format."
        ),
    )
    reference: Optional[str] = Field(
        default=None,
        description="An optional reference to pin to; can be a branch name or tag.",
    )
    credentials: Optional[GitHubCredentials] = Field(
        default=None,
        description="An optional GitHubCredentials block for using private GitHub repos.",  # noqa: E501
    )

    def _create_repo_url(self) -> str:
        """Format the URL provided to the `git clone` command.

        For private repos: https://<oauth-key>@github.com/<username>/<repo>.git
        All other repos should be the same as `self.repository`.
        """
        url_components = urlparse(self.repository_url)
        if url_components.scheme == "https" and self.credentials is not None:
            token_value = self.credentials.token.get_secret_value()
            updated_components = url_components._replace(
                netloc=f"{token_value}@{url_components.netloc}"
            )
            full_url = urlunparse(updated_components)
        else:
            full_url = self.repository_url

        return full_url

    @staticmethod
    def _get_paths(
        dst_dir: Union[str, None], src_dir: str, sub_directory: str
    ) -> Tuple[str, str]:
        """Returns the fully formed paths for GitHubRepository contents in the form
        (content_source, content_destination).
        """
        if dst_dir is None:
            content_destination = Path(".").absolute()
        else:
            content_destination = Path(dst_dir)

        content_source = Path(src_dir)

        if sub_directory:
            content_destination = content_destination.joinpath(sub_directory)
            content_source = content_source.joinpath(sub_directory)

        return str(content_source), str(content_destination)

    @sync_compatible
    async def get_directory(
        self, from_path: Optional[str] = None, local_path: Optional[str] = None
    ) -> None:
        """
        Clones a GitHub project specified in `from_path` to the provided `local_path`;
        defaults to cloning the repository reference configured on the Block to the
        present working directory.

        Args:
            from_path: If provided, interpreted as a subdirectory of the underlying
                repository that will be copied to the provided local path.
            local_path: A local path to clone to; defaults to present working directory.
        """
        # CONSTRUCT COMMAND
        cmd = f"git clone {self._create_repo_url()}"
        if self.reference:
            cmd += f" -b {self.reference}"

        # Limit git history
        cmd += " --depth 1"

        # Clone to a temporary directory and move the subdirectory over
        with TemporaryDirectory(suffix="prefect") as tmp_dir:
            tmp_path_str = tmp_dir
            cmd += f" {tmp_path_str}"
            cmd = shlex.split(cmd)

            err_stream = io.StringIO()
            out_stream = io.StringIO()
            process = await run_process(cmd, stream_output=(out_stream, err_stream))
            if process.returncode != 0:
                err_stream.seek(0)
                raise RuntimeError(f"Failed to pull from remote:\n {err_stream.read()}")

            content_source, content_destination = self._get_paths(
                dst_dir=local_path, src_dir=tmp_path_str, sub_directory=from_path
            )

            shutil.copytree(
                src=content_source, dst=content_destination, dirs_exist_ok=True
            )

get_directory(from_path=None, local_path=None) async

Clones a GitHub project specified in from_path to the provided local_path; defaults to cloning the repository reference configured on the Block to the present working directory.

Parameters:

Name	Type	Description	Default
from_path	Optional[str]	If provided, interpreted as a subdirectory of the underlying repository that will be copied to the provided local path.	None
local_path	Optional[str]	A local path to clone to; defaults to present working directory.	None

Source code in prefect_github/repository.py

@sync_compatible
async def get_directory(
    self, from_path: Optional[str] = None, local_path: Optional[str] = None
) -> None:
    """
    Clones a GitHub project specified in `from_path` to the provided `local_path`;
    defaults to cloning the repository reference configured on the Block to the
    present working directory.

    Args:
        from_path: If provided, interpreted as a subdirectory of the underlying
            repository that will be copied to the provided local path.
        local_path: A local path to clone to; defaults to present working directory.
    """
    # CONSTRUCT COMMAND
    cmd = f"git clone {self._create_repo_url()}"
    if self.reference:
        cmd += f" -b {self.reference}"

    # Limit git history
    cmd += " --depth 1"

    # Clone to a temporary directory and move the subdirectory over
    with TemporaryDirectory(suffix="prefect") as tmp_dir:
        tmp_path_str = tmp_dir
        cmd += f" {tmp_path_str}"
        cmd = shlex.split(cmd)

        err_stream = io.StringIO()
        out_stream = io.StringIO()
        process = await run_process(cmd, stream_output=(out_stream, err_stream))
        if process.returncode != 0:
            err_stream.seek(0)
            raise RuntimeError(f"Failed to pull from remote:\n {err_stream.read()}")

        content_source, content_destination = self._get_paths(
            dst_dir=local_path, src_dir=tmp_path_str, sub_directory=from_path
        )

        shutil.copytree(
            src=content_source, dst=content_destination, dirs_exist_ok=True
        )

query_repository(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The query root of GitHub's GraphQL interface.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The query root of GitHub's GraphQL interface.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a repository
            referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    )

    op_stack = ("repository",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]

query_repository_assignable_users(owner, name, github_credentials, follow_renames=True, query=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of users that can be assigned to issues in this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
query	Optional[str]	Filters users with query on user name and login.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_assignable_users(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    query: Optional[str] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users that can be assigned to issues in this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        query: Filters users with query on user name and login.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).assignable_users(
        **strip_kwargs(
            query=query,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "assignableUsers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["assignableUsers"]

query_repository_branch_protection_rules(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of branch protection rules for this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_branch_protection_rules(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of branch protection rules for this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that
            come after the specified cursor.
        before: Returns the elements in the list that
            come before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the
            list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).branch_protection_rules(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "branchProtectionRules",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["branchProtectionRules"]

query_repository_code_of_conduct(owner, name, github_credentials, follow_renames=True, return_fields=None) async

Returns the code of conduct for this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_code_of_conduct(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns the code of conduct for this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).code_of_conduct(**strip_kwargs())

    op_stack = (
        "repository",
        "codeOfConduct",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["codeOfConduct"]

query_repository_collaborators(owner, name, github_credentials, follow_renames=True, affiliation=None, query=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of collaborators associated with the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
affiliation	CollaboratorAffiliation	Collaborators affiliation level with a repository.	None
query	Optional[str]	Filters users with query on user name and login.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_collaborators(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    affiliation: graphql_schema.CollaboratorAffiliation = None,
    query: Optional[str] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of collaborators associated with the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        affiliation: Collaborators affiliation level with a
            repository.
        query: Filters users with query on user name and login.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).collaborators(
        **strip_kwargs(
            affiliation=affiliation,
            query=query,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "collaborators",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["collaborators"]

query_repository_commit_comments(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of commit comments associated with the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_commit_comments(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of commit comments associated with the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).commit_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "commitComments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["commitComments"]

query_repository_contact_links(owner, name, github_credentials, follow_renames=True, return_fields=None) async

Returns a list of contact links associated to the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_contact_links(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a list of contact links associated to the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).contact_links(**strip_kwargs())

    op_stack = (
        "repository",
        "contactLinks",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["contactLinks"]

query_repository_default_branch_ref(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The Ref associated with the repository's default branch.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_default_branch_ref(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The Ref associated with the repository's default branch.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).default_branch_ref(**strip_kwargs())

    op_stack = (
        "repository",
        "defaultBranchRef",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["defaultBranchRef"]

query_repository_deploy_keys(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of deploy keys that are on this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_deploy_keys(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of deploy keys that are on this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).deploy_keys(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "deployKeys",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["deployKeys"]

query_repository_deployments(owner, name, environments, github_credentials, follow_renames=True, order_by={'field': 'CREATED_AT', 'direction': 'ASC'}, after=None, before=None, first=None, last=None, return_fields=None) async

Deployments associated with the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
environments	Iterable[str]	Environments to list deployments for.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
order_by	DeploymentOrder	Ordering options for deployments returned from the connection.	{'field': 'CREATED_AT', 'direction': 'ASC'}
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_deployments(  # noqa
    owner: str,
    name: str,
    environments: Iterable[str],
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    order_by: graphql_schema.DeploymentOrder = {
        "field": "CREATED_AT",
        "direction": "ASC",
    },
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Deployments associated with the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        environments: Environments to list deployments for.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        order_by: Ordering options for deployments returned from the
            connection.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).deployments(
        **strip_kwargs(
            environments=environments,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "deployments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["deployments"]

query_repository_discussion(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Returns a single discussion from the current repository by number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The number for the discussion to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_discussion(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single discussion from the current repository by number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The number for the discussion to be returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).discussion(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "discussion",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["discussion"]

query_repository_discussion_categories(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, filter_by_assignable=False, return_fields=None) async

A list of discussion categories that are available in the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
filter_by_assignable	bool	Filter by categories that are assignable by the viewer.	False
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_discussion_categories(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    filter_by_assignable: bool = False,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of discussion categories that are available in the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the list.
        filter_by_assignable: Filter by categories that
            are assignable by the viewer.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).discussion_categories(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            filter_by_assignable=filter_by_assignable,
        )
    )

    op_stack = (
        "repository",
        "discussionCategories",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["discussionCategories"]

query_repository_discussion_category(owner, name, slug, github_credentials, follow_renames=True, return_fields=None) async

A discussion category by slug.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
slug	str	The slug of the discussion category to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_discussion_category(  # noqa
    owner: str,
    name: str,
    slug: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A discussion category by slug.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        slug: The slug of the discussion category to be
            returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).discussion_category(
        **strip_kwargs(
            slug=slug,
        )
    )

    op_stack = (
        "repository",
        "discussionCategory",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["discussionCategory"]

query_repository_discussions(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, category_id=None, order_by={'field': 'UPDATED_AT', 'direction': 'DESC'}, return_fields=None) async

A list of discussions that have been opened in the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
category_id	Optional[str]	Only include discussions that belong to the category with this ID.	None
order_by	DiscussionOrder	Ordering options for discussions returned from the connection.	{'field': 'UPDATED_AT', 'direction': 'DESC'}
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_discussions(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    category_id: Optional[str] = None,
    order_by: graphql_schema.DiscussionOrder = {
        "field": "UPDATED_AT",
        "direction": "DESC",
    },
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of discussions that have been opened in the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        category_id: Only include discussions that belong to the
            category with this ID.
        order_by: Ordering options for discussions returned from the
            connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).discussions(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            category_id=category_id,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "discussions",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["discussions"]

query_repository_environment(owner, name, environment_name, github_credentials, follow_renames=True, return_fields=None) async

Returns a single active environment from the current repository by name.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
environment_name	str	The name of the environment to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_environment(  # noqa
    owner: str,
    name: str,
    environment_name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single active environment from the current repository by name.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        environment_name: The name of the environment to be returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).environment(
        **strip_kwargs(
            name=environment_name,
        )
    )

    op_stack = (
        "repository",
        "environment",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["environment"]

query_repository_environments(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of environments that are in this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_environments(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of environments that are in this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).environments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "environments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["environments"]

query_repository_forks(owner, name, github_credentials, follow_renames=True, privacy=None, order_by=None, affiliations=None, owner_affiliations=('OWNER', 'COLLABORATOR'), is_locked=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of direct forked repositories.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
privacy	RepositoryPrivacy	If non-null, filters repositories according to privacy.	None
order_by	RepositoryOrder	Ordering options for repositories returned from the connection.	None
affiliations	Iterable[RepositoryAffiliation]	Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.	None
owner_affiliations	Iterable[RepositoryAffiliation]	Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.	('OWNER', 'COLLABORATOR')
is_locked	Optional[bool]	If non-null, filters repositories according to whether they have been locked.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_forks(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    privacy: graphql_schema.RepositoryPrivacy = None,
    order_by: graphql_schema.RepositoryOrder = None,
    affiliations: Iterable[graphql_schema.RepositoryAffiliation] = None,
    owner_affiliations: Iterable[graphql_schema.RepositoryAffiliation] = (
        "OWNER",
        "COLLABORATOR",
    ),
    is_locked: Optional[bool] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of direct forked repositories.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        privacy: If non-null, filters repositories according to privacy.
        order_by: Ordering options for repositories returned from the
            connection.
        affiliations: Array of viewer's affiliation options for
            repositories returned from the connection. For example,
            OWNER will include only repositories that the current viewer
            owns.
        owner_affiliations: Array of owner's affiliation options for
            repositories returned from the connection. For example,
            OWNER will include only repositories that the organization
            or user being viewed owns.
        is_locked: If non-null, filters repositories according to whether
            they have been locked.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).forks(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            affiliations=affiliations,
            owner_affiliations=owner_affiliations,
            is_locked=is_locked,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "forks",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["forks"]

query_repository_funding_links(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The funding links for this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_funding_links(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The funding links for this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).funding_links(**strip_kwargs())

    op_stack = (
        "repository",
        "fundingLinks",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["fundingLinks"]

query_repository_interaction_ability(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The interaction ability settings for this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_interaction_ability(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The interaction ability settings for this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).interaction_ability(**strip_kwargs())

    op_stack = (
        "repository",
        "interactionAbility",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["interactionAbility"]

query_repository_issue(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Returns a single issue from the current repository by number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The number for the issue to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_issue(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single issue from the current repository by number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The number for the issue to be returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).issue(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "issue",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["issue"]

query_repository_issue_or_pull_request(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Returns a single issue-like object from the current repository by number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The number for the issue to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_issue_or_pull_request(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single issue-like object from the current repository by number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The number for the issue to be returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).issue_or_pull_request(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "issueOrPullRequest",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["issueOrPullRequest"]

query_repository_issue_templates(owner, name, github_credentials, follow_renames=True, return_fields=None) async

Returns a list of issue templates associated to the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_issue_templates(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a list of issue templates associated to the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).issue_templates(**strip_kwargs())

    op_stack = (
        "repository",
        "issueTemplates",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["issueTemplates"]

query_repository_issues(owner, name, labels, states, github_credentials, follow_renames=True, order_by=None, filter_by=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of issues that have been opened in the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
labels	Iterable[str]	A list of label names to filter the pull requests by.	required
states	Iterable[IssueState]	A list of states to filter the issues by.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
order_by	IssueOrder	Ordering options for issues returned from the connection.	None
filter_by	IssueFilters	Filtering options for issues returned from the connection.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_issues(  # noqa
    owner: str,
    name: str,
    labels: Iterable[str],
    states: Iterable[graphql_schema.IssueState],
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    order_by: graphql_schema.IssueOrder = None,
    filter_by: graphql_schema.IssueFilters = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of issues that have been opened in the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        labels: A list of label names to filter the pull requests by.
        states: A list of states to filter the issues by.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        order_by: Ordering options for issues returned from the
            connection.
        filter_by: Filtering options for issues returned from the
            connection.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).issues(
        **strip_kwargs(
            labels=labels,
            states=states,
            order_by=order_by,
            filter_by=filter_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "issues",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["issues"]

query_repository_label(owner, name, label_name, github_credentials, follow_renames=True, return_fields=None) async

Returns a single label by name.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
label_name	str	Label name.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_label(  # noqa
    owner: str,
    name: str,
    label_name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single label by name.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        label_name: Label name.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).label(
        **strip_kwargs(
            name=label_name,
        )
    )

    op_stack = (
        "repository",
        "label",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["label"]

query_repository_labels(owner, name, github_credentials, follow_renames=True, order_by={'field': 'CREATED_AT', 'direction': 'ASC'}, after=None, before=None, first=None, last=None, query=None, return_fields=None) async

A list of labels associated with the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
order_by	LabelOrder	Ordering options for labels returned from the connection.	{'field': 'CREATED_AT', 'direction': 'ASC'}
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
query	Optional[str]	If provided, searches labels by name and description.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_labels(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    order_by: graphql_schema.LabelOrder = {"field": "CREATED_AT", "direction": "ASC"},
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    query: Optional[str] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of labels associated with the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        order_by: Ordering options for labels returned from the
            connection.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        query: If provided, searches labels by name and description.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).labels(
        **strip_kwargs(
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
            query=query,
        )
    )

    op_stack = (
        "repository",
        "labels",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["labels"]

query_repository_languages(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, order_by=None, return_fields=None) async

A list containing a breakdown of the language composition of the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
order_by	LanguageOrder	Order for connection.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_languages(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.LanguageOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list containing a breakdown of the language composition of the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        order_by: Order for connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).languages(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "languages",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["languages"]

query_repository_latest_release(owner, name, github_credentials, follow_renames=True, return_fields=None) async

Get the latest release for the repository if one exists.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_latest_release(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Get the latest release for the repository if one exists.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).latest_release(**strip_kwargs())

    op_stack = (
        "repository",
        "latestRelease",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["latestRelease"]

query_repository_license_info(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The license associated with the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_license_info(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The license associated with the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).license_info(**strip_kwargs())

    op_stack = (
        "repository",
        "licenseInfo",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["licenseInfo"]

query_repository_mentionable_users(owner, name, github_credentials, follow_renames=True, query=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of Users that can be mentioned in the context of the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
query	Optional[str]	Filters users with query on user name and login.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_mentionable_users(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    query: Optional[str] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of Users that can be mentioned in the context of the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        query: Filters users with query on user name and login.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).mentionable_users(
        **strip_kwargs(
            query=query,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "mentionableUsers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["mentionableUsers"]

query_repository_milestone(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Returns a single milestone from the current repository by number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The number for the milestone to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_milestone(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single milestone from the current repository by number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The number for the milestone to be returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).milestone(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "milestone",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["milestone"]

query_repository_milestones(owner, name, states, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, order_by=None, query=None, return_fields=None) async

A list of milestones associated with the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
states	Iterable[MilestoneState]	Filter by the state of the milestones.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
order_by	MilestoneOrder	Ordering options for milestones.	None
query	Optional[str]	Filters milestones with a query on the title.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_milestones(  # noqa
    owner: str,
    name: str,
    states: Iterable[graphql_schema.MilestoneState],
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.MilestoneOrder = None,
    query: Optional[str] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of milestones associated with the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        states: Filter by the state of the milestones.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        order_by: Ordering options for milestones.
        query: Filters milestones with a query on the title.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).milestones(
        **strip_kwargs(
            states=states,
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
            query=query,
        )
    )

    op_stack = (
        "repository",
        "milestones",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["milestones"]

query_repository_object(owner, name, github_credentials, follow_renames=True, oid=None, expression=None, return_fields=None) async

A Git object in the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
oid	Optional[datetime]	The Git object ID.	None
expression	Optional[str]	A Git revision expression suitable for rev-parse.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_object(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    oid: Optional[datetime] = None,
    expression: Optional[str] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A Git object in the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        oid: The Git object ID.
        expression: A Git revision expression suitable for rev-parse.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).object(
        **strip_kwargs(
            oid=oid,
            expression=expression,
        )
    )

    op_stack = (
        "repository",
        "object",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["object"]

query_repository_owner(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The User owner of the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_owner(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The User owner of the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).owner(**strip_kwargs())

    op_stack = (
        "repository",
        "owner",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["owner"]

query_repository_packages(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, names=None, repository_id=None, package_type=None, order_by={'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields=None) async

A list of packages under the owner.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
names	Optional[Iterable[str]]	Find packages by their names.	None
repository_id	Optional[str]	Find packages in a repository by ID.	None
package_type	PackageType	Filter registry package by type.	None
order_by	PackageOrder	Ordering of the returned packages.	{'field': 'CREATED_AT', 'direction': 'DESC'}
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_packages(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    names: Optional[Iterable[str]] = None,
    repository_id: Optional[str] = None,
    package_type: graphql_schema.PackageType = None,
    order_by: graphql_schema.PackageOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of packages under the owner.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        names: Find packages by their names.
        repository_id: Find packages in a repository by ID.
        package_type: Filter registry package by type.
        order_by: Ordering of the returned packages.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).packages(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            names=names,
            repository_id=repository_id,
            package_type=package_type,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "packages",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["packages"]

query_repository_pinned_discussions(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of discussions that have been pinned in this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_pinned_discussions(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of discussions that have been pinned in this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).pinned_discussions(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "pinnedDiscussions",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["pinnedDiscussions"]

query_repository_pinned_issues(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of pinned issues for this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_pinned_issues(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of pinned issues for this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).pinned_issues(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "pinnedIssues",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["pinnedIssues"]

query_repository_primary_language(owner, name, github_credentials, follow_renames=True, return_fields=None) async

The primary language of the repository's code.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_primary_language(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The primary language of the repository's code.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).primary_language(**strip_kwargs())

    op_stack = (
        "repository",
        "primaryLanguage",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["primaryLanguage"]

query_repository_project(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Find project by number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The project number to find.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_project(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find project by number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The project number to find.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).project(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "project",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["project"]

query_repository_project_next(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Finds and returns the Project (beta) according to the provided Project (beta) number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The ProjectNext number.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_project_next(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Finds and returns the Project (beta) according to the provided Project (beta)
    number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The ProjectNext number.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).project_next(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "projectNext",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["projectNext"]

query_repository_project_v2(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Finds and returns the Project according to the provided Project number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The Project number.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_project_v2(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Finds and returns the Project according to the provided Project number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The Project number.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).project_v2(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "projectV2",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["projectV2"]

query_repository_projects(owner, name, states, github_credentials, follow_renames=True, order_by=None, search=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of projects under the owner.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
states	Iterable[ProjectState]	A list of states to filter the projects by.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
order_by	ProjectOrder	Ordering options for projects returned from the connection.	None
search	Optional[str]	Query to search projects by, currently only searching by name.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_projects(  # noqa
    owner: str,
    name: str,
    states: Iterable[graphql_schema.ProjectState],
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    order_by: graphql_schema.ProjectOrder = None,
    search: Optional[str] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects under the owner.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        states: A list of states to filter the projects by.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        order_by: Ordering options for projects returned from the
            connection.
        search: Query to search projects by, currently only searching
            by name.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).projects(
        **strip_kwargs(
            states=states,
            order_by=order_by,
            search=search,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "projects",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["projects"]

query_repository_projects_next(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, query=None, sort_by='TITLE', return_fields=None) async

List of projects (beta) linked to this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
query	Optional[str]	A project (beta) to search for linked to the repo.	None
sort_by	ProjectNextOrderField	How to order the returned project (beta) objects.	'TITLE'
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_projects_next(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    query: Optional[str] = None,
    sort_by: graphql_schema.ProjectNextOrderField = "TITLE",
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of projects (beta) linked to this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        query: A project (beta) to search for linked to the repo.
        sort_by: How to order the returned project (beta) objects.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).projects_next(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            query=query,
            sort_by=sort_by,
        )
    )

    op_stack = (
        "repository",
        "projectsNext",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["projectsNext"]

query_repository_projects_v2(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, query=None, order_by={'field': 'NUMBER', 'direction': 'DESC'}, return_fields=None) async

List of projects linked to this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
query	Optional[str]	A project to search for linked to the repo.	None
order_by	ProjectV2Order	How to order the returned projects.	{'field': 'NUMBER', 'direction': 'DESC'}
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_projects_v2(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    query: Optional[str] = None,
    order_by: graphql_schema.ProjectV2Order = {"field": "NUMBER", "direction": "DESC"},
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of projects linked to this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        query: A project to search for linked to the repo.
        order_by: How to order the returned projects.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).projects_v2(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            query=query,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "projectsV2",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["projectsV2"]

query_repository_pull_request(owner, name, number, github_credentials, follow_renames=True, return_fields=None) async

Returns a single pull request from the current repository by number.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
number	int	The number for the pull request to be returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_pull_request(  # noqa
    owner: str,
    name: str,
    number: int,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a single pull request from the current repository by number.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        number: The number for the pull request to be returned.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).pull_request(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "repository",
        "pullRequest",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["pullRequest"]

query_repository_pull_request_templates(owner, name, github_credentials, follow_renames=True, return_fields=None) async

Returns a list of pull request templates associated to the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_pull_request_templates(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a list of pull request templates associated to the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).pull_request_templates(**strip_kwargs())

    op_stack = (
        "repository",
        "pullRequestTemplates",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["pullRequestTemplates"]

query_repository_pull_requests(owner, name, states, labels, github_credentials, follow_renames=True, head_ref_name=None, base_ref_name=None, order_by=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of pull requests that have been opened in the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
states	Iterable[PullRequestState]	A list of states to filter the pull requests by.	required
labels	Iterable[str]	A list of label names to filter the pull requests by.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
head_ref_name	Optional[str]	The head ref name to filter the pull requests by.	None
base_ref_name	Optional[str]	The base ref name to filter the pull requests by.	None
order_by	IssueOrder	Ordering options for pull requests returned from the connection.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_pull_requests(  # noqa
    owner: str,
    name: str,
    states: Iterable[graphql_schema.PullRequestState],
    labels: Iterable[str],
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    head_ref_name: Optional[str] = None,
    base_ref_name: Optional[str] = None,
    order_by: graphql_schema.IssueOrder = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of pull requests that have been opened in the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        states: A list of states to filter the pull requests by.
        labels: A list of label names to filter the pull requests
            by.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        head_ref_name: The head ref name to filter the pull
            requests by.
        base_ref_name: The base ref name to filter the pull
            requests by.
        order_by: Ordering options for pull requests returned from
            the connection.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).pull_requests(
        **strip_kwargs(
            states=states,
            labels=labels,
            head_ref_name=head_ref_name,
            base_ref_name=base_ref_name,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "pullRequests",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["pullRequests"]

query_repository_recent_projects(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

Recent projects that this user has modified in the context of the owner.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_recent_projects(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Recent projects that this user has modified in the context of the owner.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).recent_projects(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "recentProjects",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["recentProjects"]

query_repository_ref(owner, name, qualified_name, github_credentials, follow_renames=True, return_fields=None) async

Fetch a given ref from the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
qualified_name	str	The ref to retrieve. Fully qualified matches are checked in order (refs/heads/master) before falling back onto checks for short name matches (master).	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_ref(  # noqa
    owner: str,
    name: str,
    qualified_name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Fetch a given ref from the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        qualified_name: The ref to retrieve. Fully qualified matches are
            checked in order (`refs/heads/master`) before falling back
            onto checks for short name matches (`master`).
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).ref(
        **strip_kwargs(
            qualified_name=qualified_name,
        )
    )

    op_stack = (
        "repository",
        "ref",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["ref"]

query_repository_refs(owner, name, ref_prefix, github_credentials, follow_renames=True, query=None, after=None, before=None, first=None, last=None, direction=None, order_by=None, return_fields=None) async

Fetch a list of refs from the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
ref_prefix	str	A ref name prefix like refs/heads/, refs/tags/, etc.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
query	Optional[str]	Filters refs with query on name.	None
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
direction	OrderDirection		None
order_by	RefOrder	Ordering options for refs returned from the connection.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_refs(  # noqa
    owner: str,
    name: str,
    ref_prefix: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    query: Optional[str] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    direction: graphql_schema.OrderDirection = None,
    order_by: graphql_schema.RefOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Fetch a list of refs from the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        ref_prefix: A ref name prefix like `refs/heads/`, `refs/tags/`,
            etc.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        query: Filters refs with query on name.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        direction: DEPRECATED: use orderBy. The ordering direction.
        order_by: Ordering options for refs returned from the connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).refs(
        **strip_kwargs(
            ref_prefix=ref_prefix,
            query=query,
            after=after,
            before=before,
            first=first,
            last=last,
            direction=direction,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "refs",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["refs"]

query_repository_release(owner, name, tag_name, github_credentials, follow_renames=True, return_fields=None) async

Lookup a single release given various criteria.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
tag_name	str	The name of the Tag the Release was created from.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_release(  # noqa
    owner: str,
    name: str,
    tag_name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Lookup a single release given various criteria.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        tag_name: The name of the Tag the Release was created from.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).release(
        **strip_kwargs(
            tag_name=tag_name,
        )
    )

    op_stack = (
        "repository",
        "release",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["release"]

query_repository_releases(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, order_by=None, return_fields=None) async

List of releases which are dependent on this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
order_by	ReleaseOrder	Order for connection.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_releases(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.ReleaseOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of releases which are dependent on this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        order_by: Order for connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).releases(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "releases",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["releases"]

query_repository_repository_topics(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of applied repository-topic associations for this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_repository_topics(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of applied repository-topic associations for this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).repository_topics(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "repositoryTopics",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["repositoryTopics"]

query_repository_stargazers(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, order_by=None, return_fields=None) async

A list of users who have starred this starrable.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
order_by	StarOrder	Order for connection.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_stargazers(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.StarOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users who have starred this starrable.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        order_by: Order for connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).stargazers(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "repository",
        "stargazers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["stargazers"]

query_repository_submodules(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

Returns a list of all submodules in this repository parsed from the .gitmodules file as of the default branch's HEAD commit.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_submodules(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Returns a list of all submodules in this repository parsed from the .gitmodules
    file as of the default branch's HEAD commit.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).submodules(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "submodules",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["submodules"]

query_repository_vulnerability_alerts(owner, name, states, dependency_scopes, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of vulnerability alerts that are on this repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
states	Iterable[RepositoryVulnerabilityAlertState]	Filter by the state of the alert.	required
dependency_scopes	Iterable[RepositoryVulnerabilityAlertDependencyScope]	Filter by the scope of the alert's dependency.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_vulnerability_alerts(  # noqa
    owner: str,
    name: str,
    states: Iterable[graphql_schema.RepositoryVulnerabilityAlertState],
    dependency_scopes: Iterable[
        graphql_schema.RepositoryVulnerabilityAlertDependencyScope
    ],
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of vulnerability alerts that are on this repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        states: Filter by the state of the alert.
        dependency_scopes: Filter by the scope of the
            alert's dependency.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).vulnerability_alerts(
        **strip_kwargs(
            states=states,
            dependency_scopes=dependency_scopes,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "vulnerabilityAlerts",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["vulnerabilityAlerts"]

query_repository_watchers(owner, name, github_credentials, follow_renames=True, after=None, before=None, first=None, last=None, return_fields=None) async

A list of users watching the repository.

Parameters:

Name	Type	Description	Default
owner	str	The login field of a user or organization.	required
name	str	The name of the repository.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
after	Optional[str]	Returns the elements in the list that come after the specified cursor.	None
before	Optional[str]	Returns the elements in the list that come before the specified cursor.	None
first	Optional[int]	Returns the first n elements from the list.	None
last	Optional[int]	Returns the last n elements from the list.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/repository.py

@task
async def query_repository_watchers(  # noqa
    owner: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users watching the repository.

    Args:
        owner: The login field of a user or organization.
        name: The name of the repository.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository(
        **strip_kwargs(
            owner=owner,
            name=name,
            follow_renames=follow_renames,
        )
    ).watchers(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "repository",
        "watchers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repository"]["watchers"]