search

v7labs / darwin-py

Library and commandline tool for managing datasets on darwin.v7labs.com
MIT License
115 stars 42 forks source link

[PLA-546][external] Removal of V1 code #777

Closed JBWilkie closed 8 months ago

JBWilkie commented 9 months ago

Problem

darwin-py contains lots of code intended to work exclusively with the V1 version of the platform. This includes:

Solution

This code will never be used again, and we are deprecating the Darwin JSON V1 JSON format. Therefore this PR is to remove the above code. Also refactored a lot of V1 tests to be their V2 equivalents if such V2 tests didn't yet exist

Changelog

linear[bot] commented 9 months ago

DAR-415 Remove ability to convert to Darwin JSON 1.0 in darwin-py

PLA-546 BUG: SDK docs - V1 code clean up

JBWilkie commented 9 months ago

This is an enormous PR. To help with it's review, every change falls is either:

There should be no major functional changes in this PR. Additionally, I have almost certainly missed at least some V1 related code

saurbhc commented 8 months ago

i ran e2e_tests, and saw a test failing on darwin convert coco

E2E test output: ```console $ pytest e2e_tests/ Setting up data Using prefix hqcltp Setting up annotation classes Sleeping for 10 seconds to allow the server to catch up ============================================================================================== test session starts ============================================================================================== platform darwin -- Python 3.8.18, pytest-7.4.3, pluggy-1.3.0 cachedir: /tmp/pytest_cache rootdir: /Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests configfile: pytest.ini plugins: rerunfailures-12.0 collected 16 items e2e_tests/test_darwin.py ..... [ 31%] e2e_tests/test_example.py x [ 37%] e2e_tests/cli/convert/test_convert.py ..F. [ 62%] e2e_tests/sdk/future/core/test_properties.py ...... [100%] Tearing down datasets Tearing down workflows Tearing down general datasets Tearing down data complete =================================================================================================== FAILURES ==================================================================================================== _____________________________________________________________________ TestExportCli.test_darwin_convert[coco-input_path2-expectation_path2] _____________________________________________________________________ self = , format = 'coco', input_path = PosixPath('/Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests/data/coco/from') expectation_path = PosixPath('/Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests/data/coco/to') tmp_path = PosixPath('/private/var/folders/bq/vhpf4_td0lzcdhlxyl3cpybr0000gn/T/pytest-of-saurabhchopra/pytest-2/test_darwin_convert_coco_input0') @pytest.mark.parametrize( "format, input_path, expectation_path", [ ("yolo_segmented", data_path / "yolov8/from", data_path / "yolov8/to"), ("yolo", data_path / "yolo/from", data_path / "yolo/to"), pytest.param( "coco", data_path / "coco/from", data_path / "coco/to", marks=pytest.mark.skipif( sys.platform == "win32", reason="File paths are different on Windows, leading to test failure", ), ), ( "semantic_mask", data_path / "semantic_mask/from", data_path / "semantic_mask/to", ), ], ) def test_darwin_convert( self, format: str, input_path: Path, expectation_path: Path, tmp_path: Path ) -> None: """ Test converting a file format to another format """ assert ( input_path is not None and expectation_path is not None ), "Input or expectation path is None" assert ( input_path.exists() and expectation_path.exists() ), f"Input path {input_path.absolute()} or expectation path {expectation_path.absolute()} does not exist" assert ( input_path.is_dir() and expectation_path.is_dir() ), f"Input path {input_path.absolute()} or expectation path {expectation_path.absolute()} is not a directory" result = run_cli_command( f"darwin convert {format} {str(input_path)} {str(tmp_path)}" ) if format == "coco": self.patch_coco(tmp_path / "output.json") assert_cli(result, 0) > self.compare_directories(expectation_path, tmp_path) e2e_tests/cli/convert/test_convert.py:93: _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ self = , path = PosixPath('/Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests/data/coco/to') expected_path = PosixPath('/private/var/folders/bq/vhpf4_td0lzcdhlxyl3cpybr0000gn/T/pytest-of-saurabhchopra/pytest-2/test_darwin_convert_coco_input0') def compare_directories(self, path: Path, expected_path: Path) -> None: """ Compare two directories recursively """ assert path.exists() and expected_path.exists() assert path.is_dir() and expected_path.is_dir() for file in path.iterdir(): if file.is_dir(): # Recursively compare directories self.compare_directories(file, expected_path / file.name) else: if file.name.startswith("."): # Ignore hidden files continue # Compare files with file.open("r") as f: content = f.read() with Path(expected_path / file.name).open() as f: expected_content = f.read() if content != expected_content: print(f"Expected file: {expected_path / file.name}") print(f"Expected Content: \n{expected_content}") print("---------------------") print(f"Actual file: {file}") print(f"Actual Content: \n{content}") > assert False, f"File {file} does not match expected file" E AssertionError: File /Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests/data/coco/to/output.json does not match expected file E assert False e2e_tests/cli/convert/test_convert.py:48: AssertionError --------------------------------------------------------------------------------------------- Captured stdout call ---------------------------------------------------------------------------------------------- Expected file: /private/var/folders/bq/vhpf4_td0lzcdhlxyl3cpybr0000gn/T/pytest-of-saurabhchopra/pytest-2/test_darwin_convert_coco_input0/output.json Expected Content: { "info": { "description": "Exported from Darwin", "url": "n/a", "version": "n/a", "year": 2023, "contributor": "n/a", "date_created": "2023/12/05" }, "licenses": [ { "url": "n/a", "id": 0, "name": "placeholder license" } ], "images": [ { "license": 0, "file_name": "", "coco_url": "n/a", "height": null, "width": null, "date_captured": "", "flickr_url": "n/a", "darwin_url": null, "darwin_workview_url": null, "id": 2043925204, "tag_ids": [] } ], "annotations": [ { "id": 1, "image_id": 2043925204, "category_id": 348813479, "segmentation": [ [ 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 0.0, 1.0 ] ], "area": 1.0, "bbox": [ 0.0, 0.0, 1.0, 1.0 ], "iscrowd": 0, "extra": {} }, { "id": 3, "image_id": 2043925204, "category_id": 3961009249, "segmentation": [ [ 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 0.0, 1.0 ] ], "area": 1.0, "bbox": [ 0.0, 0.0, 1.0, 1.0 ], "iscrowd": 0, "extra": {} } ], "categories": [ { "id": 348813479, "name": "test_bb", "supercategory": "root" }, { "id": 3961009249, "name": "test_poly", "supercategory": "root" } ], "tag_categories": [] } --------------------- Actual file: /Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests/data/coco/to/output.json Actual Content: { "info": { "description": "Exported from Darwin", "url": "n/a", "version": "n/a", "year": 2023, "contributor": "n/a", "date_created": "2023/12/05" }, "licenses": [ { "url": "n/a", "id": 0, "name": "placeholder license" } ], "images": [ { "license": 0, "file_name": "", "coco_url": "n/a", "height": null, "width": null, "date_captured": "", "flickr_url": "n/a", "darwin_url": null, "darwin_workview_url": null, "id": 2043925204, "tag_ids": [] } ], "annotations": [ { "id": 1, "image_id": 2043925204, "category_id": 348813479, "segmentation": [ [ 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 0.0, 1.0 ] ], "area": 1.0, "bbox": [ 0.0, 0.0, 1.0, 1.0 ], "iscrowd": 0, "extra": {} }, { "id": 3, "image_id": 2043925204, "category_id": 3961009249, "segmentation": [ [ 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 0.0, 1.0 ] ], "area": 1.0, "bbox": [ 0.0, 0.0, 1.0, 1.0 ], "iscrowd": 0, "extra": {} } ], "categories": [ { "id": 3961009249, "name": "test_poly", "supercategory": "root" }, { "id": 348813479, "name": "test_bb", "supercategory": "root" } ], "tag_categories": [] } =============================================================================================== warnings summary ================================================================================================ .venv/lib/python3.8/site-packages/mpire/dashboard/dashboard.py:8 /Users/saurabhchopra/github/v7labs/darwin-py/.venv/lib/python3.8/site-packages/mpire/dashboard/dashboard.py:8: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html from pkg_resources import resource_string -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html ============================================================================================ short test summary info ============================================================================================ FAILED e2e_tests/cli/convert/test_convert.py::TestExportCli::test_darwin_convert[coco-input_path2-expectation_path2] - AssertionError: File /Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests/data/coco/to/output.json does not match expected file ======================================================================== 1 failed, 14 passed, 1 xfailed, 1 warning in 202.74s (0:03:22) ========================================================================= ```

looks like a flaky test, as i re-ran the tests and it didn't fail 🤷

E2E test output 2: ```console $ pytest e2e_tests/ Setting up data Using prefix 2w0so0 Setting up annotation classes Sleeping for 10 seconds to allow the server to catch up ============================================================================================== test session starts ============================================================================================== platform darwin -- Python 3.8.18, pytest-7.4.3, pluggy-1.3.0 cachedir: /tmp/pytest_cache rootdir: /Users/saurabhchopra/github/v7labs/darwin-py/e2e_tests configfile: pytest.ini plugins: rerunfailures-12.0 collected 16 items e2e_tests/test_darwin.py ..... [ 31%] e2e_tests/test_example.py x [ 37%] e2e_tests/cli/convert/test_convert.py .... [ 62%] e2e_tests/sdk/future/core/test_properties.py ...... [100%] Tearing down datasets Tearing down workflows Tearing down general datasets Tearing down data complete =============================================================================================== warnings summary ================================================================================================ .venv/lib/python3.8/site-packages/mpire/dashboard/dashboard.py:8 /Users/saurabhchopra/github/v7labs/darwin-py/.venv/lib/python3.8/site-packages/mpire/dashboard/dashboard.py:8: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html from pkg_resources import resource_string -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html ============================================================================= 15 passed, 1 xfailed, 1 warning in 203.54s (0:03:23) ============================================================================== ```