atomicshop 2.12.1__py3-none-any.whl → 2.12.3__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.12.1'
+__version__ = '2.12.3'

atomicshop/diff_check.py

@@ -38,7 +38,7 @@ class DiffChecker:
             The object is 'None' by default, since there are objects that are needed to be provided in the
             function input for that object. So, not always you know what your object type during class initialization.
         :param check_object_display_name: string, name of the object to display in the message.
-            If not specified, the 'check_object' will be displayed.
+            If not specified, the provided 'check_object' will be displayed.
         :param aggregation: boolean, if True, the object will be aggregated with other objects in the list of objects.
             Meaning, that the object will be checked against the existing objects in the list, and if it is not
             in the list, it will be added to the list. If it is in the list, it will be ignored.
@@ -62,6 +62,74 @@ class DiffChecker:
 
             True: return updated dictionary on first cycle. This is the default.
             False: don't return updated dictionary on first cycle.
+
+        --------------------------------------------------
+
+        Working example:
+        from atomicshop import diff_check
+
+
+        # Example of checking list of dicts.
+        check_list_of_dicts = [
+            {'name': 'John', 'age': 25},
+            {'name': 'Alice', 'age': 30}
+        ]
+
+        diff_checker = diff_check.DiffChecker(
+            check_object=check_list_of_dicts,
+            check_object_display_name='List of Dicts',
+            aggregation=True,
+            input_file_path='D:\\input\\list_of_dicts.json',
+            input_file_write_only=True,
+            return_first_cycle=True
+        )
+
+        result, message = diff_checker.check_list_of_dicts(
+            sort_by_keys=['name']
+        )
+
+        # If result is not None, it means that the object was updated.
+        if result:
+            print(message)
+
+        --------------------------------------------------
+
+        Working example when you need to aggregate a list of dicts, meaning only new entries will be added to the list:
+        from atomicshop import diff_check
+
+
+        diff_checker = diff_check.DiffChecker(
+            check_object_display_name='List of Dicts',
+            aggregation=True,
+            input_file_path='D:\\input\\list_of_dicts.json',
+            input_file_write_only=True,
+            return_first_cycle=True
+        )
+
+        # Example of checking list of dicts.
+        check_list_of_dicts = [
+            {'name': 'John', 'age': 25},
+            {'name': 'Alice', 'age': 30}
+        ]
+
+        diff_checker.check_object = check_list_of_dicts
+        result, message = diff_checker.check_list_of_dicts()
+
+        # If result is not None, it means that the object was updated.
+        if result:
+            print(message)
+
+
+        check_list_of_dicts = [
+            {'name': 'John', 'age': 25},
+            {'name': 'Jessie', 'age': 50}
+        ]
+
+        diff_checker.check_object = check_list_of_dicts
+        result, message = diff_checker.check_list_of_dicts()
+
+        if result:
+            print(message)
         """
 
         # 'check_object' can be none, so checking if it not equals empty string.
@@ -130,13 +198,13 @@ class DiffChecker:
                 try:
                     if self.save_as == 'txt':
                         self.previous_content = file_io.read_file(
-                            self.input_file_path, stderr=False, **print_kwargs)
+                            self.input_file_path, stderr=False, **(print_kwargs or {}))
                     elif self.save_as == 'json':
                         self.previous_content = jsons.read_json_file(
-                            self.input_file_path, stderr=False, **print_kwargs)
+                            self.input_file_path, stderr=False, **(print_kwargs or {}))
                 except FileNotFoundError as except_object:
                     message = f"Input File [{Path(except_object.filename).name}] doesn't exist - Will create new one."
-                    print_api(message, color='yellow', **print_kwargs)
+                    print_api(message, color='yellow', **(print_kwargs or {}))
                     pass
 
             # get the content of current function.
@@ -182,10 +250,10 @@ class DiffChecker:
             if self.input_file_path:
                 if self.save_as == 'txt':
                     # noinspection PyTypeChecker
-                    file_io.write_file(self.previous_content, self.input_file_path, **print_kwargs)
+                    file_io.write_file(self.previous_content, self.input_file_path, **(print_kwargs or {}))
                 elif self.save_as == 'json':
                     jsons.write_json_file(
-                        self.previous_content, self.input_file_path, use_default_indent=True, **print_kwargs)
+                        self.previous_content, self.input_file_path, use_default_indent=True, **(print_kwargs or {}))
         else:
             message = f"Object didn't change: {self.check_object_display_name}"
 

atomicshop/file_io/csvs.py

@@ -84,15 +84,24 @@ def read_csv_to_list_of_lists(
     csv_reader = csv.reader(file_object)
 
     csv_list = list(csv_reader)
-    header = csv_list[0]
 
-    if exclude_header_from_content:
+    # Get the header if there is only something in the content.
+    if csv_list:
+        header = csv_list[0]
+    else:
+        header = []
+
+    if exclude_header_from_content and csv_list:
         csv_list.pop(0)
 
     return csv_list, header
 
 
-def write_list_to_csv(file_path: str, content_list: list, mode: str = 'w') -> None:
+def write_list_to_csv(
+        file_path: str,
+        content_list: list,
+        mode: str = 'w'
+) -> None:
     """
     Function to write list object that each iteration of it contains dict object with same keys and different values.
 
@@ -103,15 +112,23 @@ def write_list_to_csv(file_path: str, content_list: list, mode: str = 'w') -> No
     """
 
     with open(file_path, mode=mode) as csv_file:
-        # Create header from keys of the first dictionary in list.
-        header = content_list[0].keys()
-        # Create CSV writer.
-        writer = csv.DictWriter(csv_file, fieldnames=header, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
-
-        # Write header.
-        writer.writeheader()
-        # Write list of dits as rows.
-        writer.writerows(content_list)
+        if len(content_list) > 0 and isinstance(content_list[0], dict):
+            # Treat the list as list of dictionaries.
+            header = content_list[0].keys()
+
+            # Create CSV writer.
+            writer = csv.DictWriter(csv_file, fieldnames=header, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
+
+            # Write header.
+            writer.writeheader()
+            # Write list of dits as rows.
+            writer.writerows(content_list)
+        # Else, treat the list as list of lists.
+        else:
+            # Create CSV writer.
+            writer = csv.writer(csv_file)
+            # Write list of lists as rows.
+            writer.writerows(content_list)
 
 
 def get_header(file_path: str, print_kwargs: dict = None) -> list:

{atomicshop-2.12.1.dist-info → atomicshop-2.12.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.12.1
+Version: 2.12.3
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.12.1.dist-info → atomicshop-2.12.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=EvosCo6MVhZ-HXgV5FtdTdD7o9rDV_EL4_xqhrsoJaw,123
+atomicshop/__init__.py,sha256=IVAETwFBOuR1wwKN05VRVYWganSHrqXew86vdZG64O8,123
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -9,7 +9,7 @@ atomicshop/config_init.py,sha256=z2RXD_mw9nQlAOpuGry1h9QT-2LhNscXgGAktN3dCVQ,249
 atomicshop/console_output.py,sha256=AOSJjrRryE97PAGtgDL03IBtWSi02aNol8noDnW3k6M,4667
 atomicshop/console_user_response.py,sha256=31HIy9QGXa7f-GVR8MzJauQ79E_ZqAeagF3Ks4GGdDU,3234
 atomicshop/datetimes.py,sha256=ICr0_gQqWnIw4BuNtabrHzjSlwnZkBfhyCrOILs5xpU,14623
-atomicshop/diff_check.py,sha256=RON9cSTgy3jAnwUmAUkOyfF6bgrBKOq9Sbgyl3RYodw,12350
+atomicshop/diff_check.py,sha256=R4G9QISkTQAnJDOKUE6pH6xJ-roMsUwlSd7eVjTkHWA,14517
 atomicshop/dns.py,sha256=bNZOo5jVPzq7OT2qCPukXoK3zb1oOsyaelUwQEyK1SA,2500
 atomicshop/domains.py,sha256=Rxu6JhhMqFZRcoFs69IoEd1PtYca0lMCG6F1AomP7z4,3197
 atomicshop/emails.py,sha256=I0KyODQpIMEsNRi9YWSOL8EUPBiWyon3HRdIuSj3AEU,1410
@@ -104,7 +104,7 @@ atomicshop/etw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/etw/dns_trace.py,sha256=RaREpwJETAMZSd1Lhbg0sO3ugBMw3y1fSKdvP5NfTqM,5189
 atomicshop/etw/etw.py,sha256=xVJNbfCq4KgRfsDnul6CrIdAMl9xRBixZ-hUyqiB2g4,2403
 atomicshop/file_io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/file_io/csvs.py,sha256=FwLTHFdngcgEpf-qviDrHpt7qT_QWtNGAR_RKvYZlpI,4816
+atomicshop/file_io/csvs.py,sha256=oc4ijOHYzayx89DfW2_cktrf81kcGVFKUvKQDAljVrA,5300
 atomicshop/file_io/docxs.py,sha256=6tcYFGp0vRsHR47VwcRqwhdt2DQOwrAUYhrwN996n9U,5117
 atomicshop/file_io/file_io.py,sha256=FR84ihjGlr7Eqejo-_js4nBICVst31axD0bwX19S2eM,6385
 atomicshop/file_io/jsons.py,sha256=q9ZU8slBKnHLrtn3TnbK1qxrRpj5ZvCm6AlsFzoANjo,5303
@@ -249,8 +249,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=AhpurHJmP2kgzHaUbq5ey
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=aXBwlEIJhFT0-c4i8iNlFx2It9VpCEpsv--5Oqcpxao,11624
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=t3dtDEfN47CfYVi0CW6Kc2QHTEeZVyYhc57IYYh5nmA,826
-atomicshop-2.12.1.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.12.1.dist-info/METADATA,sha256=TaPxIyYLWTGyaS4RhB9JdRuElraHbe0umXI6faSh9lE,10447
-atomicshop-2.12.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.12.1.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.12.1.dist-info/RECORD,,
+atomicshop-2.12.3.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.12.3.dist-info/METADATA,sha256=dlGv8-kBilmNG_mToWm8PUJK9XwcjNFCKZc2-jtzdvc,10447
+atomicshop-2.12.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.12.3.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.12.3.dist-info/RECORD,,