Skip to content

enums

Enums.

Enum classes for the BitPin API.

Enum

Bases: Enum

Enum.

Source code in src/bitpin/enums.py 
 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
 59
 60
 61
 62
 63
 64
 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
 91
 92
 93
 94
 95
 96
 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
class Enum(_Enum, metaclass=EnumMeta):
    """Enum."""

    def __repr__(self) -> str:
        """
        Representation.

        Returns:
            str: Representation.
        """

        return f"{self.__class__.__name__}.{self.name}"

    def __str__(self) -> str:
        """
        String representation.

        Returns:
            str: String representation.
        """

        return str(self.value)

    def __eq__(self, other: Any) -> bool:  # pragma: no cover
        """
        Equal.

        Args:
            other (Any): Other.

        Returns:
            bool: True if equal, else False.
        """

        if isinstance(other, Enum):
            return self.value == other.value  # type: ignore[no-any-return]  # noqa
        return self.value == other  # type: ignore[no-any-return]  # noqa

    def __hash__(self) -> int:  # pragma: no cover
        """
        Hash.

        Returns:
            int: Hash.
        """

        return hash(self.value)

    @classmethod
    def _missing_(cls, value: object) -> "Enum":
        """
        Missing.

        Args:
            value (object): Value.

        Returns:
            Enum: Enum.
        """

        for member in cls:
            if isinstance(value, str) and member.value == value.upper():  # pragma: no cover
                return member

        return super()._missing_(value)  # type: ignore[attribute-error, no-any-return]  # noqa

    @classmethod
    def get_by_value(cls, value: Any) -> "Enum":
        """
        Get Enum by value.

        Args:
            value (Any): Value.

        Returns:
            Enum: Enum.
        """

        for enum in cls:
            if enum.value.lower() == value.lower():
                return enum
        raise ValueError(f"Invalid value: {value}")

    @classmethod
    def get_by_name(cls, name: Any) -> "Enum":
        """
        Get Enum by name.

        Args:
            name (Any): Name.

        Returns:
            Enum: Enum.
        """

        for enum in cls:
            if enum.name.lower() == name.lower():
                return enum
        raise ValueError(f"Invalid name: {name}")

    @classmethod
    def get_by_name_or_value(cls, name_or_value: Any) -> "Enum":
        """
        Get Enum by name or value.

        Args:
            name_or_value (Any): Name or value.

        Returns:
            Enum: Enum.
        """

        try:
            return cls.get_by_name(name_or_value)
        except ValueError:
            return cls.get_by_value(name_or_value)

    @classmethod
    def get_all_values(cls) -> List[Any]:
        """Get all values."""
        return [enum.value for enum in cls]

    @classmethod
    def get_all_names(cls) -> List[str]:
        """Get all names."""
        return [enum.name for enum in cls]

    @classmethod
    def to_django_choices(cls) -> List[tuple]:
        """Get all names."""
        return [(enum.name, enum.name) for enum in cls]

__eq__(other)

Equal.

Parameters:

Name Type Description Default
other Any

Other.

 required

Returns:

Name Type Description
bool bool

True if equal, else False.
Source code in src/bitpin/enums.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def __eq__(self, other: Any) -> bool:  # pragma: no cover
    """
    Equal.

    Args:
        other (Any): Other.

    Returns:
        bool: True if equal, else False.
    """

    if isinstance(other, Enum):
        return self.value == other.value  # type: ignore[no-any-return]  # noqa
    return self.value == other  # type: ignore[no-any-return]  # noqa

__hash__()

Hash.

Returns:

Name Type Description
int int

Hash.
Source code in src/bitpin/enums.py 
71
72
73
74
75
76
77
78
79
def __hash__(self) -> int:  # pragma: no cover
    """
    Hash.

    Returns:
        int: Hash.
    """

    return hash(self.value)

__repr__()

Representation.

Returns:

Name Type Description
str str

Representation.
Source code in src/bitpin/enums.py 
36
37
38
39
40
41
42
43
44
def __repr__(self) -> str:
    """
    Representation.

    Returns:
        str: Representation.
    """

    return f"{self.__class__.__name__}.{self.name}"

__str__()

String representation.

Returns:

Name Type Description
str str

String representation.
Source code in src/bitpin/enums.py 
46
47
48
49
50
51
52
53
54
def __str__(self) -> str:
    """
    String representation.

    Returns:
        str: String representation.
    """

    return str(self.value)

get_all_names() classmethod

Get all names.

Source code in src/bitpin/enums.py 
155
156
157
158
@classmethod
def get_all_names(cls) -> List[str]:
    """Get all names."""
    return [enum.name for enum in cls]

get_all_values() classmethod

Get all values.

Source code in src/bitpin/enums.py 
150
151
152
153
@classmethod
def get_all_values(cls) -> List[Any]:
    """Get all values."""
    return [enum.value for enum in cls]

get_by_name(name) classmethod

Get Enum by name.

Parameters:

Name Type Description Default
name Any

Name.

 required

Returns:

Name Type Description
Enum Enum

Enum.
Source code in src/bitpin/enums.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
@classmethod
def get_by_name(cls, name: Any) -> "Enum":
    """
    Get Enum by name.

    Args:
        name (Any): Name.

    Returns:
        Enum: Enum.
    """

    for enum in cls:
        if enum.name.lower() == name.lower():
            return enum
    raise ValueError(f"Invalid name: {name}")

get_by_name_or_value(name_or_value) classmethod

Get Enum by name or value.

Parameters:

Name Type Description Default
name_or_value Any

Name or value.

 required

Returns:

Name Type Description
Enum Enum

Enum.
Source code in src/bitpin/enums.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
@classmethod
def get_by_name_or_value(cls, name_or_value: Any) -> "Enum":
    """
    Get Enum by name or value.

    Args:
        name_or_value (Any): Name or value.

    Returns:
        Enum: Enum.
    """

    try:
        return cls.get_by_name(name_or_value)
    except ValueError:
        return cls.get_by_value(name_or_value)

get_by_value(value) classmethod

Get Enum by value.

Parameters:

Name Type Description Default
value Any

Value.

 required

Returns:

Name Type Description
Enum Enum

Enum.
Source code in src/bitpin/enums.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
@classmethod
def get_by_value(cls, value: Any) -> "Enum":
    """
    Get Enum by value.

    Args:
        value (Any): Value.

    Returns:
        Enum: Enum.
    """

    for enum in cls:
        if enum.value.lower() == value.lower():
            return enum
    raise ValueError(f"Invalid value: {value}")

to_django_choices() classmethod

Get all names.

Source code in src/bitpin/enums.py 
160
161
162
163
@classmethod
def to_django_choices(cls) -> List[tuple]:
    """Get all names."""
    return [(enum.name, enum.name) for enum in cls]

EnumMeta

Bases: EnumMeta

Enum Meta.

Source code in src/bitpin/enums.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class EnumMeta(_EnumMeta):
    """Enum Meta."""

    def __call__(cls, value: Any, *args: Any, **kwargs: Any) -> "Enum":  # type: ignore[override]
        """Call."""
        if isinstance(value, str):  # pragma: no cover
            value = value.upper()

        return super().__call__(value, *args, **kwargs)  # type: ignore[no-any-return]  # noqa

    def __contains__(cls, value: Any) -> bool:
        """Contains."""

        if isinstance(value, str):
            return value.upper() in cls._value2member_map_  # type: ignore[attr-defined]  # noqa

        return super().__contains__(value)  # type: ignore[call-arg]  # noqa

__call__(value, *args, **kwargs)

Call.

Source code in src/bitpin/enums.py 
17
18
19
20
21
22
def __call__(cls, value: Any, *args: Any, **kwargs: Any) -> "Enum":  # type: ignore[override]
    """Call."""
    if isinstance(value, str):  # pragma: no cover
        value = value.upper()

    return super().__call__(value, *args, **kwargs)  # type: ignore[no-any-return]  # noqa

__contains__(value)

Contains.

Source code in src/bitpin/enums.py 
24
25
26
27
28
29
30
def __contains__(cls, value: Any) -> bool:
    """Contains."""

    if isinstance(value, str):
        return value.upper() in cls._value2member_map_  # type: ignore[attr-defined]  # noqa

    return super().__contains__(value)  # type: ignore[call-arg]  # noqa

OrderMode

Bases: str, Enum

Order Mode (LIMIT/MARKET/OCO/STOP_LIMIT).

Source code in src/bitpin/enums.py 
173
174
175
176
177
178
179
class OrderMode(str, Enum):
    """Order Mode (LIMIT/MARKET/OCO/STOP_LIMIT)."""

    LIMIT = "limit"
    MARKET = "market"
    OCO = "oco"
    STOP_LIMIT = "stop_limit"

OrderState

Bases: str, Enum

Order State (INITIAL/ACTIVE/CLOSED).

Source code in src/bitpin/enums.py 
182
183
184
185
186
187
class OrderState(str, Enum):
    """Order State (INITIAL/ACTIVE/CLOSED)."""

    INITIAL = "initial"
    ACTIVE = "active"
    CLOSED = "closed"

OrderType

Bases: str, Enum

Order Type (BUY/SELL).

Source code in src/bitpin/enums.py 
166
167
168
169
170
class OrderType(str, Enum):
    """Order Type (BUY/SELL)."""

    BUY = "buy"
    SELL = "sell"

RequestMethod

Bases: str, Enum

Request Methods (GET/POST/PUT/DELETE).

Source code in src/bitpin/enums.py 
190
191
192
193
194
195
196
class RequestMethod(str, Enum):
    """Request Methods (GET/POST/PUT/DELETE)."""

    GET = "get"
    POST = "post"
    PUT = "put"
    DELETE = "delete"