1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
|
# SPDX-FileCopyrightText: 2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
# Script to get all the inactive gitea developers
# Usage: GITEA_API_TOKEN=<yourtoken> python3 gitea_inactive_developers.py
#
# The API Token have the "read:org" or "admin:org" scope.
#
# Potential errors:
# * 403 Client Error: That means the token doesn't have the right scope.
# * 500 Server Error: The token is invalid.
import logging
import os
import requests
import sys
import yarl
from retry import retry as retry_decorator
import datetime
import dataclasses as dc
import iso8601
from typing import (
cast,
Callable,
Dict,
Iterable,
List,
NewType,
Optional,
Tuple,
Type,
TypeVar,
Union,
)
from requests.structures import CaseInsensitiveDict
logger = logging.getLogger(__file__)
@dc.dataclass
class TeamMember():
id: int
login: str
full_name: str
last_login: datetime.datetime
def __str__(self) -> str:
return "{id};{login};{full_name};{last_login};{url}\n".format(
id=self.id,
login=self.login,
full_name=self.full_name,
last_login=self.last_login,
url=gitea_domain + self.login,
)
Page = NewType('Page', int)
F = TypeVar('F', bound=Callable[..., object])
T = TypeVar('T', bound=object)
retry: Callable[[F], F] = retry_decorator(
tries=10, delay=1, backoff=2, logger=logger)
def assert_cast(typ: Type[T], obj: object) -> T:
assert isinstance(obj, typ), f'object is not of type {typ}: {obj}'
# NOTE: MYPY warns the cast is redundant, we might consider removing it.
return cast(T, obj) # type: ignore
def get_date_object(date_string: str) -> datetime.datetime:
result = iso8601.parse_date(date_string)
assert isinstance(result, datetime.datetime)
return result
results_per_page = 25
def get_next_page(headers: CaseInsensitiveDict[str], page: Page) -> Optional[Page]:
"""
Parse the header looking for reference to next.
"""
total_count = int(assert_cast(str, headers.get('X-Total-Count')))
# If current page already accounts to all the results we need
# there is no need for extra pages.
if page * results_per_page >= total_count:
return None
next_page = Page(page + 1)
return next_page
@retry
def fetch_single(
api_url: yarl.URL,
api_token: str,
method: str,
data: Dict[str, str],
page: Page,
) -> Tuple[List[object], Optional[Page]]:
"""Generic function to query a single item from the API.
Returns:
A dictionary containing the item data.
"""
headers = {
'accept': 'application/json',
'Authorization': 'token ' + api_token,
}
params: Dict[str, Union[str, int]] = {
'limit': results_per_page,
'page': page,
**data,
}
logger.info(f"Calling {method} ({params=}).")
response = requests.get(str(api_url / method), params=params, headers=headers)
response.raise_for_status()
response_json = response.json()
next_page = get_next_page(response.headers, page)
return response_json, None if next_page is None else next_page
def fetch_all(
api_url: yarl.URL,
api_token: str,
method: str,
data: Dict[str, str],
) -> Iterable[object]:
"""Generic function to query lists from API.
Yields:
response_data - the result of fetch_single()
"""
page = Page(1)
while page is not None:
response_data, page = fetch_single(api_url, api_token, method, data, page)
yield from response_data if response_data is not None else ()
def fetch_team_members(
api_url: yarl.URL,
api_token: str,
organization_name: str,
team_name: str,
) -> List[TeamMember]:
"""Query API for all the members of a team.
Yields:
TeamMember objects.
"""
method = "orgs/{org}/teams".format(org=organization_name)
team_id = None
for team in cast(
Iterable[Dict[object, object]],
fetch_all(
api_url,
api_token,
method,
data={},
),
):
if team.get('name') != team_name:
continue
team_id = team.get('id')
break
if team_id is None:
logger.error('No team found with name: ' + team_name)
sys.exit(2)
method = "teams/{id}/members".format(id=team_id)
users = list()
for member in cast(
Iterable[Dict[object, object]],
fetch_all(
api_url,
api_token,
method,
data={},
),
):
users.append(
TeamMember(
id=assert_cast(int, member.get('id')),
login=assert_cast(str, member.get('login')),
full_name=assert_cast(str, member.get('full_name')),
last_login=get_date_object(
assert_cast(str, member.get('last_login'))),
))
return users
def is_inactive(member: TeamMember) -> bool:
"""
Returns whether the member is no longer active.
Users are active when they logged in the past 2 years.
"""
tzinfo = member.last_login.tzinfo
two_years_ago = datetime.datetime.now(tzinfo) - datetime.timedelta(days=2 * 365)
return member.last_login < two_years_ago
teams = (
"Developers",
"Add-ons",
"Translation",
"Documentation",
"Technical-Artists",
"Contributors",
)
api_token = os.environ['GITEA_API_TOKEN']
gitea_domain = "https://projects.blender.org/"
api_url = yarl.URL(gitea_domain + 'api/v1/')
organization_name = "blender"
def main() -> None:
for team_name in teams:
logger.warning(team_name)
members = fetch_team_members(
api_url, api_token, organization_name, team_name)
inactive_members = [str(m) for m in members if is_inactive(m)]
logger.warning(" Total members:" + str(len(members)))
logger.warning(" Inactive members: " + str(len(inactive_members)))
file_name = team_name.lower() + ".csv"
with open(file_name, 'w', newline='') as csv_file:
csv_file.write("id;login;full_name;last_login;url\n")
csv_file.writelines(inactive_members)
logger.warning(" Output file: " + file_name)
if __name__ == "__main__":
main()
|