Merge pull request #94 from moevm/add-liner

Add linter

Author: thehighestmath

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 120
+exclude = .git,__pycache__,docs
+statistics = True

.github/workflows/linter.yml

@@ -0,0 +1,25 @@
+name: Linter
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  linter:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Install flake8
+      run: pip install flake8
+
+    - name: Run flake8
+      run: flake8 .

ForgejoRepoAPI.py

@@ -0,0 +1,7 @@
+from interface_wrapper import (
+    IRepositoryAPI,
+)
+
+
+class ForgejoRepoAPI(IRepositoryAPI):
+    ...

GitHubRepoAPI.py

@@ -20,13 +20,33 @@ def __init__(self, client):
         self.client = client
 
     def get_user_data(self, user) -> User:
-        return User(login=user.login, username=user.name, email=user.email, html_url=user.html_url, node_id=user.node_id, type=user.type, bio=user.bio, site_admin=user.site_admin, _id=user.id)
-
+        return User(
+            login=user.login,
+            username=user.name,
+            email=user.email,
+            html_url=user.html_url,
+            node_id=user.node_id,
+            type=user.type,
+            bio=user.bio,
+            site_admin=user.site_admin,
+            _id=user.id,
+        )
 
     def get_repository(self, id: str) -> Repository | None:
         try:
             repo = self.client.get_repo(id)
-            return Repository(_id=repo.full_name, name=repo.name, url=repo.html_url, default_branch=Branch(name=repo.default_branch, last_commit=None), owner=User(login=repo.owner.login,username=repo.owner.name,email=repo.owner.email,html_url=repo.owner.html_url))
+            return Repository(
+                _id=repo.full_name,
+                name=repo.name,
+                url=repo.html_url,
+                default_branch=Branch(name=repo.default_branch, last_commit=None),
+                owner=User(
+                    login=repo.owner.login,
+                    username=repo.owner.name,
+                    email=repo.owner.email,
+                    html_url=repo.owner.html_url,
+                ),
+            )
         except Exception as e:
             logging.error(f"Failed to get repository {id} from GitHub: {e}")
             return None
@@ -43,10 +63,7 @@ def get_commits(self, repo: Repository, files: bool = True) -> list[Commit]:
                     message=c.commit.message,
                     author=self.get_user_data(c.author),
                     date=c.commit.author.date,
-                    files=[
-                        f.filename
-                            for f in c.files
-                    ] if files else None
+                    files=[f.filename for f in c.files] if files else None,
                 )
                 for c in commits
             ]
@@ -79,11 +96,8 @@ def get_issues(self, repo: Repository) -> list[Issue]:
                     closed_by=self.get_user_data(i.closed_by) if i.closed_by else None,
                     body=i.body,
                     user=self.get_user_data(i.user),
-                    labels= [
-                        l.name
-                        for l in i.labels
-                    ],
-                    milestone=i.milestone.title if i.milestone else None
+                    labels=[label.name for label in i.labels],
+                    milestone=i.milestone.title if i.milestone else None,
                 )
                 for i in issues
             ]
@@ -106,16 +120,10 @@ def get_pull_requests(self, repo: Repository) -> list[PullRequest]:
                     head_ref=p.head.ref,
                     base_ref=p.base.ref,
                     merged_by=self.get_user_data(p.merged_by) if p.merged_by else None,
-                    files=[
-                        f.filename
-                            for f in p.get_files()
-                    ],
+                    files=[file.filename for file in p.get_files()],
                     issue_url=p.issue_url,
-                    labels= [
-                        l.name
-                        for l in p.labels
-                    ],
-                    milestone=p.milestone.title if p.milestone else None
+                    labels=[label.name for label in p.labels],
+                    milestone=p.milestone.title if p.milestone else None,
                 )
                 for p in pulls
             ]
@@ -164,12 +172,14 @@ def get_forks(self, repo: Repository) -> list[Repository]:
         repo_client = self.client.get_repo(repo._id)
         result = []
         for r in repo_client.get_forks():
-            result.append(Repository(_id=repo.full_name, name=repo.name, url=repo.html_url))
+            result.append(
+                Repository(_id=repo.full_name, name=repo.name, url=repo.html_url)
+            )
         return result
 
     def get_comments(self, repo, obj) -> list[Comment]:
         result = []
-        if type(obj) == Issue:
+        if isinstance(obj, Issue):
             # TODO оптимизировать
             issues = self.client.get_repo(repo._id).get_issues(state='all')
             issue = None
@@ -178,8 +188,14 @@ def get_comments(self, repo, obj) -> list[Comment]:
                     issue = i
                     break
             for c in issue.get_comments():
-                result.append(Comment(body=c.body,created_at=c.created_at,author=self.get_user_data(c.user)))
-        elif type(obj) == PullRequest:
+                result.append(
+                    Comment(
+                        body=c.body,
+                        created_at=c.created_at,
+                        author=self.get_user_data(c.user),
+                    )
+                )
+        elif isinstance(obj, PullRequest):
             # TODO оптимизировать
             pulls = self.client.get_repo(repo._id).get_pulls(state='all')
             pull = None
@@ -188,7 +204,13 @@ def get_comments(self, repo, obj) -> list[Comment]:
                     pull = p
                     break
             for c in pull.get_comments():
-                result.append(Comment(body=c.body,created_at=c.created_at,author=self.get_user_data(c.user.login)))
+                result.append(
+                    Comment(
+                        body=c.body,
+                        created_at=c.created_at,
+                        author=self.get_user_data(c.user.login),
+                    )
+                )
 
         return result
 
@@ -200,7 +222,7 @@ def get_invites(self, repo: Repository) -> list[Invite]:
                     _id=i._id,
                     invitee=self.get_user_data(i.invitee),
                     created_at=i.created_at,
-                    html_url=i.html_url
+                    html_url=i.html_url,
                 )
                 for i in invites
             ]
@@ -210,11 +232,12 @@ def get_invites(self, repo: Repository) -> list[Invite]:
             )
             return []
 
+
 # Точка входа для тестирования
 if __name__ == "__main__":
     # Создайте клиент GitHub (используйте ваш токен)
-    client = Github("tocken")
-    api = GitHubRepoAPI(client)
+    # client = Github("tocken")
+    api = GitHubRepoAPI('client')
 
     # Укажите ваш репозиторий
     repo_name = ""

commits_parser.py

@@ -1,7 +1,8 @@
 from utils import logger
 import pytz
 from time import sleep
-#from github import Github, Repository, GithubException, PullRequest
+
+# from github import Github, Repository, GithubException, PullRequest
 from interface_wrapper import IRepositoryAPI, Repository
 
 EMPTY_FIELD = 'Empty field'
@@ -19,7 +20,9 @@
 )
 
 
-def log_repository_commits(client: IRepositoryAPI, repository: Repository, csv_name, start, finish, branch):
+def log_repository_commits(
+    client: IRepositoryAPI, repository: Repository, csv_name, start, finish, branch
+):
     branches = []
     match branch:
         case 'all':
@@ -56,7 +59,9 @@ def log_repository_commits(client: IRepositoryAPI, repository: Repository, csv_n
             sleep(TIMEDELTA)
 
 
-def log_commits(client: IRepositoryAPI, working_repos, csv_name, start, finish, branch, fork_flag):
+def log_commits(
+    client: IRepositoryAPI, working_repos, csv_name, start, finish, branch, fork_flag
+):
     logger.log_to_csv(csv_name, FIELDNAMES)
 
     for repo, token in working_repos:
@@ -66,7 +71,9 @@ def log_commits(client: IRepositoryAPI, working_repos, csv_name, start, finish,
             if fork_flag:
                 for forked_repo in client.get_forks(repo):
                     logger.log_title("FORKED:", forked_repo.full_name)
-                    log_repository_commits(client, forked_repo, csv_name, start, finish, branch)
+                    log_repository_commits(
+                        client, forked_repo, csv_name, start, finish, branch
+                    )
                     sleep(TIMEDELTA)
             sleep(TIMEDELTA)
         except Exception as e:

contributors_parser.py

@@ -1,7 +1,7 @@
 from utils import logger
 from time import sleep
 from typing import Generator
-from interface_wrapper import IRepositoryAPI, Repository, User
+from interface_wrapper import IRepositoryAPI, Repository
 
 EMPTY_FIELD = 'Empty field'
 TIMEDELTA = 0.05
@@ -22,14 +22,19 @@
 )
 
 
-def log_repository_contributors(client: IRepositoryAPI, repository: Repository, csv_name: str):
+def log_repository_contributors(
+    client: IRepositoryAPI, repository: Repository, csv_name: str
+):
     contributors_stats = get_contributors_stats(client, repository)
 
-    nvl = lambda val: val or EMPTY_FIELD
+    def nvl(val):
+        return val or EMPTY_FIELD
 
     for contributor_stat in contributors_stats.values():
         contributor = contributor_stat["contributor_object"]
-        contributor_permissions = client.get_collaborator_permission(repository, contributor)
+        contributor_permissions = client.get_collaborator_permission(
+            repository, contributor
+        )
 
         info_tmp = {
             'repository name': repository.name,
@@ -50,14 +55,15 @@ def log_repository_contributors(client: IRepositoryAPI, repository: Repository,
 
         sleep(TIMEDELTA)
 
+
 def get_contributors_stats(client: IRepositoryAPI, repository: Repository) -> dict:
     contributors_stats = dict()
     commits = client.get_commits(repository, False)
 
     for commit in commits:
         contributor = commit.author
 
-        if not contributor.login in contributors_stats:
+        if contributor.login not in contributors_stats:
             contributors_stats[contributor.login] = {
                 'total_commits': 0,
                 'email': contributor.email,
@@ -71,7 +77,9 @@ def get_contributors_stats(client: IRepositoryAPI, repository: Repository) -> di
     return contributors_stats
 
 
-def log_contributors(client: IRepositoryAPI, working_repos: Generator, csv_name: str, fork_flag: bool):
+def log_contributors(
+    client: IRepositoryAPI, working_repos: Generator, csv_name: str, fork_flag: bool
+):
     logger.log_to_csv(csv_name, FIELDNAMES)
 
     for repo, token in working_repos:

export_sheets.py

@@ -11,7 +11,7 @@ def write_data_to_table(csv_path, google_token, table_id, sheet_id):
 
     try:
         sh.worksheets('title', sheet_id)
-    except:
+    except Exception:
         sh.add_worksheet(sheet_id)
 
     wk_content = sh.worksheet_by_title(sheet_id)

forgejo/main.py

@@ -1,20 +1,20 @@
 from dotenv import dotenv_values
 from pyforgejo import PyforgejoApi
 
+
 def require_env_arg(config, name):
-    if not name in config:
+    if name not in config:
         print("Cannot find " + name + " in .env file. Aborting...")
         exit(1)
 
+
 config = dotenv_values(".env")
 require_env_arg(config, "API_TOKEN")
 require_env_arg(config, "BASE_URL")
 require_env_arg(config, "REPO_OWNER")
 require_env_arg(config, "REPO_NAME")
 
-client = PyforgejoApi(
-    base_url=config["BASE_URL"], api_key=config["API_TOKEN"]
-)
+client = PyforgejoApi(base_url=config["BASE_URL"], api_key=config["API_TOKEN"])
 
 repo = client.repository.repo_get(owner=config["REPO_OWNER"], repo=config["REPO_NAME"])
 

git_logger.py

@@ -1,5 +1,9 @@
 from github import Github, GithubException, PullRequest
-from interface_wrapper import IRepositoryAPI, RepositoryFactory, Repository, User, Branch
+from interface_wrapper import (
+    RepositoryFactory,
+    Repository,
+    Branch,
+)
 from time import sleep
 
 TIMEDELTA = 0.05
@@ -76,7 +80,13 @@ def get_next_repo(clients: GithubClients, repositories):
             exit(1)
         else:
             print(cur_client['token'])
-            yield Repository(_id=repo.full_name,name=repo.name,url=repo.html_url, default_branch=Branch(name=repo.default_branch, last_commit=None), owner=cur_client['api'].get_user_data(repo.owner)), cur_client['token']
+            yield Repository(
+                _id=repo.full_name,
+                name=repo.name,
+                url=repo.html_url,
+                default_branch=Branch(name=repo.default_branch, last_commit=None),
+                owner=cur_client['api'].get_user_data(repo.owner),
+            ), cur_client['token']
 
 
 def get_assignee_story(github_object):