DataComparerLibrary 0.838__tar.gz → 0.840__tar.gz

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: DataComparerLibrary
-Version: 0.838
+Version: 0.840
 Summary: For comparing csv-files or 2d-array with csv-file.
 Home-page: 
 Author: René Philip Zuijderduijn
@@ -60,7 +60,7 @@ Introduction
 The DataComparerLibrary can be used for:
     - comparing csv-files or text-files
     - comparing a 2d-matrix with a csv-file or text-file
-    - comparing a csv_file or text-file with a 2d-matrix
+    - comparing a csv-file or text-file with a 2d-matrix
     - comparing 2d-matrices
 
 | In case a difference between actual and expected data is found an exception wil be given. In Robot Framework
@@ -186,6 +186,72 @@ Based on current datetime = 2023-09-06 19:04:00  (example):
 
 
 
+DataSorter
+==========
+
+Introduction
+------------
+The DataSorter can be used for sorting records in a csv file or text file.
+
+
+Default sorting
+---------------
+The default sorting is alphabetically based in ascending order on column 0 on all records.
+
+
+Special sorting
+---------------
+
+| With the DataSorter it is possible to tune the sorting of records.
+|
+| number_of_header_lines:
+| Optional argument "number_of_header_lines" can be used to set the number of header records. These records will be excluded from sorting.
+  In case this optional argument is not present the default value is set to 0.
+|
+| number_of_trailer_lines:
+| Optional argument "number_of_trailer_lines" can be used to set the number of trailer records. These records will be excluded from sorting.
+  In case this optional argument is not present the default value is set to 0.
+|
+| sort_on_columns_list:
+| Optional argument "sort_on_columns_list" can be used to specify one or more columns on which should be sorted and in which order of columns.
+  Sorting of a column can be done in an alphabetic or numeric way.
+|
+| delimiter:
+| Optional argument "delimiter" can be used to set the delimiter.
+  Default delimiter is "," in case of an input file. You can use the option "delimiter" to set another delimiter
+  like ";" or "\t" for tab. It is also possible to use a multi-character delimiter like "@#@".
+
+
+Examples of using the DataComparerLibrary keywords for sorting data in Robot Framework
+----------------------------------------------------------------------------------------
+
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+
+
+    *** Settings ***
+    Library     DataComparerLibrary
+
+    *** Test Cases ***
+    Testcase_DataSorter
+        Examples
+
+    *** Keywords ***
+    Examples
+        # sorting examples
+        #
+        # Sorting alphabetic on column 0, 5 and 4
+        ${sorting_column_0_5_4} =  create list   0  5  4
+        # Sorting alphabetic on column 4 and 1 and numeric on colum 3
+        ${sorting_column_4_3i_1} =  create list   4  ${3}  1
+
+
+        Run Keyword And Continue On Failure  DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_header_lines=5  sort_on_columns_list=${sorting_column_0_5_4}  number_of_trailer_lines=5  delimiter=;
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_header_lines=4  sort_on_columns_list=${sorting_column_4_3i_1}  delimiter=@#@
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_trailer_lines=2  delimiter=\t
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv
+
+
 FileConverter
 =============
 

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/README.rst

@@ -40,7 +40,7 @@ Introduction
 The DataComparerLibrary can be used for:
     - comparing csv-files or text-files
     - comparing a 2d-matrix with a csv-file or text-file
-    - comparing a csv_file or text-file with a 2d-matrix
+    - comparing a csv-file or text-file with a 2d-matrix
     - comparing 2d-matrices
 
 | In case a difference between actual and expected data is found an exception wil be given. In Robot Framework
@@ -166,6 +166,72 @@ Based on current datetime = 2023-09-06 19:04:00  (example):
 
 
 
+DataSorter
+==========
+
+Introduction
+------------
+The DataSorter can be used for sorting records in a csv file or text file.
+
+
+Default sorting
+---------------
+The default sorting is alphabetically based in ascending order on column 0 on all records.
+
+
+Special sorting
+---------------
+
+| With the DataSorter it is possible to tune the sorting of records.
+|
+| number_of_header_lines:
+| Optional argument "number_of_header_lines" can be used to set the number of header records. These records will be excluded from sorting.
+  In case this optional argument is not present the default value is set to 0.
+|
+| number_of_trailer_lines:
+| Optional argument "number_of_trailer_lines" can be used to set the number of trailer records. These records will be excluded from sorting.
+  In case this optional argument is not present the default value is set to 0.
+|
+| sort_on_columns_list:
+| Optional argument "sort_on_columns_list" can be used to specify one or more columns on which should be sorted and in which order of columns.
+  Sorting of a column can be done in an alphabetic or numeric way.
+|
+| delimiter:
+| Optional argument "delimiter" can be used to set the delimiter.
+  Default delimiter is "," in case of an input file. You can use the option "delimiter" to set another delimiter
+  like ";" or "\t" for tab. It is also possible to use a multi-character delimiter like "@#@".
+
+
+Examples of using the DataComparerLibrary keywords for sorting data in Robot Framework
+----------------------------------------------------------------------------------------
+
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+
+
+    *** Settings ***
+    Library     DataComparerLibrary
+
+    *** Test Cases ***
+    Testcase_DataSorter
+        Examples
+
+    *** Keywords ***
+    Examples
+        # sorting examples
+        #
+        # Sorting alphabetic on column 0, 5 and 4
+        ${sorting_column_0_5_4} =  create list   0  5  4
+        # Sorting alphabetic on column 4 and 1 and numeric on colum 3
+        ${sorting_column_4_3i_1} =  create list   4  ${3}  1
+
+
+        Run Keyword And Continue On Failure  DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_header_lines=5  sort_on_columns_list=${sorting_column_0_5_4}  number_of_trailer_lines=5  delimiter=;
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_header_lines=4  sort_on_columns_list=${sorting_column_4_3i_1}  delimiter=@#@
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_trailer_lines=2  delimiter=\t
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv
+
+
 FileConverter
 =============
 

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/src/DataComparerLibrary/datacomparer.py

@@ -8,6 +8,8 @@ import re
 
 import dateutil.relativedelta
 
+from DataComparerLibrary.tools import Tools
+
 
 class DataComparer:
     # Situations:
@@ -181,8 +183,8 @@ class DataComparer:
                                 else:
                                     # Part(s) of the actual data field will be skipped for verification.
                                     # Replace {SKIP}, ignoring cases, by wildcard *.
-                                    #compiled = re.compile(re.escape("{SKIP}"), re.IGNORECASE)
-                                    #expected_data_with_wildcard = compiled.sub("*", expected_data_including_templates[row_nr][column_nr])
+                                    # compiled = re.compile(re.escape("{SKIP}"), re.IGNORECASE)
+                                    # expected_data_with_wildcard = compiled.sub("*", expected_data_including_templates[row_nr][column_nr])
                                     compiled = re.compile(re.escape("{SKIP}"), re.IGNORECASE)
                                     compiled2 = re.compile(re.escape("{DATETIME_FORMAT():YYYYMMDDHHMMSSFF6}"), re.IGNORECASE)
                                     expected_data_with_wildcard = compiled2.sub("*", compiled.sub("*", expected_data_including_templates[row_nr][column_nr]))
@@ -190,12 +192,6 @@ class DataComparer:
                                     if fnmatch.fnmatch(actual_data[row_nr][column_nr], expected_data_with_wildcard):
                                         skip_exception_rule_used = True
                                         continue
-                                    # This can probably be removed. It is verified further in the code
-#                                    else:
-#                                        # No match despite using of wildcard(s).
-#                                        if "{NOW()" not in expected_data_including_templates[row_nr][column_nr].upper():
-#                                            difference_found = True
-#                                            DataComparer.__print_comparation_result(self, row_nr, column_nr, actual_data[row_nr][column_nr], expected_data_including_templates[row_nr][column_nr], "Actual data field has not been SKIPped.")
                             #
                             if expected_data_with_wildcard is None:
                                 # Wildcards not used.
@@ -223,16 +219,17 @@ class DataComparer:
                                         DataComparer.__print_comparation_result(self, row_nr, column_nr, actual_data[row_nr][column_nr], expected_data, "There is a difference between actual and expected data.")
                                 continue
                                 #
-                            if "{NOT(" in expected_data_including_templates[row_nr][column_nr].upper():
+                            elif "{NOT(" in expected_data_including_templates[row_nr][column_nr].upper():
                                 try:
                                     unwanted_expected_data = DataComparer.__get_unwanted_expected_data(self, expected_data_including_date_template)
                                     #
-                                    if fnmatch.fnmatch(actual_data[row_nr][column_nr], unwanted_expected_data):
+                                    if actual_data[row_nr][column_nr] == unwanted_expected_data:
                                         # Unwanted match.
                                         difference_found = True
                                         DataComparer.__print_comparation_result(self, row_nr, column_nr, actual_data[row_nr][column_nr], expected_data_including_templates[row_nr][column_nr], "NOT() template format displayed. See also next message line.")
                                         DataComparer.__print_comparation_result(self, row_nr, column_nr, actual_data[row_nr][column_nr], unwanted_expected_data, "Actual and expected data are equal. However actual data should NOT be equal to the expected data!!!")
-                                except:
+                                except Exception as exception_message:
+                                    # print(f"An exception occurred: {exception_message}")
                                     difference_found = True
                                     DataComparer.__print_comparation_result(self, row_nr, column_nr, actual_data[row_nr][column_nr], expected_data_including_templates[row_nr][column_nr], "NOT() has been found in expected data field, but format is incorrect.")
                                 #
@@ -383,6 +380,17 @@ class DataComparer:
             raise Exception()
         #
         unwanted_expected_data = expected_data_field_including_date_template[position_open_brace+5:position_close_brace]
+        #
+        if DataComparer.is_integer(self, unwanted_expected_data):
+            unwanted_expected_data = int(unwanted_expected_data)
         return unwanted_expected_data
 
 
+
+    def is_integer(self, string):
+        if string[0] == '-':
+            # if a negative number
+            return string[1:].isdigit()
+        else:
+            return string.isdigit()
+

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/src/DataComparerLibrary/fileconverter.py

@@ -44,7 +44,7 @@ class FileConverter:
 
 
     def remove_cr_and_lf(self, input):
-        # Remove carriage return and linefeed (LF) from input string.
+        # Remove carriage return (CR) and linefeed (LF) from input string.
         print("input: ", input)
         output = str(input).replace("\r", "").replace("\n", "")
         print("output: ", output)
@@ -53,7 +53,7 @@ class FileConverter:
 
 
     def replace_cr_and_lf(self, input, replacement_string):
-        # Replace carriage return and linefeed (LF) from input string.
+        # Replace carriage return (CR) and linefeed (LF) from input string.
         print("input: ", input)
         output = str(input).replace("\r", replacement_string).replace("\n", replacement_string)
         print("output: ", output)

datacomparerlibrary-0.840/src/DataComparerLibrary/tools.py

@@ -0,0 +1,7 @@
+class Tools:
+    def is_integer(self, string):
+        if string[0] == '-':
+            # if a negative number
+            return string[1:].isdigit()
+        else:
+            return string.isdigit()

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/src/DataComparerLibrary/version.py

@@ -1,3 +1,3 @@
 # encoding=utf-8
 
-VERSION = '0.838'
+VERSION = '0.840'

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/src/DataComparerLibrary.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: DataComparerLibrary
-Version: 0.838
+Version: 0.840
 Summary: For comparing csv-files or 2d-array with csv-file.
 Home-page: 
 Author: René Philip Zuijderduijn
@@ -60,7 +60,7 @@ Introduction
 The DataComparerLibrary can be used for:
     - comparing csv-files or text-files
     - comparing a 2d-matrix with a csv-file or text-file
-    - comparing a csv_file or text-file with a 2d-matrix
+    - comparing a csv-file or text-file with a 2d-matrix
     - comparing 2d-matrices
 
 | In case a difference between actual and expected data is found an exception wil be given. In Robot Framework
@@ -186,6 +186,72 @@ Based on current datetime = 2023-09-06 19:04:00  (example):
 
 
 
+DataSorter
+==========
+
+Introduction
+------------
+The DataSorter can be used for sorting records in a csv file or text file.
+
+
+Default sorting
+---------------
+The default sorting is alphabetically based in ascending order on column 0 on all records.
+
+
+Special sorting
+---------------
+
+| With the DataSorter it is possible to tune the sorting of records.
+|
+| number_of_header_lines:
+| Optional argument "number_of_header_lines" can be used to set the number of header records. These records will be excluded from sorting.
+  In case this optional argument is not present the default value is set to 0.
+|
+| number_of_trailer_lines:
+| Optional argument "number_of_trailer_lines" can be used to set the number of trailer records. These records will be excluded from sorting.
+  In case this optional argument is not present the default value is set to 0.
+|
+| sort_on_columns_list:
+| Optional argument "sort_on_columns_list" can be used to specify one or more columns on which should be sorted and in which order of columns.
+  Sorting of a column can be done in an alphabetic or numeric way.
+|
+| delimiter:
+| Optional argument "delimiter" can be used to set the delimiter.
+  Default delimiter is "," in case of an input file. You can use the option "delimiter" to set another delimiter
+  like ";" or "\t" for tab. It is also possible to use a multi-character delimiter like "@#@".
+
+
+Examples of using the DataComparerLibrary keywords for sorting data in Robot Framework
+----------------------------------------------------------------------------------------
+
+Below there are some examples how to call the keywords of the DataComparerLibrary in Robot Framework::
+
+
+    *** Settings ***
+    Library     DataComparerLibrary
+
+    *** Test Cases ***
+    Testcase_DataSorter
+        Examples
+
+    *** Keywords ***
+    Examples
+        # sorting examples
+        #
+        # Sorting alphabetic on column 0, 5 and 4
+        ${sorting_column_0_5_4} =  create list   0  5  4
+        # Sorting alphabetic on column 4 and 1 and numeric on colum 3
+        ${sorting_column_4_3i_1} =  create list   4  ${3}  1
+
+
+        Run Keyword And Continue On Failure  DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_header_lines=5  sort_on_columns_list=${sorting_column_0_5_4}  number_of_trailer_lines=5  delimiter=;
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_header_lines=4  sort_on_columns_list=${sorting_column_4_3i_1}  delimiter=@#@
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv  number_of_trailer_lines=2  delimiter=\t
+        DataComparerLibrary.Sort Csv Files  C:\\Users\\unsorted.csv   C:\\Users\\sorted.csv
+
+
 FileConverter
 =============
 

{DataComparerLibrary-0.838 → datacomparerlibrary-0.840}/src/DataComparerLibrary.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ src/DataComparerLibrary/datacomparer.py
 src/DataComparerLibrary/datasorter.py
 src/DataComparerLibrary/delimitertranslator.py
 src/DataComparerLibrary/fileconverter.py
+src/DataComparerLibrary/tools.py
 src/DataComparerLibrary/version.py
 src/DataComparerLibrary.egg-info/PKG-INFO
 src/DataComparerLibrary.egg-info/SOURCES.txt