Differential D3632 Diff 12785 swh/core/api/classes.py

Changeset View

Standalone View

swh/core/api/classes.py

This file was added.

				# Copyright (C) 2020 The Software Heritage developers
				# See the AUTHORS file at the top-level directory of this distribution
				# License: GNU General Public License version 3, or any later version
				# See top-level LICENSE file for more information

				import attr

				from typing import (
				Generic,
				List,
				Optional,
				TypeVar,
				)

				from attrs_strict import type_validator


				ResultType = TypeVar("ResultType")
				ardumontAuthorUnsubmitted Done Inline Actions ok, ResultType it is then. ardumont: ok, ResultType it is then.
				ardumontAuthorUnsubmitted Done Inline Actions Compromising, `TResult` for shorter as expressed by val below. ardumont: Compromising, `TResult` for shorter as expressed by val below.


				@attr.s
				class PagedResult(Generic[ResultType]):
				"""Represents a page of results; with a token to get the next page"""

				vlorentzUnsubmitted Done Inline Actions I'd prefer to use a default_factory (`dataclasses.field(default_factory=list)` when you'll switch to dataclasses). As lists are mutable, it's a footgun to have a mutable object as default. vlorentz: I'd prefer to use a default_factory (`dataclasses.field(default_factory=list)` when you'll…
				ardumontAuthorUnsubmitted Done Inline Actions Do we want to have a List here or an Iterable or a Sequence? ardumont: Do we want to have a List here or an Iterable or a Sequence?
				vlorentzUnsubmitted Done Inline Actions all three are fine, but I don't see any reason not to use List. vlorentz: all three are fine, but I don't see any reason not to use List.
				ardumontAuthorUnsubmitted Done Inline Actions In my tryouts, in storage, at some point, I tried a specific type involving `PagedResult[BaseModel, str]`. Which I eliminated because too broad. Still, mypy tried to lure me into the variance/co-variance/invariance things. On top of which it said, if you want this to work, you might want to use a Sequence instead of a List. So I thought of asking ;) Keeping List then ;) ardumont: In my tryouts, in storage, at some point, I tried a specific type involving `PagedResult…
				results = attr.ib(type=List[ResultType], default=[])
				ardumontAuthorUnsubmitted Done Inline Actions Otherwise: swh/core/api/classes.py:25: error: 'TokenType' is a type variable and only valid in type context ardumont: Otherwise: ``` swh/core/api/classes.py:25: error: 'TokenType' is a type variable and only…
				vlorentzUnsubmitted Done Inline Actions wtf... vlorentz: wtf...
				next_page_token = attr.ib(
				type=Optional[str], default=None, validator=type_validator()
				)