Skip to content

gitea.label

label

Gitea Label resource.

Classes

gitea.label.AsyncLabel 

AsyncLabel(client: AsyncClientProtocol)

Bases: BaseLabel, AsyncResource

Asynchronous Gitea Label resource.

Source code in src/gitea/resource/async_resource.py 
16
17
18
19
20
21
22
23
def __init__(self, client: AsyncClientProtocol) -> None:
    """Initialize the Resource with a AsyncGitea client.

    Args:
        client: An instance of the AsyncGitea client.

    """
    self.client = client
Methods:
gitea.label.AsyncLabel.list_labels async 
list_labels(
    owner: str,
    repository: str,
    page: int | None = None,
    limit: int | None = None,
    **kwargs: Any,
) -> tuple[list[dict[str, Any]], dict[str, Any]]

List labels in a repository.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
page int | None

The page number for pagination.

 None
limit int | None

The number of labels per page.

 None
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[list[dict[str, Any]], dict[str, Any]]

A tuple containing a list of labels as dictionaries and a dictionary with metadata.
Source code in src/gitea/label/async_label.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
async def list_labels(
    self,
    owner: str,
    repository: str,
    page: int | None = None,
    limit: int | None = None,
    **kwargs: Any,
) -> tuple[list[dict[str, Any]], dict[str, Any]]:
    """List labels in a repository.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        page: The page number for pagination.
        limit: The number of labels per page.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing a list of labels as dictionaries and a dictionary with metadata.

    """
    response = await self._list_labels(
        owner=owner,
        repository=repository,
        page=page,
        limit=limit,
        **kwargs,
    )
    data, status_code = await process_async_response(response, default=[])
    return cast(list[dict[str, Any]], data), {"status_code": status_code}
gitea.label.AsyncLabel.create_label async 
create_label(
    owner: str,
    repository: str,
    name: str,
    color: str,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]

Create a label in a repository.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
name str

The name of the label.

 required
color str

The color of the label in hexadecimal format (e.g. #00aabb).

 required
description str | None

The description of the label.

 None
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[dict[str, Any], dict[str, Any]]

A tuple containing the created label as a dictionary and a dictionary with metadata.
Source code in src/gitea/label/async_label.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
async def create_label(
    self,
    owner: str,
    repository: str,
    name: str,
    color: str,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Create a label in a repository.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        name: The name of the label.
        color: The color of the label in hexadecimal format (e.g. ``#00aabb``).
        description: The description of the label.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing the created label as a dictionary and a dictionary with metadata.

    """
    response = await self._create_label(
        owner=owner,
        repository=repository,
        name=name,
        color=color,
        description=description,
        **kwargs,
    )
    data, status_code = await process_async_response(response, default={})
    return cast(dict[str, Any], data), {"status_code": status_code}
gitea.label.AsyncLabel.edit_label async 
edit_label(
    owner: str,
    repository: str,
    label_id: int,
    name: str | None = None,
    color: str | None = None,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]

Edit a label.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
label_id int

The ID of the label.

 required
name str | None

The new name of the label.

 None
color str | None

The new color of the label in hexadecimal format.

 None
description str | None

The new description of the label.

 None
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[dict[str, Any], dict[str, Any]]

A tuple containing the updated label as a dictionary and a dictionary with metadata.
Source code in src/gitea/label/async_label.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
async def edit_label(
    self,
    owner: str,
    repository: str,
    label_id: int,
    name: str | None = None,
    color: str | None = None,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Edit a label.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        label_id: The ID of the label.
        name: The new name of the label.
        color: The new color of the label in hexadecimal format.
        description: The new description of the label.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing the updated label as a dictionary and a dictionary with metadata.

    """
    response = await self._edit_label(
        owner=owner,
        repository=repository,
        label_id=label_id,
        name=name,
        color=color,
        description=description,
        **kwargs,
    )
    data, status_code = await process_async_response(response, default={})
    return cast(dict[str, Any], data), {"status_code": status_code}
gitea.label.AsyncLabel.delete_label async 
delete_label(
    owner: str,
    repository: str,
    label_id: int,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]

Delete a label.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
label_id int

The ID of the label.

 required
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[dict[str, Any], dict[str, Any]]

A tuple containing an empty dictionary and a dictionary with metadata.
Source code in src/gitea/label/async_label.py 
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
async def delete_label(
    self,
    owner: str,
    repository: str,
    label_id: int,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Delete a label.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        label_id: The ID of the label.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing an empty dictionary and a dictionary with metadata.

    """
    response = await self._delete_label(
        owner=owner,
        repository=repository,
        label_id=label_id,
        **kwargs,
    )
    data, status_code = await process_async_response(response, default={})
    return cast(dict[str, Any], data), {"status_code": status_code}

gitea.label.Label 

Label(client: ClientProtocol)

Bases: BaseLabel, Resource

Gitea Label resource.

Source code in src/gitea/resource/resource.py 
16
17
18
19
20
21
22
23
def __init__(self, client: ClientProtocol) -> None:
    """Initialize the Resource with a Gitea client.

    Args:
        client: An instance of the Gitea client.

    """
    self.client = client
Methods:
gitea.label.Label.list_labels 
list_labels(
    owner: str,
    repository: str,
    page: int | None = None,
    limit: int | None = None,
    **kwargs: Any,
) -> tuple[list[dict[str, Any]], dict[str, Any]]

List labels in a repository.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
page int | None

The page number for pagination.

 None
limit int | None

The number of labels per page.

 None
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[list[dict[str, Any]], dict[str, Any]]

A tuple containing a list of labels as dictionaries and a dictionary with metadata.
Source code in src/gitea/label/label.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def list_labels(
    self,
    owner: str,
    repository: str,
    page: int | None = None,
    limit: int | None = None,
    **kwargs: Any,
) -> tuple[list[dict[str, Any]], dict[str, Any]]:
    """List labels in a repository.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        page: The page number for pagination.
        limit: The number of labels per page.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing a list of labels as dictionaries and a dictionary with metadata.

    """
    response = self._list_labels(
        owner=owner,
        repository=repository,
        page=page,
        limit=limit,
        **kwargs,
    )
    data, status_code = process_response(response, default=[])
    return cast(list[dict[str, Any]], data), {"status_code": status_code}
gitea.label.Label.create_label 
create_label(
    owner: str,
    repository: str,
    name: str,
    color: str,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]

Create a label in a repository.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
name str

The name of the label.

 required
color str

The color of the label in hexadecimal format (e.g. #00aabb).

 required
description str | None

The description of the label.

 None
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[dict[str, Any], dict[str, Any]]

A tuple containing the created label as a dictionary and a dictionary with metadata.
Source code in src/gitea/label/label.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def create_label(
    self,
    owner: str,
    repository: str,
    name: str,
    color: str,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Create a label in a repository.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        name: The name of the label.
        color: The color of the label in hexadecimal format (e.g. ``#00aabb``).
        description: The description of the label.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing the created label as a dictionary and a dictionary with metadata.

    """
    response = self._create_label(
        owner=owner,
        repository=repository,
        name=name,
        color=color,
        description=description,
        **kwargs,
    )
    data, status_code = process_response(response, default={})
    return cast(dict[str, Any], data), {"status_code": status_code}
gitea.label.Label.edit_label 
edit_label(
    owner: str,
    repository: str,
    label_id: int,
    name: str | None = None,
    color: str | None = None,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]

Edit a label.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
label_id int

The ID of the label.

 required
name str | None

The new name of the label.

 None
color str | None

The new color of the label in hexadecimal format.

 None
description str | None

The new description of the label.

 None
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[dict[str, Any], dict[str, Any]]

A tuple containing the updated label as a dictionary and a dictionary with metadata.
Source code in src/gitea/label/label.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
def edit_label(
    self,
    owner: str,
    repository: str,
    label_id: int,
    name: str | None = None,
    color: str | None = None,
    description: str | None = None,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Edit a label.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        label_id: The ID of the label.
        name: The new name of the label.
        color: The new color of the label in hexadecimal format.
        description: The new description of the label.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing the updated label as a dictionary and a dictionary with metadata.

    """
    response = self._edit_label(
        owner=owner,
        repository=repository,
        label_id=label_id,
        name=name,
        color=color,
        description=description,
        **kwargs,
    )
    data, status_code = process_response(response, default={})
    return cast(dict[str, Any], data), {"status_code": status_code}
gitea.label.Label.delete_label 
delete_label(
    owner: str,
    repository: str,
    label_id: int,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]

Delete a label.

Parameters:

Name Type Description Default
owner str

The owner of the repository.

 required
repository str

The name of the repository.

 required
label_id int

The ID of the label.

 required
**kwargs Any

Additional arguments for the request.

 {}

Returns:

Type Description
tuple[dict[str, Any], dict[str, Any]]

A tuple containing an empty dictionary and a dictionary with metadata.
Source code in src/gitea/label/label.py 
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def delete_label(
    self,
    owner: str,
    repository: str,
    label_id: int,
    **kwargs: Any,
) -> tuple[dict[str, Any], dict[str, Any]]:
    """Delete a label.

    Args:
        owner: The owner of the repository.
        repository: The name of the repository.
        label_id: The ID of the label.
        **kwargs: Additional arguments for the request.

    Returns:
        A tuple containing an empty dictionary and a dictionary with metadata.

    """
    response = self._delete_label(
        owner=owner,
        repository=repository,
        label_id=label_id,
        **kwargs,
    )
    data, status_code = process_response(response, default={})
    return cast(dict[str, Any], data), {"status_code": status_code}

Functions:

Modules