Skip to content

synt.tokens.kv_pair ¤

pair module-attribute ¤

1
pair = KVPair

Alias for KVPair.

kv module-attribute ¤

1
kv = KVPair

Alias for KVPair.

KVPair ¤

Bases: Expression

A key-value pair, aka a: b.

This is mainly used in dict initializing ({a: b}).

Source code in synt/tokens/kv_pair.py 
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
class KVPair(Expression):
    r"""A key-value pair, aka `a: b`.

    This is mainly used in dict initializing (`{a: b}`)."""

    key: Expression
    """Key expression."""
    value: Expression
    """Value expression."""
    precedence = ExprPrecedence.Atom
    expr_type = ExprType.KeyValuePair

    def __init__(self, key: IntoExpression, value: IntoExpression):
        """Initialize a key-value pair.

        Args:
            key: Key expression.
            value: Value expression.

        Examples:
            ```python
            kv_pair = kv(id_("a"), id_("b"))
            assert kv_pair.into_code() == "a: b"
            ```
        """
        self.key = key.into_expression()
        self.value = value.into_expression()

    def into_code(self) -> str:
        return f"{self.key.into_code()}: {self.value.into_code()}"

precedence class-attribute instance-attribute ¤

1
precedence = Atom

expr_type class-attribute instance-attribute ¤

1
expr_type = KeyValuePair

key instance-attribute ¤

1
key: Expression = into_expression()

Key expression.

value instance-attribute ¤

1
value: Expression = into_expression()

Value expression.

__init__ ¤

1
__init__(key: IntoExpression, value: IntoExpression)

Initialize a key-value pair.

Parameters:

Name Type Description Default
key IntoExpression

Key expression.

 required
value IntoExpression

Value expression.

 required

Examples:

1
2
kv_pair = kv(id_("a"), id_("b"))
assert kv_pair.into_code() == "a: b"
Source code in synt/tokens/kv_pair.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def __init__(self, key: IntoExpression, value: IntoExpression):
    """Initialize a key-value pair.

    Args:
        key: Key expression.
        value: Value expression.

    Examples:
        ```python
        kv_pair = kv(id_("a"), id_("b"))
        assert kv_pair.into_code() == "a: b"
        ```
    """
    self.key = key.into_expression()
    self.value = value.into_expression()

into_code ¤

1
into_code() -> str
Source code in synt/tokens/kv_pair.py 
45
46
def into_code(self) -> str:
    return f"{self.key.into_code()}: {self.value.into_code()}"