utils-logger implimented (#86)

Author: PeeachPie

commits_parser.py

@@ -1,4 +1,4 @@
-import csv
+from utils import logger
 import pytz
 from time import sleep
 from github import Github, Repository, GithubException, PullRequest
@@ -18,16 +18,6 @@
 )
 
 
-def log_commit_to_csv(info, csv_name):
-    with open(csv_name, 'a', newline='') as file:
-        writer = csv.DictWriter(file, fieldnames=FIELDNAMES)
-        writer.writerow(info)
-
-
-def log_commit_to_stdout(info):
-    print(info)
-
-
 def log_repository_commits(repository: Repository, csv_name, start, finish, branch):
     branches = []
     match branch:
@@ -63,25 +53,24 @@ def log_repository_commits(repository: Repository, csv_name, start, finish, bran
                 ]
                 info = dict(zip(FIELDNAMES, commit_data))
 
-                log_commit_to_csv(info, csv_name)
-                log_commit_to_stdout(info)
+                logger.log_to_csv(csv_name, FIELDNAMES, info)
+                logger.log_to_stdout(info)
+
                 sleep(TIMEDELTA)
 
 
 def log_commits(
     client: Github, working_repos, csv_name, start, finish, branch, fork_flag
 ):
-    with open(csv_name, 'w', newline='') as file:
-        writer = csv.writer(file)
-        writer.writerow(FIELDNAMES)
+    logger.log_to_csv(csv_name, FIELDNAMES)
 
     for repo in working_repos:
         try:
-            print('=' * 20, repo.full_name, '=' * 20)
+            logger.log_title(repo.full_name)
             log_repository_commits(repo, csv_name, start, finish, branch)
             if fork_flag:
                 for forked_repo in repo.get_forks():
-                    print('=' * 20, "FORKED:", forked_repo.full_name, '=' * 20)
+                    logger.log_title("FORKED:", forked_repo.full_name)
                     log_repository_commits(forked_repo, csv_name, start, finish, branch)
                     sleep(TIMEDELTA)
             sleep(TIMEDELTA)

contributors_parser.py

@@ -1,4 +1,4 @@
-import csv
+from utils import logger
 from time import sleep
 from typing import Generator
 from github import Github, Repository, GithubException
@@ -22,16 +22,6 @@
 )
 
 
-def log_contributors_to_csv(info: dict, csv_name: str):
-    with open(csv_name, 'a', newline='') as file:
-        writer = csv.DictWriter(file, fieldnames=FIELDNAMES)
-        writer.writerow(info)
-
-
-def log_contributors_to_stdout(info: dict):
-    print(info)
-
-
 def log_repository_contributors(repository: Repository, csv_name: str):
     contributors_stats = get_contributors_stats(repository)
 
@@ -56,8 +46,8 @@ def log_repository_contributors(repository: Repository, csv_name: str):
             'site_admin': contributor.site_admin,
         }
 
-        log_contributors_to_csv(info_tmp, csv_name)
-        log_contributors_to_stdout(info_tmp)
+        logger.log_to_csv(csv_name, FIELDNAMES, info_tmp)
+        logger.log_to_stdout(info_tmp)
 
         sleep(TIMEDELTA)
 
@@ -85,18 +75,16 @@ def get_contributors_stats(repository: Repository) -> dict:
 def log_contributors(
     client: Github, working_repos: Generator, csv_name: str, fork_flag: bool
 ):
-    with open(csv_name, 'w', newline='') as file:
-        writer = csv.writer(file)
-        writer.writerow(FIELDNAMES)
+    logger.log_to_csv(csv_name, FIELDNAMES)
 
     for repo in working_repos:
         try:
-            print('=' * 20, repo.full_name, '=' * 20)
+            logger.log_title(repo.full_name)
             log_repository_contributors(repo, csv_name)
 
             if fork_flag:
                 for forked_repo in repo.get_forks():
-                    print('=' * 20, "FORKED:", forked_repo.full_name, '=' * 20)
+                    logger.log_title("FORKED:", forked_repo.full_name)
                     log_repository_contributors(forked_repo, csv_name)
                     sleep(TIMEDELTA)
 

invites_parser.py

@@ -1,17 +1,14 @@
-import csv
-import pytz
-import requests
-import json
+from utils import logger
 from time import sleep
 from github import Github, Repository, GithubException, PullRequest
-import csv
 
 FIELDNAMES = (
     'repository name',
     'invited login',
     'invite creation date',
     'invitation url',
 )
+TIMEDELTA = 0.05
 
 
 def log_inviter(repo, invite, writer):
@@ -25,16 +22,26 @@ def log_inviter(repo, invite, writer):
     print(invite_info)
 
 
-def log_invitations(client: Github, working_repos, csv_name, timedelta=1):
-    with open(csv_name, 'w', newline='') as file:
-        writer = csv.writer(file)
-        writer.writerow(FIELDNAMES)
-        for repo in working_repos:
-            print('=' * 20, repo.full_name, '=' * 20)
-            invitations = repo.get_pending_invitations()
-            for invite in invitations:
-                try:
-                    log_inviter(repo, invite, writer)
-                    sleep(timedelta)
-                except Exception as e:
-                    print(e)
+def log_repository_invitations(repository: Repository, csv_name):
+    invitations = repository.get_pending_invitations()
+    for invite in invitations:
+        invite_info = {
+            'repository name': repository.full_name,
+            'invited login': invite.invitee.login,
+            'invite creation date': invite.created_at.strftime("%d/%m/%Y, %H:%M:%S"),
+            'invitation url': invite.html_url,
+        }
+        logger.log_to_csv(csv_name, FIELDNAMES, invite_info)
+        logger.log_to_stdout(invite_info)
+        sleep(TIMEDELTA)
+
+
+def log_invitations(client: Github, working_repos, csv_name):
+    logger.log_to_csv(csv_name, FIELDNAMES)
+
+    for repo in working_repos:
+        logger.log_title(repo.full_name)
+        try:
+            log_repository_invitations(repo, csv_name)
+        except Exception as e:
+            print(e)

issues_parser.py

@@ -1,4 +1,4 @@
-import csv
+from utils import logger
 import pytz
 import requests
 import json
@@ -35,16 +35,6 @@
 )
 
 
-def log_issue_to_csv(info, csv_name):
-    with open(csv_name, 'a', newline='') as file:
-        writer = csv.DictWriter(file, fieldnames=FIELDNAMES)
-        writer.writerow(info)
-
-
-def log_issue_to_stdout(info):
-    print(info)
-
-
 def get_connected_pulls(issue_number, repo_owner, repo_name, token):
     access_token = token
     repo_owner = repo_owner.login
@@ -172,26 +162,26 @@ def log_repository_issues(repository: Repository, csv_name, token, start, finish
                 info['comment author name'] = comment.user.name
                 info['comment author login'] = comment.user.login
                 info['comment author email'] = comment.user.email
-                log_issue_to_csv(info, csv_name)
-                log_issue_to_stdout(info)
+
+                logger.log_to_csv(csv_name, FIELDNAMES, info)
+                logger.log_to_stdout(info)
         else:
-            log_issue_to_csv(info_tmp, csv_name)
-            log_issue_to_stdout(info_tmp)
+            logger.log_to_csv(csv_name, FIELDNAMES, info_tmp)
+            logger.log_to_stdout(info_tmp)
+
         sleep(TIMEDELTA)
 
 
 def log_issues(client: Github, working_repo, csv_name, token, start, finish, fork_flag):
-    with open(csv_name, 'w', newline='') as file:
-        writer = csv.writer(file)
-        writer.writerow(FIELDNAMES)
+    logger.log_to_csv(csv_name, FIELDNAMES)
 
     for repo in working_repo:
         try:
-            print('=' * 20, repo.full_name, '=' * 20)
+            logger.log_title(repo.full_name)
             log_repository_issues(repo, csv_name, token, start, finish)
             if fork_flag:
                 for forked_repo in repo.get_forks():
-                    print('=' * 20, "FORKED:", forked_repo.full_name, '=' * 20)
+                    logger.log_title("FORKED:", forked_repo.full_name)
                     log_repository_issues(forked_repo, csv_name, token, start, finish)
                     sleep(TIMEDELTA)
             sleep(TIMEDELTA)

main.py

@@ -12,7 +12,6 @@
 import contributors_parser
 
 
-
 def parse_args():
     parser = argparse.ArgumentParser()
     parser.add_argument("--invites", help="print pending invites", action="store_true")
@@ -140,10 +139,9 @@ def main():
         print(e)
     else:
         working_repos = git_logger.get_next_repo(client, repositories)
-        if args.start:
-            start = parse_time(args.start.split('-'))
-        if args.finish:
-            finish = parse_time(args.finish.split('-'))
+        start = parse_time(args.start.split('-'))
+        finish = parse_time(args.finish.split('-'))
+
         if args.commits:
             commits_parser.log_commits(
                 client, working_repos, csv_name, start, finish, args.branch, fork_flag

pull_requests_parser.py

@@ -1,4 +1,4 @@
-import csv
+from utils import logger
 import pytz
 import requests
 import json
@@ -38,16 +38,6 @@
 )
 
 
-def log_pr_to_stdout(info):
-    print(info)
-
-
-def log_pr_to_csv(info, csv_name):
-    with open(csv_name, 'a', newline='') as file:
-        writer = csv.DictWriter(file, fieldnames=FIELDNAMES)
-        writer.writerow(info)
-
-
 def get_related_issues(pull_request_number, repo_owner, repo_name, token):
     access_token = token
     repo_owner = repo_owner.login
@@ -161,11 +151,12 @@ def log_repositories_pr(
                     info['comment author name'] = comment.user.name
                     info['comment author login'] = comment.user.login
                     info['comment author email'] = nvl(comment.user.email)
-                    log_pr_to_csv(info, csv_name)
-                    log_pr_to_stdout(info)
+
+                    logger.log_to_csv(csv_name, FIELDNAMES, info)
+                    logger.log_to_stdout(info)
         else:
-            log_pr_to_csv(info_tmp, csv_name)
-            log_pr_to_stdout(info_tmp)
+            logger.log_to_csv(csv_name, FIELDNAMES, info_tmp)
+            logger.log_to_stdout(info_tmp)
         sleep(TIMEDELTA)
 
 
@@ -179,17 +170,15 @@ def log_pull_requests(
     fork_flag,
     log_comments=False,
 ):
-    with open(csv_name, 'w', newline='') as file:
-        writer = csv.writer(file)
-        writer.writerow(FIELDNAMES)
+    logger.log_to_csv(csv_name, FIELDNAMES)
 
     for repo in working_repos:
         try:
-            print('=' * 20, repo.full_name, '=' * 20)
+            logger.log_title(repo.full_name)
             log_repositories_pr(repo, csv_name, token, start, finish)
             if fork_flag:
                 for forked_repo in repo.get_forks():
-                    print('=' * 20, "FORKED:", forked_repo.full_name, '=' * 20)
+                    logger.log_title("FORKED:", forked_repo.full_name)
                     log_repositories_pr(
                         forked_repo, csv_name, token, start, finish, log_comments
                     )

utils.py

@@ -0,0 +1,43 @@
+import csv
+
+TITLE_LEN = 80
+MIN_SIDE_PADDING = 4
+SIDE_WHITE_SPACES = 1
+
+
+class logger:
+    @staticmethod
+    def log_title(title: str, title_len: int = TITLE_LEN):
+        final_len = max(
+            title_len, len(title) + MIN_SIDE_PADDING * 2 + SIDE_WHITE_SPACES * 2
+        )
+
+        print(
+            f"{SIDE_WHITE_SPACES * ' ' + title + ' ' * SIDE_WHITE_SPACES:=^{final_len}}"
+        )
+
+    @staticmethod
+    def log_to_csv(csv_name: str, field_names: tuple[str], row: dict | None = None):
+        if isinstance(row, dict):
+            with open(csv_name, 'a', newline='') as file:
+                writer = csv.DictWriter(file, fieldnames=field_names)
+                writer.writerow(row)
+        elif row is None:
+            with open(csv_name, 'w', newline='') as file:
+                writer = csv.writer(file)
+                writer.writerow(field_names)
+        else:
+            raise TypeError(f"row has type {type(row)} but must be [ dict | None ]")
+
+    @staticmethod
+    def log_to_stdout(info: dict):
+        print(info)
+
+    @staticmethod
+    def log_error(error: str):
+        # или использовать logging, как в interface_wrapper
+        pass
+
+    @staticmethod
+    def log_warning(warning: str):
+        pass