Skip to content

synt.ty ¤

type_param ¤

tvar module-attribute ¤

1
tvar = TypeVar

Alias TypeVar.

ttup module-attribute ¤

1
ttup = TypeVarTuple

Alias TypeVarTuple.

tspec module-attribute ¤

1
tspec = TypeParamSpec

Alias TypeParamSpec.

TypeVar ¤

Bases: IntoCode

TypeVar in type parameters.

Examples:

1
2
ty_var = tvar(id_("T"), id_("int"))
assert ty_var.into_code() == "T: int"
References

Type parameters.

Source code in synt/ty/type_param.py 
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
51
52
53
54
55
56
57
58
class TypeVar(IntoCode):
    r"""`TypeVar` in type parameters.

    Examples:
        ```python
        ty_var = tvar(id_("T"), id_("int"))
        assert ty_var.into_code() == "T: int"
        ```

    References:
        [Type parameters](https://docs.python.org/3/library/ast.html#ast-type-params).
    """

    name: Identifier
    """The name of the type variable."""
    bound: Expression | None
    """The bound of the type variable."""

    def __init__(self, name: Identifier, bound: IntoExpression | None = None):
        """Initialize a type variable.

        Args:
            name: The name of the type variable.
            bound: The bound of the type variable.
        """
        self.name = name
        if bound is not None:
            self.bound = bound.into_expression()
        else:
            self.bound = None

    def into_code(self) -> str:
        bound = f": {self.bound.into_code()}" if self.bound is not None else ""
        return f"{self.name.into_code()}{bound}"

bound instance-attribute ¤

1
bound: Expression | None

The bound of the type variable.

name instance-attribute ¤

1
name: Identifier = name

The name of the type variable.

__init__ ¤

1
2
3
__init__(
    name: Identifier, bound: IntoExpression | None = None
)

Initialize a type variable.

Parameters:

Name Type Description Default
name Identifier

The name of the type variable.

 required
bound IntoExpression | None

The bound of the type variable.

 None
Source code in synt/ty/type_param.py 
43
44
45
46
47
48
49
50
51
52
53
54
def __init__(self, name: Identifier, bound: IntoExpression | None = None):
    """Initialize a type variable.

    Args:
        name: The name of the type variable.
        bound: The bound of the type variable.
    """
    self.name = name
    if bound is not None:
        self.bound = bound.into_expression()
    else:
        self.bound = None

into_code ¤

1
into_code() -> str
Source code in synt/ty/type_param.py 
56
57
58
def into_code(self) -> str:
    bound = f": {self.bound.into_code()}" if self.bound is not None else ""
    return f"{self.name.into_code()}{bound}"

TypeVarTuple ¤

Bases: IntoCode

Type variable tuple.

Examples:

1
2
ty_var = ttup(id_("T"))
assert ty_var.into_code() == "*T"
References

Type variable tuple.

Source code in synt/ty/type_param.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class TypeVarTuple(IntoCode):
    r"""Type variable tuple.

    Examples:
        ```python
        ty_var = ttup(id_("T"))
        assert ty_var.into_code() == "*T"
        ```

    References:
        [Type variable tuple](https://docs.python.org/3/library/ast.html#ast.TypeVarTuple).
    """

    name: Identifier
    """The name of the type variable tuple."""

    def __init__(self, name: Identifier):
        """Initialize a type variable tuple.

        Args:
            name: The name of the type variable tuple.
        """
        self.name = name

    def into_code(self) -> str:
        return f"*{self.name.into_code()}"

name instance-attribute ¤

1
name: Identifier = name

The name of the type variable tuple.

__init__ ¤

1
__init__(name: Identifier)

Initialize a type variable tuple.

Parameters:

Name Type Description Default
name Identifier

The name of the type variable tuple.

 required
Source code in synt/ty/type_param.py 
81
82
83
84
85
86
87
def __init__(self, name: Identifier):
    """Initialize a type variable tuple.

    Args:
        name: The name of the type variable tuple.
    """
    self.name = name

into_code ¤

1
into_code() -> str
Source code in synt/ty/type_param.py 
89
90
def into_code(self) -> str:
    return f"*{self.name.into_code()}"

TypeParamSpec ¤

Bases: IntoCode

Type parameter spec.

Examples:

1
2
ty_var = tspec(id_("P"))
assert ty_var.into_code() == "**P"
References

Type param spec.

Source code in synt/ty/type_param.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class TypeParamSpec(IntoCode):
    r"""Type parameter spec.

    Examples:
        ```python
        ty_var = tspec(id_("P"))
        assert ty_var.into_code() == "**P"
        ```

    References:
        [Type param spec](https://docs.python.org/3/library/ast.html#ast.ParamSpec).
    """

    name: Identifier
    """The name of the type variable tuple."""

    def __init__(self, name: Identifier):
        """Initialize a type parameter spec.

        Args:
            name: The name of the type parameter spec.
        """
        self.name = name

    def into_code(self) -> str:
        return f"**{self.name.into_code()}"

name instance-attribute ¤

1
name: Identifier = name

The name of the type variable tuple.

__init__ ¤

1
__init__(name: Identifier)

Initialize a type parameter spec.

Parameters:

Name Type Description Default
name Identifier

The name of the type parameter spec.

 required
Source code in synt/ty/type_param.py 
113
114
115
116
117
118
119
def __init__(self, name: Identifier):
    """Initialize a type parameter spec.

    Args:
        name: The name of the type parameter spec.
    """
    self.name = name

into_code ¤

1
into_code() -> str
Source code in synt/ty/type_param.py 
121
122
def into_code(self) -> str:
    return f"**{self.name.into_code()}"