Module redvox.api900.migrations
This module provides functions and utilities for slowly migrating API 900 towards API 1000.
Expand source code
"""
This module provides functions and utilities for slowly migrating API 900 towards API 1000.
"""
from typing import List, Union
import os
import numpy as np
MIGRATIONS_KEY: str = "ENABLE_MIGRATIONS"
def are_migrations_enabled() -> bool:
"""
Returns True if migrations are enabled, False otherwise.
:return: True if migrations are enabled, False otherwise.
"""
from_env: str = os.getenv(MIGRATIONS_KEY, "")
return from_env.lower() in ["true", "1"]
def enable_migrations(enable: bool) -> bool:
"""
Either enable or disable migrations by setting or unsetting a global environment variable.
:param enable: True to enable migrations, False otherwise.
:return: The previous migration value setting.
"""
prev_val: bool = are_migrations_enabled()
if enable:
os.environ[MIGRATIONS_KEY] = "1"
else:
if MIGRATIONS_KEY in os.environ:
del os.environ[MIGRATIONS_KEY]
return prev_val
NumericLike = Union[
np.ndarray,
List[int],
List[float],
int,
float
]
def maybe_get_float(data: NumericLike) -> NumericLike:
"""
If migrations are enabled, converts integer arrays, lists, or scalars to floating point arrays, lists, or scalars.
If migrations are disabled, returns exactly what is passed in.
:param data: The numeric data to convert to floating point.
:return: The original input data if migrations are disabled or floating point data is migrations are enabled.
"""
if not are_migrations_enabled():
return data
if isinstance(data, np.ndarray):
return data.astype(np.float64)
if isinstance(data, list):
return list(map(float, data))
if isinstance(data, int):
return float(data)
# We have no idea what it is, so just return we we got.
return data
def maybe_set_int(data: NumericLike) -> NumericLike:
"""
If migrations are enabled, converts floating point arrays, lists, or scalars to integer arrays, lists, or scalars.
If migrations are disabled, returns exactly what is passed in.
:param data: The numeric data to convert to integers.
:return: The original input data if migrations are disabled or integer data is migrations are enabled.
"""
if not are_migrations_enabled():
return data
if isinstance(data, np.ndarray):
return data.astype(np.int32)
if isinstance(data, list):
return list(map(int, data))
if isinstance(data, float):
return int(data)
# We have no idea what it is, so just return we we got.
return dataFunctions
def are_migrations_enabled() ‑> bool-
Returns True if migrations are enabled, False otherwise. :return: True if migrations are enabled, False otherwise.
Expand source code
def are_migrations_enabled() -> bool: """ Returns True if migrations are enabled, False otherwise. :return: True if migrations are enabled, False otherwise. """ from_env: str = os.getenv(MIGRATIONS_KEY, "") return from_env.lower() in ["true", "1"] def enable_migrations(enable: bool) ‑> bool-
Either enable or disable migrations by setting or unsetting a global environment variable. :param enable: True to enable migrations, False otherwise. :return: The previous migration value setting.
Expand source code
def enable_migrations(enable: bool) -> bool: """ Either enable or disable migrations by setting or unsetting a global environment variable. :param enable: True to enable migrations, False otherwise. :return: The previous migration value setting. """ prev_val: bool = are_migrations_enabled() if enable: os.environ[MIGRATIONS_KEY] = "1" else: if MIGRATIONS_KEY in os.environ: del os.environ[MIGRATIONS_KEY] return prev_val def maybe_get_float(data: Union[numpy.ndarray, List[int], List[float], int, float]) ‑> Union[numpy.ndarray, List[int], List[float], int, float]-
If migrations are enabled, converts integer arrays, lists, or scalars to floating point arrays, lists, or scalars. If migrations are disabled, returns exactly what is passed in. :param data: The numeric data to convert to floating point. :return: The original input data if migrations are disabled or floating point data is migrations are enabled.
Expand source code
def maybe_get_float(data: NumericLike) -> NumericLike: """ If migrations are enabled, converts integer arrays, lists, or scalars to floating point arrays, lists, or scalars. If migrations are disabled, returns exactly what is passed in. :param data: The numeric data to convert to floating point. :return: The original input data if migrations are disabled or floating point data is migrations are enabled. """ if not are_migrations_enabled(): return data if isinstance(data, np.ndarray): return data.astype(np.float64) if isinstance(data, list): return list(map(float, data)) if isinstance(data, int): return float(data) # We have no idea what it is, so just return we we got. return data def maybe_set_int(data: Union[numpy.ndarray, List[int], List[float], int, float]) ‑> Union[numpy.ndarray, List[int], List[float], int, float]-
If migrations are enabled, converts floating point arrays, lists, or scalars to integer arrays, lists, or scalars. If migrations are disabled, returns exactly what is passed in. :param data: The numeric data to convert to integers. :return: The original input data if migrations are disabled or integer data is migrations are enabled.
Expand source code
def maybe_set_int(data: NumericLike) -> NumericLike: """ If migrations are enabled, converts floating point arrays, lists, or scalars to integer arrays, lists, or scalars. If migrations are disabled, returns exactly what is passed in. :param data: The numeric data to convert to integers. :return: The original input data if migrations are disabled or integer data is migrations are enabled. """ if not are_migrations_enabled(): return data if isinstance(data, np.ndarray): return data.astype(np.int32) if isinstance(data, list): return list(map(int, data)) if isinstance(data, float): return int(data) # We have no idea what it is, so just return we we got. return data