define unknown user in Version works for one user

Author: Maximilian Karl

docs/changes.rst

@@ -105,8 +105,14 @@ Version 1.1.13 (July 29, 2021)
 
 * solved error: ignore Alias if already there in Utility(define_unknown_user)
 
-Version 1.1.14 (July 29, 2021)
+Version 1.1.14 (July 30, 2021)
 -----------------------------------
 * version download will check if there are defined user for unknown user
 * comment out some print
-* verion checks now if there are updates before downloading
+* verion checks now if there are updates before downloading
+
+Version 1.1.15 (July 30, 2021)
+-----------------------------------
+* define unknown user in Version works now only for one user
+* if a anonym_uuid is known from a different repository for this unknown user then this anonym uuid will be extract_user_data
+* The same unknown Author name will be connected to the same anonym_uuid

github2pandas/__init__.py

@@ -1 +1 @@
-__version__ = '1.1.14'
+__version__ = '1.1.15'

github2pandas/utility.py

@@ -43,7 +43,7 @@ class Utility():
             Get all assignees as one string.
         extract_labels(github_labels)
             Get all labels as one string.
-        extract_user_data(user, users_ids, data_root_dir)
+        extract_user_data(user, users_ids, data_root_dir, node_id_to_anonym_uuid=False)
             Extracting general user data.
         extract_author_data_from_commit(repo, sha, users_ids, data_root_dir)
             Extracting general author data from a commit.
@@ -55,8 +55,8 @@ class Utility():
             Extracting general event data from a issue or pull request.
         extract_comment_data(comment, parent_id, parent_name, users_ids, data_root_dir)
             Extracting general comment data from a pull request or issue.
-        define_unknown_user(user_dict, unknown_user, data_root_dir)
-            Defines a unknown user. Add unknown user to alias.
+        define_unknown_user(unknown_user_name, uuid, data_root_dir, new_user=False)
+            Defines a unknown user. Add unknown user to alias or creates new user
     
     """
     USERS = "Users.p"
@@ -407,9 +407,9 @@ def extract_labels(github_labels):
         return labels
 
     @staticmethod
-    def extract_user_data(user, users_ids, data_root_dir):
+    def extract_user_data(user, users_ids, data_root_dir, node_id_to_anonym_uuid=False):
         """
-        extract_user_data(user, users_ids, data_root_dir)
+        extract_user_data(user, users_ids, data_root_dir, node_id_to_anonym_uuid=False)
 
         Extracting general user data.
 
@@ -421,6 +421,8 @@ def extract_user_data(user, users_ids, data_root_dir):
             Dict of User Ids as Keys and anonym Ids as Value.
         data_root_dir : str
             Repo dir of the project.
+        node_id_to_anonym_uuid : bool, default=False
+            Node_id will be the anonym_uuid
         
         Returns
         -------
@@ -441,7 +443,10 @@ def extract_user_data(user, users_ids, data_root_dir):
         if users_file.is_file():
             users_df = pd.read_pickle(users_file)
         user_data = {}
-        user_data["anonym_uuid"] = generate_id(seed=user.node_id)
+        if node_id_to_anonym_uuid:
+            user_data["anonym_uuid"] = user.node_id
+        else:
+            user_data["anonym_uuid"] = generate_id(seed=user.node_id)
         user_data["id"] = user.node_id
         try:
             user_data["name"] = user.name
@@ -671,59 +676,57 @@ def extract_comment_data(comment, parent_id, parent_name, users_ids, data_root_d
         return comment_data
 
     @staticmethod
-    def define_unknown_user(user_dict, unknown_user, data_root_dir):
+    def define_unknown_user(unknown_user_name, uuid, data_root_dir, new_user=False):
         """
-        define_unknown_user(user_dict, unknown_user, data_root_dir)
+        define_unknown_user(unknown_user_name, uuid, data_root_dir, new_user=False)
 
-        Defines a unknown user. Add unknown user to alias.
+        Defines a unknown user. Add unknown user to alias or creates new user
 
         Parameters
         ----------
-        user_dict: dict
-            Dictionary which contains users. 
-        unknown_user : str
-            Name of a unknown user.
+        unknown_user_name: str
+            Name of unknown user. 
+        uuid: str
+            Uuid can be the anonym uuid of another user or random uuid for a new user. 
         data_root_dir : str
-            Repo dir of the project.
+            Data root directory for the repository.
+        new_user : bool, default=False
+            A complete new user with anonym_uuid will be generated.
 
         Returns
         -------
         str
             Uuid of the user.
 
-        Notes
-        -----
-            Example User Dict: {"unknown_user": "user uuid"}
-            If the real user node id does not exist in the users table then a new user will be created and the user uuid will be the node Id
-
         """
         users = Utility.get_users(data_root_dir)
-        if unknown_user in user_dict:
-            p_user = users.loc[users.anonym_uuid == user_dict[unknown_user]]
-            if not p_user.empty:
-                alias = ""
-                user = p_user.iloc[0]
-                if "alias" in user:
-                    if pd.isnull(user["alias"]) or (user["alias"] is None):
-                        alias = unknown_user
-                    else:
-                        all_alias = user["alias"].split(';')
-                        if not unknown_user in all_alias:
-                            alias = user["alias"] + ";" + unknown_user
-                        else:
-                            alias = user["alias"]
+        p_user = users.loc[users.anonym_uuid == uuid]
+        if not p_user.empty:
+            alias = ""
+            user = p_user.iloc[0]
+            if "alias" in user:
+                if pd.isnull(user["alias"]) or (user["alias"] is None):
+                    alias = unknown_user_name
                 else:
-                    alias = unknown_user
-                users.loc[users.anonym_uuid == 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 = unknown_user
-                email = numpy.NaN
-                login = numpy.NaN
-            users_ids = Utility.get_users_ids(data_root_dir)
-            return Utility.extract_user_data(UserData(),users_ids,data_root_dir)
+                    all_alias = user["alias"].split(';')
+                    if not unknown_user_name in all_alias:
+                        alias = user["alias"] + ";" + unknown_user_name
+                    else:
+                        alias = user["alias"]
+            else:
+                alias = unknown_user_name
+            users.loc[users.anonym_uuid == uuid, '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 = uuid
+            name = unknown_user_name
+            email = numpy.NaN
+            login = numpy.NaN
+        users_ids = Utility.get_users_ids(data_root_dir)
+        if new_user:
+            return Utility.extract_user_data(UserData(),users_ids,data_root_dir)
+        return Utility.extract_user_data(UserData(),users_ids,data_root_dir, node_id_to_anonym_uuid=True)

github2pandas/version.py

@@ -50,8 +50,8 @@ class Version():
         Extracting version data from a local repository and storing them in a mysql data base.
     generate_version_pandas_tables(repo, data_root_dir, check_for_updates=True)
         Extracting edits and commits in a pandas table.
-    define_unknown_users(user_list, data_root_dir)
-        Define unknown users in commits pandas table.
+    define_unknown_user(unknown_user_name, uuid, data_root_dir, new_user=False)
+        Define unknown user in commits pandas table.
     get_unknown_users(data_root_dir)
         Get all unknown users in from commits.
     get_version(data_root_dir, filename=VERSION_COMMITS)
@@ -352,35 +352,33 @@ def generate_version_pandas_tables(repo, data_root_dir, check_for_updates=True):
             pickle.dump(pd_Branches, f)          
 
     @staticmethod
-    def define_unknown_users(user_dict, data_root_dir):
+    def define_unknown_user(unknown_user_name, uuid, data_root_dir, new_user=False):
         """
-        define_unknown_users(user_dict, data_root_dir)
+        define_unknown_user(unknown_user_name, uuid, data_root_dir, new_user=False)
 
-        Define unknown users in commits pandas table.
+        Define unknown user in commits pandas table.
 
         Parameters
         ----------
-        user_dict: dict
-            Dictionary which contains users. 
+        unknown_user_name: str
+            Name of unknown user. 
+        uuid: str
+            Uuid can be the anonym uuid of another user or random uuid for a new user. 
         data_root_dir : str
             Data root directory for the repository.
+        new_user : bool, default=False
+            A complete new user with uuid will be generated.
 
-        Notes
-        -----
-        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:
-                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
+            unknown_users = pd_commits.unknown_user.unique()
+            if unknown_user_name in unknown_users:
+                new_uuid = Utility.define_unknown_user(unknown_user_name, uuid,data_root_dir, new_user=new_user)
+                if new_uuid is not None:
+                    pd_commits.loc[pd_commits.unknown_user == unknown_user_name, 'author'] = new_uuid
+                    pd_commits.loc[pd_commits.unknown_user == unknown_user_name, 'committer'] = new_uuid
+                    pd_commits.loc[pd_commits.unknown_user == unknown_user_name, 'unknown_user'] = numpy.NaN
 
             version_folder = Path(data_root_dir, Version.VERSION_DIR)
             pd_commits_file = Path(version_folder, Version.VERSION_COMMITS)

tests/test_utility.py

@@ -294,17 +294,17 @@ class User:
              email = "test_define_unknown_user@test.de"
              login = "test_define_unknown_user"
         user = Utility.extract_user_data(User(), self.users_ids, self.default_data_folder)
-        new_user = Utility.define_unknown_user({"test":user},"test",self.default_data_folder)
+        new_user = Utility.define_unknown_user("test",user,self.default_data_folder)
         class User2:
              node_id = "test_define_unknown_user2"
-             name = "test_define_unknown_use2r"
+             name = "test_define_unknown_user2"
              email = "test_define_unknown_user2@test.de"
              login = "test_define_unknown_user2"
         user2 = Utility.extract_user_data(User2(), self.users_ids, self.default_data_folder)
-        new_user = Utility.define_unknown_user({"test2":user2},"test2",self.default_data_folder)
-        new_user = Utility.define_unknown_user({"test3":user2},"test3",self.default_data_folder)
-        new_user = Utility.define_unknown_user({"test3":user2},"test3",self.default_data_folder)
-        print(Utility.get_users(self.default_data_folder))
+        new_user = Utility.define_unknown_user("test2",user2,self.default_data_folder)
+        new_user = Utility.define_unknown_user("test3",user2,self.default_data_folder)
+        new_user = Utility.define_unknown_user("test3",user2,self.default_data_folder)
+        #print(Utility.get_users(self.default_data_folder))
 
     def setUp(self):
         self.default_data_folder.mkdir(parents=True, exist_ok=True)