File: common_typing.py

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (50 lines) | stat: -rw-r--r-- 1,603 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Copyright 2022 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Helper module to store class-independent, common type hinting."""

from collections.abc import Callable, Generator
import dataclasses
from typing import Any

from telemetry.internal.browser import tab
from telemetry.internal.browser import browser

TestArgs = list
GeneratedTest = tuple[str, str, TestArgs]
TestGenerator = Generator[GeneratedTest, None, None]

TagConflictChecker = Callable[[str, str], bool] | None

# Will hopefully eventually be replaced by argparses' equivalents once Telemetry
# finally switches off optparse.
# TODO(crbug.com/40807291): Change these to argparse.ArgumentParser and
# argparse.Namespace respectively once the optparse -> argparse migration is
# complete.
CmdArgParser = Any
ParsedCmdArgs = Any

# Telemetry screenshot type. Can be changed to union of specific types if/when
# Telemetry exposes those types.
Screenshot = Any
Tab = tab.Tab
Browser = browser.Browser


# Struct-like classes defined using dataclasses can't use [] or other mutable
# for default values. The use of callables is required since reusing the same
# object is also problematic.
# invalid-field-call disabled since this is just more readable shorthand of a
# valid field call.
# pylint: disable=invalid-field-call
def EmptyDict():
  return dataclasses.field(default_factory=dict)


def EmptyList():
  return dataclasses.field(default_factory=list)


def EmptySet():
  return dataclasses.field(default_factory=set)
# pylint: enable=invalid-field-call