add: eighth step, add io_utils.py

Author: ZLOI27

gendiff/__init__.py

@@ -1,5 +1,6 @@
 from gendiff.cli import parse_args
-from gendiff.gendiff import generate_diff, main, read_file
+from gendiff.gendiff import generate_diff, main
+from gendiff.io_utils import read_file
 
 __all__ = [
     'parse_args',

gendiff/gendiff.py

@@ -1,31 +1,10 @@
-import json
-
-import yaml
-
 from gendiff.cli import parse_args
+from gendiff.io_utils import read_file
+from gendiff.views.json_format import format_output_json
 from gendiff.views.plain import format_output_plain
 from gendiff.views.stylish import format_output_stylish
 
 
-def read_file(path: str):
-    try:
-        if path.endswith('.json'):
-            load_data = json.load
-        elif path.endswith(('.yaml', '.yml')):
-            load_data = yaml.safe_load
-        else:
-            raise ValueError
-
-        with open(path, mode='r', encoding='utf-8') as file:
-            return load_data(file)
-    except OSError as error:
-        print(f"ERROR: Can't read file {path}. Reason: {error}")
-        return None
-    except ValueError:
-        print(f"ERROR: Unsupported format of file {path}.")
-        return None
-
-
 def get_diff(data1, data2) -> list:
     if data1 == data2:
         return data1
@@ -72,10 +51,15 @@ def generate_diff(path1, path2, format_name='stylish') -> str:
     dict_data1 = read_file(path1)
     dict_data2 = read_file(path2)
     sorted_diff = get_diff(dict_data1, dict_data2)
-    if format_name == 'stylish':
-        return format_output_stylish(sorted_diff)
-    elif format_name == 'plain':
-        return format_output_plain(sorted_diff)
+    match format_name:
+        case 'stylish':
+            return format_output_stylish(sorted_diff)
+        case 'plain':
+            return format_output_plain(sorted_diff)
+        case 'json':
+            return format_output_json(sorted_diff)
+        case _:
+            print("Wrong format: {format_name}")
 
 
 def main() -> None:

gendiff/io_utils.py

@@ -0,0 +1,22 @@
+import json
+
+import yaml
+
+
+def read_file(path: str):
+    try:
+        if path.endswith('.json'):
+            load_data = json.load
+        elif path.endswith(('.yaml', '.yml')):
+            load_data = yaml.safe_load
+        else:
+            raise ValueError
+
+        with open(path, mode='r', encoding='utf-8') as file:
+            return load_data(file)
+    except OSError as error:
+        print(f"ERROR: Can't read file {path}. Reason: {error}")
+        return None
+    except ValueError:
+        print(f"ERROR: Unsupported format of file {path}.")
+        return None

gendiff/views/__init__.py

@@ -1,5 +1,9 @@
+from gendiff.views.json_format import format_output_json
+from gendiff.views.plain import format_output_plain
 from gendiff.views.stylish import format_output_stylish
 
 __all__ = [
-    'format_output_stylish'
+    'format_output_stylish',
+    'format_output_json',
+    'format_output_plain'
 ]

gendiff/views/json_format.py

@@ -0,0 +1,2 @@
+def format_output_json(diff: list):
+    pass

tests/test_data/test_result.txt

@@ -1,44 +1,8 @@
 {
-    common: {
-      + follow: false
-        setting1: Value 1
-      - setting2: 200
-      - setting3: true
-      + setting3: null
-      + setting4: blah blah
-      + setting5: {
-            key5: value5
-        }
-        setting6: {
-            doge: {
-              - wow: 
-              + wow: so much
-            }
-            key: value
-          + ops: vops
-        }
-    }
-    group1: {
-      - baz: bas
-      + baz: bars
-        foo: bar
-      - nest: {
-            key: value
-        }
-      + nest: str
-    }
-  - group2: {
-        abc: 12345
-        deep: {
-            id: 45
-        }
-    }
-  + group3: {
-        deep: {
-            id: {
-                number: 45
-            }
-        }
-        fee: 100500
-    }
+  - follow: false
+    host: hexlet.io
+  - proxy: 123.234.53.22
+  - timeout: 50
+  + timeout: 20
+  + verbose: true
 }

tests/test_data/test_result_json.txt

@@ -0,0 +1,38 @@
+{
+  "common": {
+    "follow": false,
+    "setting1": "Value 1",
+    "setting2": 200,
+    "setting3": null,
+    "setting4": "blah blah",
+    "setting5": {
+      "key5": "value5"
+    },
+    "setting6": {
+      "doge": {
+        "wow": "so much"
+      },
+      "key": "value",
+      "ops": "vops"
+    }
+  },
+  "group1": {
+    "baz": "bars",
+    "foo": "bar",
+    "nest": "str"
+  },
+  "group2": {
+    "abc": 12345,
+    "deep": {
+      "id": 45
+    }
+  },
+  "group3": {
+    "deep": {
+      "id": {
+        "number": 45
+      }
+    },
+    "fee": 100500
+  }
+}

tests/test_data/test_result_json1.txt

@@ -0,0 +1,44 @@
+{
+    "common": {
+        "follow": false,
+        "setting1": "Value 1",
+        "setting2": 200,
+        "setting3": true,
+        "setting3": null,
+        "setting4": "blah blah",
+        "setting5": {
+            "key5": "value5"
+        },
+        "setting6": {
+            "doge": {
+                "wow": "",
+                "wow": "so much"
+            },
+            "key": "value",
+            "ops": "vops"
+        }
+    },
+    "group1": {
+        "baz": "bas",
+        "baz": "bars",
+        "foo": "bar",
+        "nest": {
+            "key": "value"
+        },
+        "nest": "str"
+    },
+    "group2": {
+        "abc": 12345,
+        "deep": {
+            "id": 45
+        }
+    },
+    "group3": {
+        "deep": {
+            "id": {
+                "number": 45
+            }
+        },
+        "fee": 100500
+    }
+}

tests/test_data/test_result_stylish.txt

@@ -0,0 +1,44 @@
+{
+    common: {
+      + follow: false
+        setting1: Value 1
+      - setting2: 200
+      - setting3: true
+      + setting3: null
+      + setting4: blah blah
+      + setting5: {
+            key5: value5
+        }
+        setting6: {
+            doge: {
+              - wow: 
+              + wow: so much
+            }
+            key: value
+          + ops: vops
+        }
+    }
+    group1: {
+      - baz: bas
+      + baz: bars
+        foo: bar
+      - nest: {
+            key: value
+        }
+      + nest: str
+    }
+  - group2: {
+        abc: 12345
+        deep: {
+            id: 45
+        }
+    }
+  + group3: {
+        deep: {
+            id: {
+                number: 45
+            }
+        }
+        fee: 100500
+    }
+}

tests/test_gendiff.py

@@ -1,6 +1,7 @@
 import os
 
-from gendiff.gendiff import generate_diff, read_file
+from gendiff.gendiff import generate_diff
+from gendiff.io_utils import read_file
 
 current_dir = os.path.dirname(os.path.abspath(__file__))
 dir_with_data = os.path.join(current_dir, 'test_data')
@@ -20,66 +21,52 @@
 
 
 def test_read_file():
-    file1_json = os.path.join(dir_with_data, 'file1.json')
-    file2_json = os.path.join(dir_with_data, 'file2.json')
-    file1_yaml = os.path.join(dir_with_data, 'file1.yaml')
-    file2_yaml = os.path.join(dir_with_data, 'file2.yaml')
-    assert read_file(file1_json) == right_data1
-    assert read_file(file1_json) != right_data2
-    assert read_file(file2_json) == right_data2
-    assert read_file(file2_json) != right_data1
-    assert read_file(file1_yaml) == right_data1
-    assert read_file(file1_yaml) != right_data2
-    assert read_file(file2_yaml) == right_data2
-    assert read_file(file2_yaml) != right_data1
+    file1_json_path = os.path.join(dir_with_data, 'file1.json')
+    file2_json_path = os.path.join(dir_with_data, 'file2.json')
+    file1_yaml_path = os.path.join(dir_with_data, 'file1.yaml')
+    file2_yaml_path = os.path.join(dir_with_data, 'file2.yaml')
 
+    assert read_file(file1_json_path) == right_data1
+    assert read_file(file1_json_path) != right_data2
+    assert read_file(file2_json_path) == right_data2
+    assert read_file(file2_json_path) != right_data1
+    assert read_file(file1_yaml_path) == right_data1
+    assert read_file(file1_yaml_path) != right_data2
+    assert read_file(file2_yaml_path) == right_data2
+    assert read_file(file2_yaml_path) != right_data1
 
-def test_generate_diff():
-    right_str = ("{\n"
-                "  - follow: false\n"
-                "    host: hexlet.io\n"
-                "  - proxy: 123.234.53.22\n"
-                "  - timeout: 50\n"
-                "  + timeout: 20\n"
-                "  + verbose: true\n"
-                "}")
-    test_file_path = os.path.join(dir_with_data, 'test_result.txt')
-    try:
-        with open(test_file_path, 'r', encoding='utf-8') as file:
-            right_data = file.read()
-    except OSError:
-        print('Can not open test_file.')
 
-    test_file_path = os.path.join(dir_with_data, 'test_result_plain.txt')
+def open_file(file_name: str) -> dict:
+    test_file_path = os.path.join(dir_with_data, file_name)
     try:
         with open(test_file_path, 'r', encoding='utf-8') as file:
-            right_data_plain = file.read()
+            return file.read()
     except OSError:
         print('Can not open test_file.')
 
-    wrong_str = ''
-    file1_json = os.path.join(dir_with_data, 'file1.json')
-    file2_json = os.path.join(dir_with_data, 'file2.json')
-    file1_yaml = os.path.join(dir_with_data, 'file1.yaml')
-    file2_yaml = os.path.join(dir_with_data, 'file2.yaml')
 
+def test_generate_diff():
+    right_data_stylish = open_file('test_result_stylish.txt')
+    right_data_plain = open_file('test_result_plain.txt')
+    # right_data_json = open_file('test_result_json.txt')
+    wrong_str = ''
+    
     file3_json = os.path.join(dir_with_data, 'file3.json')
     file4_json = os.path.join(dir_with_data, 'file4.json')
     file3_yaml = os.path.join(dir_with_data, 'file3.yaml')
     file4_yaml = os.path.join(dir_with_data, 'file4.yaml')
 
-    assert generate_diff(file1_json, file2_json) == right_str
-    assert generate_diff(file1_json, file2_json) != wrong_str
-    assert generate_diff(file1_yaml, file2_yaml) == right_str
-    assert generate_diff(file1_yaml, file2_yaml) != wrong_str
-
-    assert generate_diff(file3_json, file4_json) == right_data
+    assert generate_diff(file3_json, file4_json) == right_data_stylish
     assert generate_diff(file3_json, file4_json) != wrong_str
-    assert generate_diff(file3_yaml, file4_yaml) == right_data
+    assert generate_diff(file3_yaml, file4_yaml) == right_data_stylish
     assert generate_diff(file3_yaml, file4_yaml) != wrong_str
 
     assert generate_diff(file3_json, file4_json, 'plain') == right_data_plain
     assert generate_diff(file3_json, file4_json, 'plain') != wrong_str
     assert generate_diff(file3_yaml, file4_yaml, 'plain') == right_data_plain
     assert generate_diff(file3_yaml, file4_yaml, 'plain') != wrong_str
 
+    # assert generate_diff(file3_json, file4_json, 'json') == right_data_json
+    # assert generate_diff(file3_json, file4_json, 'json') != wrong_str
+    # assert generate_diff(file3_yaml, file4_yaml, 'json') == right_data_json
+    # assert generate_diff(file3_yaml, file4_yaml, 'json') != wrong_str