feat: sixth step, the ability to compare files .yaml

Author: ZLOI27

Makefile

@@ -24,10 +24,13 @@ check: test lint
 build:
 	uv build
 
-file-test:
+file-test-json:
 	uv run gendiff /home/zk/python-project-50/tests/test_data/file1.json /home/zk/python-project-50/tests/test_data/file2.json
 
-full-check: test-coverage-without-xml file-test lint 
+file-test-yaml:
+	uv run gendiff /home/zk/python-project-50/tests/test_data/file1.yaml /home/zk/python-project-50/tests/test_data/file2.yaml
+
+full-check: test-coverage-without-xml file-test-json lint 
 
 .PHONY: install test lint selfcheck check build
 

gendiff/__init__.py

@@ -1,9 +1,9 @@
 from gendiff.cli import parse_args
-from gendiff.gendiff import generate_diff, main, read_file_json
+from gendiff.gendiff import generate_diff, main, read_file
 
 __all__ = [
     'parse_args',
     'generate_diff',
-    'read_file_json',
+    'read_file',
     'main',
 ]

gendiff/gendiff.py

@@ -1,5 +1,7 @@
 import json
 
+import yaml
+
 from gendiff.cli import parse_args
 
 
@@ -8,13 +10,18 @@ def main() -> None:
     print(generate_diff(args.first_file, args.second_file))
 
 
-def read_file_json(path: str):
+def read_file(path: str):
+    if path.endswith('.json'):
+        load_data = json.load
+    elif path.endswith(('.yaml', '.yml')):
+        load_data = yaml.safe_load
+    else:
+        raise ValueError(f"ERROR: Unsupported format of file {path}.")
     try:
         with open(path, mode='r', encoding='utf-8') as file:
-            return json.load(file)
-    except Exception as error:
-        print("Can't read_file_json\n", error)
-        return None
+            return load_data(file)
+    except OSError as error:
+        raise OSError(f"ERROR: Can't read file {path}. Reason: {error}")
 
 
 def get_list_of_dict_with_sign(data1, data2) -> list:
@@ -33,15 +40,10 @@ def get_list_of_dict_with_sign(data1, data2) -> list:
 
 
 def sort_list(items: list):
-    def sort_by_rule(item: dict) -> str:
-        """The sign is changed to correctly sort items with the same key."""
-        if item['sign'] == '+':
-            sign = '-'
-        elif item['sign'] == '-':
-            sign = '+'
-        else:
-            sign = ' '
-        return str([item['key'], sign])
+    def sort_by_rule(item: dict) -> tuple:
+        """The sign -> digit for correctly sort items with the same key."""
+        sign_order = {'-': 0, '+': 1, ' ': 2}
+        return (item['key'], sign_order[item['sign']])
     items.sort(key=sort_by_rule)
     return items
 
@@ -50,6 +52,7 @@ def make_str_from_list(items: list) -> str:
     """
     Type checking for the output of strings without quotes,
     and for the correct output of True, False in the form of true, false.
+    Doesn't matter for .yaml.
     """
     list_of_str = ['{']
     for item in items:
@@ -71,7 +74,8 @@ def make_str_from_list(items: list) -> str:
 
 
 def generate_diff(path1, path2) -> str:
-    data1 = read_file_json(path1)
-    data2 = read_file_json(path2)
-    sorted_list_of_dict = sort_list(get_list_of_dict_with_sign(data1, data2))
-    return make_str_from_list(sorted_list_of_dict)
+    dict_data1 = read_file(path1)
+    dict_data2 = read_file(path2)
+    list_of_dict = get_list_of_dict_with_sign(dict_data1, dict_data2)
+    sorted_list = sort_list(list_of_dict)
+    return make_str_from_list(sorted_list)

pyproject.toml

@@ -9,6 +9,7 @@ readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
     "argparse>=1.4.0",
+    "pyyaml>=6.0.2",
 ]
 
 [dependency-groups]

tests/test_data/file1.json

@@ -4,4 +4,3 @@
   "proxy": "123.234.53.22",
   "follow": false
 }
-

tests/test_data/file1.yaml

@@ -0,0 +1,4 @@
+host: hexlet.io
+timeout: 50
+proxy: 123.234.53.22
+follow: false

tests/test_data/file2.json

@@ -3,4 +3,3 @@
   "verbose": true,
   "host": "hexlet.io"
 }
-

tests/test_data/file2.yaml

@@ -0,0 +1,3 @@
+timeout: 20
+verbose: true
+host: hexlet.io

tests/test_gendiff.py

@@ -1,31 +1,37 @@
 import os
 
-from gendiff.gendiff import generate_diff, read_file_json, sort_list
+from gendiff.gendiff import generate_diff, read_file, sort_list
 
 current_dir = os.path.dirname(os.path.abspath(__file__))
 dir_with_data = os.path.join(current_dir, 'test_data')
 
-data1 = {
+right_data1 = {
     "host": "hexlet.io",
     "timeout": 50,
     "proxy": "123.234.53.22",
     "follow": False
 }
 
-data2 = {
+right_data2 = {
     "timeout": 20,
     "verbose": True,
     "host": "hexlet.io"
 }
 
 
-def test_read_file_json():
-    file1_path = os.path.join(dir_with_data, 'file1.json')
-    file2_path = os.path.join(dir_with_data, 'file2.json')
-    assert read_file_json(file1_path) == data1
-    assert read_file_json(file1_path) != data2
-    assert read_file_json(file2_path) == data2
-    assert read_file_json(file2_path) != data1
+def test_read_file():
+    file1_path_json = os.path.join(dir_with_data, 'file1.json')
+    file2_path_json = os.path.join(dir_with_data, 'file2.json')
+    file1_path_yaml = os.path.join(dir_with_data, 'file1.yaml')
+    file2_path_yaml = os.path.join(dir_with_data, 'file2.yaml')
+    assert read_file(file1_path_json) == right_data1
+    assert read_file(file1_path_json) != right_data2
+    assert read_file(file2_path_json) == right_data2
+    assert read_file(file2_path_json) != right_data1
+    assert read_file(file1_path_yaml) == right_data1
+    assert read_file(file1_path_yaml) != right_data2
+    assert read_file(file2_path_yaml) == right_data2
+    assert read_file(file2_path_yaml) != right_data1
 
 
 def test_sort_list():
@@ -56,7 +62,11 @@ def test_generate_diff():
                  "  + verbose: true\n"
                  "}")
     wrong_str = ''
-    file1_path = os.path.join(dir_with_data, 'file1.json')
-    file2_path = os.path.join(dir_with_data, 'file2.json')
-    assert generate_diff(file1_path, file2_path) == right_str
-    assert generate_diff(file1_path, file2_path) != wrong_str
+    file1_path_json = os.path.join(dir_with_data, 'file1.json')
+    file2_path_json = os.path.join(dir_with_data, 'file2.json')
+    file1_path_yaml = os.path.join(dir_with_data, 'file1.yaml')
+    file2_path_yaml = os.path.join(dir_with_data, 'file2.yaml')
+    assert generate_diff(file1_path_json, file2_path_json) == right_str
+    assert generate_diff(file1_path_json, file2_path_json) != wrong_str
+    assert generate_diff(file1_path_yaml, file2_path_yaml) == right_str
+    assert generate_diff(file1_path_yaml, file2_path_yaml) != wrong_str