define unknown users takes now a dictionary

Author: Maximilian Karl

docs/changes.rst

@@ -59,4 +59,10 @@ Version 1.1.5 (Mai 27, 2021)
 * solve author and committer problem
 * add define_unknown_user to Version
 * add get unknown_user from commits
-* get_repos has now mutiple whitelist and blacklist pattern and are optional now
+* get_repos has now mutiple whitelist and blacklist pattern and are optional now
+
+
+Version 1.1.6 (Mai 28, 2021)
+-----------------------------------
+
+* define unknown users takes now a dictionary in with unknown user as key and id as value. If the user is doesnt exists then a new user will be added.

github2pandas/__init__.py

@@ -1 +1 @@
-__version__ = '1.1.5'
+__version__ = '1.1.6'

github2pandas/utility.py

@@ -1,5 +1,6 @@
 import os
 from pathlib import Path
+import numpy
 import pandas as pd
 import github
 import pickle
@@ -440,18 +441,14 @@ def extract_user_data(user, users_ids, data_root_dir):
         user_data["anonym_uuid"] = generate_id(seed=user.node_id)
         users_ids[user.node_id] = user_data["anonym_uuid"]
         user_data["id"] = user.node_id
+        user_data["name"] = user.name
+        user_data["email"] = user.email
+        user_data["login"] = user.login
         try:
-            user_data["name"] = user.name
+            user_data["alias"] = user.alias
         except:
-            user_data["name"] = "exception Name"
-        try:
-            user_data["email"] = user.email
-        except:
-            user_data["email"] = "exception Email"
-        try:
-            user_data["login"] = user.login
-        except:
-            user_data["login"] = "exception Login"
+            pass
+
         users_df = users_df.append(user_data, ignore_index=True)
         with open(users_file, "wb") as f:
             pickle.dump(users_df, f)
@@ -656,3 +653,32 @@ def extract_comment_data(comment, parent_id, parent_name, users_ids, data_root_d
             comment_data["author"] = Utility.extract_user_data(comment.user, users_ids, data_root_dir)
         return comment_data
 
+    @staticmethod
+    def define_unknown_user(user_dict, unknown_user, data_root_dir):
+        users = Utility.get_users(data_root_dir)
+        if unknown_user in user_dict:
+            p_user = users.loc[users.id == user_dict[unknown_user]]
+            if not p_user.empty:
+                alias = ""
+                user = p_user.iloc[0]
+                if "alias" in user:
+                    if (user["alias"] == numpy.NAN) or (user["alias"] is None):
+                        alias = unknown_user
+                    else:
+                        alias = user["alias"] + ";" + unknown_user
+                else:
+                    alias = unknown_user
+                users.loc[users.id == user_dict[unknown_user], 'alias'] = alias
+                pd_file = Path(data_root_dir, Utility.USERS)
+                with open(pd_file, "wb") as f:
+                    pickle.dump(users, f)
+                return user["anonym_uuid"]
+            
+            class UserData:
+                node_id = user_dict[unknown_user]
+                name = numpy.NaN
+                email = numpy.NaN
+                login = numpy.NaN
+                alias = unknown_user  
+            users_ids = Utility.get_users_ids(data_root_dir)
+            return Utility.extract_user_data(UserData(),users_ids,data_root_dir)

github2pandas/version.py

@@ -301,50 +301,36 @@ def generate_version_pandas_tables(repo, data_root_dir):
             pickle.dump(pd_Branches, f)          
 
     @staticmethod
-    def define_unknown_users(user_list, data_root_dir):
+    def define_unknown_users(user_dict, data_root_dir):
         """
-        define_unknown_users(user_list, data_root_dir)
+        define_unknown_users(user_dict, data_root_dir)
 
         Define unknown users in commits pandas table
 
         Parameters
         ----------
-        user_list: list
-            List which contains users. 
+        user_dict: dict
+            Dictionary which contains users. 
         data_root_dir : str
             Data root directory for the repository.
 
         Notes
         -----
-        Example User: {"node_id": "unique_id_0", "email":"mail", "name": "name", "login": "login"}
-        All keys are optional.
+        Example User: {"unknown_user": "real user node id"}
+        If the real user node id does not exist in the users table then a new user will be created
         
         """
         pd_commits = Version.get_version(data_root_dir)
         if "unknown_user" in pd_commits:
             unknown_user_commits = pd_commits.loc[pd_commits.unknown_user.notna()]
             unknown_users = unknown_user_commits.unknown_user.unique()
             for unknown_user in unknown_users:
-                for user in user_list:
-                    if (user["email"] == unknown_user) or (user["name"] == unknown_user) or (user["login"] == unknown_user):
-                        if "node_id" not in user:
-                            user["node_id"] = "node_id"
-                        if "name" not in user:
-                            user["name"] = numpy.NaN
-                        if "email" not in user:
-                            user["email"] = numpy.NaN
-                        if "login" not in user:
-                            user["login"] = numpy.NaN
-                        class UserData:
-                            node_id = user["node_id"]
-                            name = user["name"]
-                            email = user["email"]
-                            login = user["login"]
-                        users_ids = Utility.get_users_ids(data_root_dir)
-                        uuid = Utility.extract_user_data(UserData(),users_ids,data_root_dir)
-                        pd_commits.loc[pd_commits.unknown_user == unknown_user, 'author'] = uuid
-                        pd_commits.loc[pd_commits.unknown_user == unknown_user, 'committer'] = uuid
-                        pd_commits.loc[pd_commits.unknown_user == unknown_user, 'unknown_user'] = numpy.NaN
+                uuid = Utility.define_unknown_user(user_dict,unknown_user,data_root_dir)
+                if uuid is not None:
+                    pd_commits.loc[pd_commits.unknown_user == unknown_user, 'author'] = uuid
+                    pd_commits.loc[pd_commits.unknown_user == unknown_user, 'committer'] = uuid
+                    pd_commits.loc[pd_commits.unknown_user == unknown_user, 'unknown_user'] = numpy.NaN
+
             version_folder = Path(data_root_dir, Version.VERSION_DIR)
             pd_commits_file = Path(version_folder, Version.VERSION_COMMITS)
             with open(pd_commits_file, "wb") as f: