Module astrapy.data.utils.vector_coercion

Expand source code
# Copyright DataStax, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

from typing import Any, Iterable

from astrapy.data_types import DataAPIMap, DataAPISet, DataAPIVector

ITERABLES_TO_NOT_UNROLL = list, str, bytes, dict, DataAPIVector, DataAPIMap, DataAPISet


def ensure_unrolled_if_iterable(value: Any) -> Any:
    if isinstance(value, Iterable) and not isinstance(value, (ITERABLES_TO_NOT_UNROLL)):
        return list(value)
    return value


def convert_vector_to_floats(vector: Iterable[Any]) -> list[float]:
    """
    Convert a vector of strings to a vector of floats.

    Args:
        vector (list): A vector of objects.

    Returns:
        list: A vector of floats.
    """
    return [float(value) for value in vector]


def is_list_of_floats(vector: Iterable[Any]) -> bool:
    """
    Safely determine if it's a list of floats.
    Assumption: if list, and first item is float, then all items are.
    """
    return isinstance(vector, list) and (
        len(vector) == 0 or isinstance(vector[0], float) or isinstance(vector[0], int)
    )

Functions

def convert_vector_to_floats(vector: Iterable[Any]) ‑> list[float]

Convert a vector of strings to a vector of floats.

Args

vector : list
A vector of objects.

Returns

list
A vector of floats.
Expand source code
def convert_vector_to_floats(vector: Iterable[Any]) -> list[float]:
    """
    Convert a vector of strings to a vector of floats.

    Args:
        vector (list): A vector of objects.

    Returns:
        list: A vector of floats.
    """
    return [float(value) for value in vector]
def ensure_unrolled_if_iterable(value: Any) ‑> Any
Expand source code
def ensure_unrolled_if_iterable(value: Any) -> Any:
    if isinstance(value, Iterable) and not isinstance(value, (ITERABLES_TO_NOT_UNROLL)):
        return list(value)
    return value
def is_list_of_floats(vector: Iterable[Any]) ‑> bool

Safely determine if it's a list of floats. Assumption: if list, and first item is float, then all items are.

Expand source code
def is_list_of_floats(vector: Iterable[Any]) -> bool:
    """
    Safely determine if it's a list of floats.
    Assumption: if list, and first item is float, then all items are.
    """
    return isinstance(vector, list) and (
        len(vector) == 0 or isinstance(vector[0], float) or isinstance(vector[0], int)
    )