contact-person-profile-csv-imp-local 0.0.28__py3-none-any.whl → 0.0.29__py3-none-any.whl

contact_person_profile_csv_imp_local/CSVToContactPersonProfile.py

@@ -1,3 +1,4 @@
+# TODO Please rename the file based on our naming convention i.e. contact_person
 import csv
 import os
 from datetime import datetime
@@ -103,13 +104,14 @@ DEFAULT_PROFILE_ID = 0
 
 class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
                                 object=CSVToContactPersonProfileConstants.CSV_LOCAL_PYTHON_PACKAGE_CODE_LOGGER_OBJECT):
-    def __init__(self, is_test_data: bool = False) -> None:
+    def __init__(self, groups_str: str = None, is_test_data: bool = False) -> None:
         GenericCRUD.__init__(self, default_schema_name="field", default_column_name="field_id",
                              default_table_name="field_table", default_view_table_name="field_view",
                              is_test_data=is_test_data)
         self.contact_entity_type_id = self.select_one_value_by_column_and_value(
             schema_name="entity_type", view_table_name="entity_type_ml_en_view",
             select_clause_value="entity_type_id", column_name="title", column_value="Contact")
+        self.groups_list: list[str] = [group.strip() for group in groups_str.split(",")] if groups_str else []
         self.user_context = UserContext()
         self.organization_profiles = OrganizationProfilesLocal(is_test_data=is_test_data)
         self.contact_persons = ContactPersonsLocal(is_test_data=is_test_data)
@@ -155,6 +157,8 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
     # ans: it cannot be after directory_name and csv_path because it is a required parameter
 
     # TODO: break this function into smaller functions
+    # TODO Align the parameters between import-contact-csv with sync-google-contact
+    # TODO Can we please add groups_str parameter to both sync-google-contact and import-contact-csv where we add all contacts to those groups?
     def insert_update_contact_from_csv(
             self, *, data_source_type_id: int, file_name: str = None, user_external_username: str,
             # TODO Add support to criteria_set_id
@@ -183,6 +187,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
         if not os.path.exists(csv_file_path):
             raise FileNotFoundError(f"File {csv_file_path} not found")
 
+        # TODO Why do we need it? - Those fields will be added to the contact_dict
         contact_fields_to_keep = (
             'name_prefix', 'additional_name', 'name_suffix', 'nickname', 'full_name', 'title', 'department', 'notes',
             'first_name', 'last_name', 'phone1', 'phone2', 'phone3', 'birthday', 'email1', 'email2', 'email3',
@@ -302,6 +307,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
     # TODO Use regex to extract the data from the URL
     # TODO add to user_external using user-external-python-package
 
+    # TODO This looks like a generic method, please move it to url-remote-python-package
     @staticmethod
     def process_url(original_url: str) -> str:
         prefixes = ['http://', 'https://']  # noqa
@@ -316,6 +322,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
 
     # TODO: add a method to add notes to text_block process them to retrieve the groups and create and link the groups to the user
 
+    # TODO Please change ALL methods which are not public to become private
     def process_notes(self, contact_note: str) -> None:
         # TODO number_of_system_recommednded_groups_identified_in_contact_notes = get_system_recommended_groups_from_contact_notes( contact_notes: str)
 
@@ -333,6 +340,10 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
 
         pass
 
+
+    # TODO Please move this method if not exists to LocationsLocal
+    # TODO get_location_type_id_by_location_name(
+    # This method is being used by import-csv-contact
     def get_location_type_id_by_name(self, location_type_name: str) -> int or None:
         """
         Get the location type ID by its name
@@ -344,6 +355,8 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
             select_clause_value="location_type_id", column_name="title", column_value=location_type_name)
         return location_type_id
 
+    # TODO Move this method to ContactsLocal class in contact-local
+    # This method is being used by import-csv-contact
     def __insert_contact_details_to_db(self, *, contact_dict: dict, user_external_id: int,
                                        data_source_instance_id: int, data_source_type_id: int) -> int:
 
@@ -352,7 +365,10 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
 
         # insert link contact_location
         # The location is in contact_dict
+        # TODO Can we have a better name for locations_results? Maybe contact_locations?
         location_results = self.__insert_link_contact_location(contact_dict=contact_dict) or [{}]
+        # TODO Why do we process only [0]? What if there are multiple locations?
+        # TODO If we don't suppose multiple locations, maybe we should change it to contact_dict["main_location_id"] as we do in other places 
         contact_dict["location_id"] = location_results[0].get("location_id")
         contact_dict["country_id"] = location_results[0].get("country_id")
 
@@ -396,6 +412,8 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
         )
         return importer_id
 
+    # TODO Move this method to LocationsLocal
+    # This method is being used by import-csv-contact
     def __insert_organization(self, contact_dict: dict) -> int or None:
 
         if not contact_dict.get("organization"):
@@ -440,6 +458,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
 
         return organization_dict
 
+    # TODO When do we use it? Multiple profiles to one organization?
     def __insert_organization_profile(self, organization_id: int, profiles_ids_list: list[int]) -> list[int] or None:
 
         if not organization_id or not profiles_ids_list:
@@ -462,6 +481,8 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
             _groups = contact_dict.get("groups").split(", ")
             for group in _groups:
                 groups.append(group)
+        for group in self.groups_list:
+            groups.append(group)
         if len(groups) > 0:
             groups_linked = self.contact_groups.insert_link_contact_group_with_group_local(
                 contact_id=contact_id, groups_names=groups)
@@ -568,12 +589,15 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
         location_dicts = self.__procces_location_of_contact(contact_dict)
         if not location_dicts:
             return
-        location_results = [self.contact_location.insert_contact_and_link_to_location(
-            location_dict=location_dict, contact_id=contact_id)
-            for location_dict in location_dicts]
-
-        return location_results
-
+        locations_results = []
+        for location_dict in location_dicts:
+            location_results = self.contact_location.insert_contact_and_link_to_location(
+                location_dict=location_dict, contact_id=contact_id)
+            if location_results:
+                locations_results.append(location_results)
+        return locations_results
+
+    # TODO merge this method with the method in google-contact-sync
     def __insert_importer(self, contact_id: int, location_id: int, user_external_id: int,
                           data_source_type_id: int, data_source_instance_id: int) -> int:
         # TODO: Shall we consider the url of csv's as the following? Use Sql2Code. Use const enum
@@ -583,7 +607,8 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
             url = "www.outlook.com"
         elif data_source_type_id == 18:
             url = "www.linkedin.com"
-        elif data_source_type_id == 57:
+        # TODO Please change all Magic Numbers to data generated by Sql2Code
+        elif data_source_type_id == 57: # BGU Course csv
             url = None
         else:
             raise ValueError("data_source_type_id is not valid")
@@ -598,6 +623,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
 
         return importer_id
 
+    # TODO Move this method to ContactsLocal if not exists already
     def __procces_location_of_contact(self, contact_dict: dict) -> dict or None:
         """
         Process location of Google contact
@@ -689,6 +715,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
         return proccessed_location_dicts
 
     @staticmethod
+    # TODO Move this method to LocationsLocal if not exists already
     def __create_location_dict(*, address_street: str, address_city: str, address_postal_code: str,
                                address_country: str, address_state: str) -> dict:
         location_dict = {
@@ -706,12 +733,14 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
         return location_dict
 
     @staticmethod
+    # Move this method to ContactsLocal if not exists already
     def __get_phone_numbers_list(contact_dict: dict) -> list:
         phones_list = [contact_dict.get(f"phone{i}")
                        for i in range(1, 4) if contact_dict.get(f"phone{i}")]
         return phones_list
 
     @staticmethod
+    # Move this method to ContactsLocal if not exists already
     def __get_email_addresses_list(contact_dict: dict) -> list:
         emails_list = [contact_dict.get(f"email{i}")
                        for i in range(1, 4) if contact_dict.get(f"email{i}")]
@@ -736,6 +765,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
 
         return user_external_id
 
+    # Move this method to DataSourceInstancesLocal in data-source-instance-local-python-package 
     def __get_data_source_instance_id(self, data_source_type_id: int, csv_file_path: str, user_external_id: int,
                                       file_name: str,
                                       user_external_username: str, start_index: int, end_index: int) -> int:
@@ -760,6 +790,7 @@ class CSVToContactPersonProfile(GenericCRUD, metaclass=MetaLogger,
         return data_source_instance_id
 
     @staticmethod
+    # TODO Move this function to python-sdk
     def detect_encoding(file_path: str, data_source_type_id: int = None):
         if data_source_type_id == 16 or data_source_type_id == 17 or data_source_type_id == 18:
             return "utf-8"

{contact_person_profile_csv_imp_local-0.0.28.dist-info → contact_person_profile_csv_imp_local-0.0.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: contact-person-profile-csv-imp-local
-Version: 0.0.28
+Version: 0.0.29
 Summary: PyPI Package for Circles CSVToContactPersonProfile-local Local/Remote Python
 Home-page: https://github.com/circles-zone/contact-person-profile-csv-imp-local-python-package
 Author: Circles

{contact_person_profile_csv_imp_local-0.0.28.dist-info → contact_person_profile_csv_imp_local-0.0.29.dist-info}/RECORD

@@ -1,7 +1,7 @@
-contact_person_profile_csv_imp_local/CSVToContactPersonProfile.py,sha256=KlaCY4YDlMu77bZLF7sIXHiYLfiDu7scds_CyS4ugMc,41462
+contact_person_profile_csv_imp_local/CSVToContactPersonProfile.py,sha256=5Z7Ry0pXftYx5t2c5M-SamiFLdtfHvd7mA9Mf6s11Xg,43690
 contact_person_profile_csv_imp_local/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 contact_person_profile_csv_imp_local/contact_person_profile_csv_imp_local_constants.py,sha256=eE0Bg2dCPrmG72K20k0_KOckc61C9cGSgH0Zgae_lbk,957
-contact_person_profile_csv_imp_local-0.0.28.dist-info/METADATA,sha256=ZpO8eNNPmyDib3wNYdxIMAcK5faKxhghbPHKYQC3cK8,1481
-contact_person_profile_csv_imp_local-0.0.28.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-contact_person_profile_csv_imp_local-0.0.28.dist-info/top_level.txt,sha256=at6BnVzULDB109KZx9Cl9ClCHU4c0ykfV38WX-QR71U,37
-contact_person_profile_csv_imp_local-0.0.28.dist-info/RECORD,,
+contact_person_profile_csv_imp_local-0.0.29.dist-info/METADATA,sha256=QjTN4mavxPgwRaXO8td-zu5qudljl67ZukaNjmKZqZE,1481
+contact_person_profile_csv_imp_local-0.0.29.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+contact_person_profile_csv_imp_local-0.0.29.dist-info/top_level.txt,sha256=at6BnVzULDB109KZx9Cl9ClCHU4c0ykfV38WX-QR71U,37
+contact_person_profile_csv_imp_local-0.0.29.dist-info/RECORD,,