SDK layer 2 - cover RC1 usecases #4813

zhiltsov-max · 2022-08-22T12:01:33Z

Motivation and context

Common:
- Removed test directories from bandit config
Server / API:
- Fixed API schema for input and output parameters of CRUD, dataset, annotations and backup model endpoints
- Allowed OpenApiTypes elements in PolymorphicProxySerializer
  - If OpenApiTypes.NONE is present, nullable: true is inserted into the schema
- Fixed API schema for WriteOnce fields in serializers
- Removed PUT method on the root model endpoints:
  - /api/tasks/{id}
  - /api/jobs/{id}
  - /api/projects/{id}
  - /api/issues/{id}
  - /api/comments/{id}
  - /api/cloudstorages/{id}
- LabeledData fields marked optional
- Issue update methods now don't support message parameter, which was supposed to be write_once. Added an error message in case this field is supplied.
- Removed invalid pagination options from the children object list endpoints:
  - /api/task/{id}/jobs
  - /api/jobs/{id}/issues
  - /api/issues/{id}/comments
Tests
- rest_api/test_issues now use SDK
- Added /api/auth/ tests in REST API tests
- Fixed failing case of task creation, added test
SDK
- Added layer 2 wrappers for:
  - issues
  - comments
  - jobs
  - users
  - missing task methods
  - projects

How has this been tested?

Checklist

I submit my changes into the develop branch
I have added a description of my changes into CHANGELOG file
I have updated the documentation accordingly
I have added tests to cover my changes
I have linked related issues (read 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.

…e formatting and postprocessing

* Fix show empty tasks * v1.41.1 * Update changelog Co-authored-by: Boris Sekachev <sekachev.bs@gmail.com>

feat: upgrade dotenv-webpack from 7.1.1 to 8.0.0 Snyk has created this PR to upgrade dotenv-webpack from 7.1.1 to 8.0.0. See this package in npm: https://www.npmjs.com/package/dotenv-webpack See this project in Snyk: https://app.snyk.io/org/cvat/project/6c66365f-c154-46f2-b5db-4a4cd35fea4d?utm_source=github&utm_medium=referral&page=upgrade-pr Co-authored-by: snyk-bot <snyk-bot@snyk.io>

nmanovic · 2022-08-26T17:56:12Z

CHANGELOG.md

@@ -51,6 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Image search in cloud storage (<https://github.com/cvat-ai/cvat/pull/8>)
 - Reset password functionality (<https://github.com/cvat-ai/cvat/pull/52>)
 - Creating task with cloud storage data (<https://github.com/cvat-ai/cvat/pull/116>)
+- Show empty tasks (<https://github.com/cvat-ai/cvat/pull/100>)


@zhiltsov-max , I'm not sure why we have the line in the PR.

I'm not sure either. Probably, we need to review changelog links.

nmanovic · 2022-08-26T18:00:30Z

cvat-cli/src/cvat_cli/cli.py

@@ -66,7 +65,7 @@ def tasks_create(

    def tasks_delete(self, task_ids: Sequence[int]) -> None:
        """Delete a list of tasks, ignoring those which don't exist."""
-        self.client.delete_tasks(task_ids=task_ids)
+        self.client.tasks.remove_by_ids(task_ids=task_ids)


@zhiltsov-max , I don't know all use cases, but probably tasks.delete(task_ids) is better. First argument can be array of ids or array of tasks. What do you think?

Its almost just a copy-paste from what CLI had. I can't say I prefer one way over another. Both work well and both are convertible to each other. I can say that your variant is more focused on manual typing, while the other is better for passing a container without the need of unpacking. I'm not sure if delete(id1, id2, id3) is more frequent pattern in the client code than delete(ids).

nmanovic · 2022-08-26T18:02:09Z

cvat-cli/src/cvat_cli/cli.py

@@ -80,11 +79,11 @@ def tasks_frames(
        Download the requested frame numbers for a task and save images as
        task_<ID>_frame_<FRAME>.jpg.
        """
-        self.client.retrieve_task(task_id=task_id).download_frames(
+        self.client.tasks.retrieve(obj_id=task_id).download_frames(


I don't know if it is possible or not, but it will be great if the first argument is ID. Thus we can just write tasks.retrieve(task_id).

I don't think I got the question. It is ID. Did you mean rename id to id?

nmanovic · 2022-08-26T18:04:38Z

cvat-sdk/.gitignore

Why did you put setup.py and README.md into .gitignore?

They are also generated automatically. We decided to remove such files. Moreover, setup.py is meaningless without REST client code.

nmanovic · 2022-08-26T18:17:07Z

tests/python/cli/test_cli.py

        stdout = self.run_cli("import", str(fxt_backup_file))

        task_id = int(stdout.split()[-1])
        assert task_id
        assert task_id != fxt_new_task.id
-        assert self.client.retrieve_task(task_id).size == fxt_new_task.size
+        assert self.client.tasks.retrieve(task_id).size == fxt_new_task.size


OK. I see that simple approach with the first argument exists.

nmanovic

@zhiltsov-max , let's merge as is. We need documentation. Probably it is the next highest priority after we merge your next patch.

zhiltsov-max added 30 commits June 20, 2022 15:25

Fix generated OpenAPI schema

e34731d

Update changelog

4f1940b

Merge branch 'develop' into zm/fix-openapi-schema

cf759f5

Make data-related fields in the Task optional

aad0ccc

Allow null organization in Task, Project, Clouds

50959a4

Add a task to generate schema

f43d47a

Fix attribute values declaration - it is a list of strings

a16d103

Merge branch 'develop' into zm/fix-openapi-schema

38b7d82

add generator config

7248a7f

Update generator config and templates

4bda27e

Add generated code

e953a23

Add tasks tests

6d9f43e

Add sample

e73828e

Fixes to some methods

35b764a

Add org parameters in schema globally

4acffb5

Fix tasks patch tests

8c5f2fc

Enable file uploading in task data

aa8d8f0

Merge branch 'develop' into zm/add-cvat-sdk

d69af23

Merge with develop, fix issues

5210bce

Fix schema generation error

aa0a8ff

Add introspection to models and apis, embed apis into client, add cod…

1e5f915

…e formatting and postprocessing

Add debug task for api code processing

78eb73e

Improve type annotations in api

b580feb

Add design document

a491203

Fix launch,json

ac41fd4

Simplify imports

03ddd56

Fix tests

122635c

Move operation method after api tag

4ca10bc

Rename _preload_content to _parse_response

1519d3a

Regularize operation return types in API

a123d6f

zhiltsov-max and others added 7 commits August 19, 2022 20:05

Make some parameters optional for annotation serializers

a7c03a5

Treat message optional

770fa1d

Fix other model list endpoints in views

6540888

Add missing tests and annotations methods in proxies

20a1e1b

Fix show empty tasks (#100)

af1e15b

* Fix show empty tasks * v1.41.1 * Update changelog Co-authored-by: Boris Sekachev <sekachev.bs@gmail.com>

Disable bandit for tests

7b492ee

zhiltsov-max requested review from azhavoro and nmanovic as code owners August 22, 2022 12:01

zhiltsov-max added 5 commits August 22, 2022 16:01

Fix bandit checks

f81f982

Fix bandit exclude

30b60df

Merge branch 'develop' into zm/sdk-l2-me

58e4fe5

Update server tests for task and jobs PUT method

4f0aac5

Update changelog

b6369f7

zhiltsov-max requested a review from bsekachev as a code owner August 22, 2022 16:03

zhiltsov-max changed the title ~~SDK layer 2 - cover RC1 usecases~~ [WIP] SDK layer 2 - cover RC1 usecases Aug 23, 2022

Fix operation names in schema

24c65cc

zhiltsov-max changed the title ~~[WIP] SDK layer 2 - cover RC1 usecases~~ SDK layer 2 - cover RC1 usecases Aug 23, 2022

This was referenced Aug 23, 2022

[WIP] Add remaining endpoint APIs in SDK #4819

Closed

SDK Timeline #4827

Closed

Merge branch 'develop' into zm/sdk-l2-me

edb3a77

nmanovic reviewed Aug 26, 2022

View reviewed changes

nmanovic approved these changes Aug 26, 2022

View reviewed changes

nmanovic merged commit 53697ec into develop Aug 26, 2022

nmanovic deleted the zm/sdk-l2-me branch August 26, 2022 18:29

nmanovic mentioned this pull request Sep 12, 2022

Release v2.2.0 #4936

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SDK layer 2 - cover RC1 usecases #4813

SDK layer 2 - cover RC1 usecases #4813

zhiltsov-max commented Aug 22, 2022 •

edited

Loading

nmanovic Aug 26, 2022

zhiltsov-max Aug 27, 2022

nmanovic Aug 26, 2022

zhiltsov-max Aug 27, 2022

nmanovic Aug 26, 2022

zhiltsov-max Aug 27, 2022

nmanovic Aug 26, 2022

zhiltsov-max Aug 27, 2022

nmanovic Aug 26, 2022

nmanovic left a comment

SDK layer 2 - cover RC1 usecases #4813

SDK layer 2 - cover RC1 usecases #4813

Conversation

zhiltsov-max commented Aug 22, 2022 • edited Loading

Motivation and context

How has this been tested?

Checklist

License

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmanovic left a comment

Choose a reason for hiding this comment

zhiltsov-max commented Aug 22, 2022 •

edited

Loading