Constants¶

def get_copy_ticks_name(value: int, *, prefer_alias: bool = False) -> str:
    """Return the MT5 COPY_TICKS name for an integer value.

    Args:
        value: COPY_TICKS integer value.
        prefer_alias: Return the short alias instead of the official name.

    Returns:
        The matching COPY_TICKS name.

    """
    return _COPY_TICKS_FAMILY.name_by_value(value=value, prefer_alias=prefer_alias)

def get_copy_ticks_value(name: str) -> int:
    """Return the integer value for an MT5 COPY_TICKS name or alias.

    Args:
        name: Official COPY_TICKS name or short alias.

    Returns:
        The matching COPY_TICKS integer.

    """
    return parse_copy_ticks(name)

def get_order_type_name(value: int, *, prefer_alias: bool = False) -> str:
    """Return the MT5 ORDER_TYPE name for an integer value.

    Args:
        value: ORDER_TYPE integer value.
        prefer_alias: Return the short alias instead of the official name.

    Returns:
        The matching ORDER_TYPE name.

    """
    return _ORDER_TYPE_FAMILY.name_by_value(value=value, prefer_alias=prefer_alias)

def get_order_type_value(name: str) -> int:
    """Return the integer value for an MT5 ORDER_TYPE name or alias.

    Args:
        name: Official ORDER_TYPE name or short alias.

    Returns:
        The matching ORDER_TYPE integer.

    """
    return parse_order_type(name)

def get_timeframe_name(value: int, *, prefer_alias: bool = False) -> str:
    """Return the MT5 timeframe name for an integer value.

    Args:
        value: Timeframe integer value.
        prefer_alias: Return the short alias instead of the official name.

    Returns:
        The matching timeframe name.

    """
    return _TIMEFRAME_FAMILY.name_by_value(value=value, prefer_alias=prefer_alias)

def get_timeframe_value(name: str) -> int:
    """Return the integer value for an MT5 timeframe name or alias.

    Args:
        name: Official timeframe name or short alias.

    Returns:
        The matching timeframe integer.

    """
    return parse_timeframe(name)

def list_copy_ticks_names(*, include_aliases: bool = True) -> list[str]:
    """Return MT5 COPY_TICKS names for JSON schema generation.

    Args:
        include_aliases: Include short aliases such as ``ALL``.

    Returns:
        Accepted COPY_TICKS names.
    """
    return _COPY_TICKS_FAMILY.names(include_aliases=include_aliases)

def list_copy_ticks_values() -> list[int]:
    """Return valid MT5 COPY_TICKS integer values for JSON schema generation.

    Returns:
        Valid COPY_TICKS integer values.
    """
    return _COPY_TICKS_FAMILY.values

def list_order_type_names(*, include_aliases: bool = True) -> list[str]:
    """Return MT5 ORDER_TYPE names for JSON schema generation.

    Args:
        include_aliases: Include short aliases such as ``BUY``.

    Returns:
        Accepted ORDER_TYPE names.
    """
    return _ORDER_TYPE_FAMILY.names(include_aliases=include_aliases)

def list_order_type_values() -> list[int]:
    """Return valid MT5 ORDER_TYPE integer values for JSON schema generation.

    Returns:
        Valid ORDER_TYPE integer values.
    """
    return _ORDER_TYPE_FAMILY.values

def list_timeframe_names(*, include_aliases: bool = True) -> list[str]:
    """Return MT5 timeframe names for JSON schema generation.

    Args:
        include_aliases: Include short aliases such as ``M1``.

    Returns:
        Accepted timeframe names.
    """
    return _TIMEFRAME_FAMILY.names(include_aliases=include_aliases)

def list_timeframe_values() -> list[int]:
    """Return valid MT5 timeframe integer values for JSON schema generation.

    Returns:
        Valid timeframe integer values.
    """
    return _TIMEFRAME_FAMILY.values

def parse_copy_ticks(value: object) -> int:
    """Parse a MetaTrader 5 COPY_TICKS name, alias, or integer value.

    Args:
        value: Official name (``COPY_TICKS_ALL``), short alias (``ALL``), or
            numeric string, or integer value.

    Returns:
        The validated MetaTrader 5 COPY_TICKS integer.

    """
    return _parse_constant(value=value, family=_COPY_TICKS_FAMILY)

def parse_order_type(value: object) -> int:
    """Parse a MetaTrader 5 ORDER_TYPE name, alias, or integer value.

    Args:
        value: Official name (``ORDER_TYPE_BUY``), short alias (``BUY``), or
            numeric string, or integer value.

    Returns:
        The validated MetaTrader 5 ORDER_TYPE integer.

    """
    return _parse_constant(value=value, family=_ORDER_TYPE_FAMILY)

def parse_timeframe(value: object) -> int:
    """Parse a MetaTrader 5 timeframe name, alias, or integer value.

    Args:
        value: Official name (``TIMEFRAME_M1``), short alias (``M1``), numeric
            string, or integer value.

    Returns:
        The validated MetaTrader 5 timeframe integer.

    """
    return _parse_constant(value=value, family=_TIMEFRAME_FAMILY)