cvat Update high-level SDK used for exporting `project`|`task`|`job` `datasets`|`backups`

trafficstars

Motivation and context

How has this been tested?

Checklist

[ ] I submit my changes into the develop branch
[ ] I have created a changelog fragment
[ ] I have updated the documentation accordingly
[ ] I have added tests to cover my changes
[ ] I have linked related issues (see GitHub docs)
[ ] I have increased versions of npm packages if it is necessary (cvat-canvas, cvat-core, cvat-data and cvat-ui)

License

[ ] I submit my code changes under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

New Features
- Introduced mixins for exporting datasets and downloading backups, enhancing functionality across multiple classes.
- Added a new fixture for testing tasks with specified target storage, improving test coverage.
Bug Fixes
- Improved error handling in the file download process to ensure validity before proceeding.
Refactor
- Restructured the downloading mechanism for better modularity and maintainability.
- Removed outdated methods in favor of mixin functionality, streamlining class design.
Tests
- Enhanced the test suite with additional scenarios and flexibility for task management and dataset downloading.

Aug 02 '24 11:08 Marishka17

[!IMPORTANT]

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent changes to the CVAT SDK enhance modularity and functionality by introducing mixins for dataset export and backup download capabilities. Key methods have been refactored or removed to streamline operations, while new testing fixtures improve coverage for cloud storage scenarios. The overall design now promotes better code organization, allowing for greater flexibility in file handling and error management.

Changes

Files	Change Summaries
`cvat_sdk/core/downloading.py`	Splits `prepare_and_download_file_from_endpoint` into `prepare_file` and a revised method, enhancing flexibility and error handling.
`cvat_sdk/core/proxies/jobs.py`	Introduces `ExportDatasetMixin`, removing the old `export_dataset` method, indicating a shift to a mixin-based design for exports.
`cvat_sdk/core/proxies/model_proxy.py`	Adds `ExportDatasetMixin` and `DownloadBackupMixin`, providing new methods for exporting datasets and downloading backups, improving modularity.
`cvat_sdk/core/proxies/projects.py`	Adds mixins for dataset export and backup, removes old methods, streamlining project data management.
`cvat_sdk/core/proxies/tasks.py`	Integrates new mixins into the `Task` class, removing direct method calls for exports and backups, encouraging a more modular design.
`tests/python/sdk/test_tasks.py`	Introduces a fixture for tasks with cloud storage, modifies tests for dataset downloads, and adds flexibility for frame downloads with an optional parameter.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Downloader
    participant Endpoint

    Client->>Downloader: Request file
    Downloader->>Endpoint: Prepare file request
    Endpoint->>Downloader: Return request object
    Downloader->>Endpoint: Check status and URL
    Endpoint->>Downloader: Confirm URL
    Downloader->>Client: Download file

🐰 In a world of bytes and code,
A rabbit hops, where changes flowed.
Mixin magic, tasks anew,
Exporting dreams in cloud-born dew.
With every leap, the SDK sings,
Flexibility in its newfound wings! 🌈✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Aug 02 '24 11:08 coderabbitai[bot]

👋 @Marishka17 Your PR may already cover it, but since it seems directly relevant to the high level SDK downloading I wanted to flag this issue I just filed this morning: https://github.com/cvat-ai/cvat/issues/8256

Aug 02 '24 16:08 davidrs

/check

Aug 21 '24 10:08 Marishka17

:heavy_check_mark: All checks completed successfully :page_facing_up: See logs here

Aug 21 '24 10:08 github-actions[bot]

:no_entry_sign: Workflows has been canceled :page_facing_up: See logs here

Aug 26 '24 12:08 github-actions[bot]

/check

Aug 26 '24 12:08 Marishka17

:x: Some checks failed :page_facing_up: See logs here

Aug 26 '24 12:08 github-actions[bot]

Codecov Report

Attention: Patch coverage is 80.00000% with 10 lines in your changes missing coverage. Please review.

Project coverage is 83.51%. Comparing base (9fc70ef) to head (5df7838). Report is 377 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8255      +/-   ##
===========================================
+ Coverage    83.46%   83.51%   +0.04%     
===========================================
  Files          395      396       +1     
  Lines        41826    41830       +4     
  Branches      3881     3881              
===========================================
+ Hits         34909    34933      +24     
+ Misses        6917     6897      -20