Module aiogithubapi.namespaces.releases

Methods for the releases namespace

https://docs.github.com/en/rest/reference/repos#releases

"""
Methods for the releases namespace

https://docs.github.com/en/rest/reference/repos#releases
"""
from __future__ import annotations

from typing import Any, Dict, List

from ..const import GitHubRequestKwarg, RepositoryType
from ..models.release import GitHubReleaseModel
from ..models.response import GitHubResponseModel
from .base import BaseNamespace


class GitHubReleasesNamespace(BaseNamespace):
    """Methods for the releases namespace"""

    async def list(
        self,
        repository: RepositoryType,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[List[GitHubReleaseModel]]:
        """
        List releases

        This returns a list of releases, which does not include
        regular Git tags that have not been associated with a release.

         **Arguments**:

         `repository`

         The repository to return the tree for, example "octocat/hello-world"

        https://docs.github.com/en/rest/reference/repos#list-releases
        """
        response = await self._client.async_call_api(
            endpoint=f"/repos/{repository}/releases",
            **kwargs,
        )
        response.data = [GitHubReleaseModel(data) for data in response.data]
        return response

Classes

class GitHubReleasesNamespace (client: GitHubClient)

Methods for the releases namespace

Initialise the namespace.

Expand source code

class GitHubReleasesNamespace(BaseNamespace):
    """Methods for the releases namespace"""

    async def list(
        self,
        repository: RepositoryType,
        **kwargs: Dict[GitHubRequestKwarg, Any],
    ) -> GitHubResponseModel[List[GitHubReleaseModel]]:
        """
        List releases

        This returns a list of releases, which does not include
        regular Git tags that have not been associated with a release.

         **Arguments**:

         `repository`

         The repository to return the tree for, example "octocat/hello-world"

        https://docs.github.com/en/rest/reference/repos#list-releases
        """
        response = await self._client.async_call_api(
            endpoint=f"/repos/{repository}/releases",
            **kwargs,
        )
        response.data = [GitHubReleaseModel(data) for data in response.data]
        return response

Ancestors

• BaseNamespace

Methods

async def list(self, repository: RepositoryType, **kwargs: Dict[GitHubRequestKwarg, Any]) ‑> GitHubResponseModel[typing.List[GitHubReleaseModel]]

List releases

This returns a list of releases, which does not include regular Git tags that have not been associated with a release.

Arguments:

repository

The repository to return the tree for, example "octocat/hello-world"

https://docs.github.com/en/rest/reference/repos#list-releases

Expand source code

async def list(
    self,
    repository: RepositoryType,
    **kwargs: Dict[GitHubRequestKwarg, Any],
) -> GitHubResponseModel[List[GitHubReleaseModel]]:
    """
    List releases

    This returns a list of releases, which does not include
    regular Git tags that have not been associated with a release.

     **Arguments**:

     `repository`

     The repository to return the tree for, example "octocat/hello-world"

    https://docs.github.com/en/rest/reference/repos#list-releases
    """
    response = await self._client.async_call_api(
        endpoint=f"/repos/{repository}/releases",
        **kwargs,
    )
    response.data = [GitHubReleaseModel(data) for data in response.data]
    return response