Paths

Table of Contentst

Differential D2636

Add type annotations to swh.core.api
AbandonedPublic
Actions

Authored by legau on Feb 7 2020, 11:09 AM.

Tags

None

Subscribers

Details

Reviewers

Group Reviewers

Maniphest Tasks

T2256: Add type annotations to swh.core.api

Required Signatures

L3 Software Heritage Contributor License Agreement, version 1.0

Summary

Annotation of methods for files swh/core/negotation.py and swh/core/serializers.py

Diff Detail

Repository

rDCORE Foundations and core functionalities

Branch

type-annotation

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 10524
Build 15692: tox-on-jenkins	Jenkins
Build 15691: arc lint + arc unit

Event Timeline

legau created this revision.Feb 7 2020, 11:09 AM

Herald added a reviewer: Reviewers. · View Herald TranscriptFeb 7 2020, 11:09 AM

Herald added a required legal document: L3 Software Heritage Contributor License Agreement, version 1.0. · View Herald Transcript

legau added a task: T2256: Add type annotations to swh.core.api.Feb 7 2020, 11:10 AM

Build is green
See https://jenkins.softwareheritage.org/job/DCORE/job/tox/400/ for more details.

Harbormaster completed remote builds in B10488: Diff 9428.Feb 7 2020, 11:10 AM

vlorentz requested changes to this revision.Feb 7 2020, 11:17 AM

vlorentz added a subscriber: vlorentz.

vlorentz added inline comments.

swh/core/api/negotiation.py
58	`bytes`
66	`bytes`
140	missing type of `err`
swh/core/api/serializers.py
155	`bytes`
180	For consistency, either use `Any` for this return type, or use `Union[int, dict, str, bytes]` in all other places when dealing with deserialized data

This revision now requires changes to proceed.Feb 7 2020, 11:17 AM

Fixed consistency problems

Build is green
See https://jenkins.softwareheritage.org/job/DCORE/job/tox/401/ for more details.

Harbormaster completed remote builds in B10489: Diff 9430.Feb 7 2020, 11:30 AM

vlorentz requested changes to this revision.Feb 7 2020, 3:20 PM

vlorentz added inline comments.

swh/core/api/negotiation.py
140	`err` is optional

This revision now requires changes to proceed.Feb 7 2020, 3:20 PM

legau added inline comments.Feb 7 2020, 3:27 PM

swh/core/api/negotiation.py
140	If this err should be annoted Optional, should all other parameters with default values be Optional as well ?

legau marked an inline comment as not done.Feb 7 2020, 3:29 PM

vlorentz added inline comments.Feb 7 2020, 4:46 PM

swh/core/api/negotiation.py
140	No, `Optional` means they can be None ( https://docs.python.org/3/library/typing.html#typing.Optional )

legau added inline comments.Feb 7 2020, 5:15 PM

swh/core/api/negotiation.py
140	Yes I meant for the other parameters where None is the default parameters. For example def get_formatter(self, format: str = None, mimetype: str = None) -> Formatter: line 102.

vlorentz added inline comments.Feb 10 2020, 12:10 PM

swh/core/api/negotiation.py
140	then yes

Optional params are now Optional

Build is green
See https://jenkins.softwareheritage.org/job/DCORE/job/tox/402/ for more details.

Harbormaster completed remote builds in B10524: Diff 9462.Feb 10 2020, 4:07 PM

legau marked 3 inline comments as done.Feb 10 2020, 4:09 PM

One last comment, and it should be good.

Could you also squash your commits?

swh/core/api/serializers.py
180	Sorry I missed this earlier, but `data` should have type `bytes`.

This revision now requires changes to proceed.Feb 10 2020, 4:49 PM

legau marked an inline comment as done.Feb 10 2020, 5:07 PM

legau added a child revision: D2644: Add type annotations to swh.core.api.Feb 10 2020, 5:28 PM

legau abandoned this revision.Feb 11 2020, 2:14 PM

Revision Contents
Changeset List

Path

Size

swh/

core/

api/

44 lines

19 lines

Diff 9462

swh/core/api/negotiation.py

Loading...

swh/core/api/serializers.py

Loading...