Source code for visions.types.string

from typing import Sequence

import pandas as pd
from pandas.api import types as pdt

from visions.relations import IdentityRelation, TypeRelation
from visions.types.type import VisionsBaseType


def _get_relations(cls) -> Sequence[TypeRelation]:
    from visions.types import Object

    relations = [IdentityRelation(cls, Object)]

    return relations


pandas_has_string_dtype_flag = hasattr(pdt, "is_string_dtype")


[docs]class String(VisionsBaseType): """**String** implementation of :class:`visions.types.type.VisionsBaseType`. Examples: >>> x = pd.Series(['rubin', 'carter', 'champion']) >>> x in visions.String True """ @classmethod def get_relations(cls) -> Sequence[TypeRelation]: return _get_relations(cls) @classmethod def contains_op(cls, series: pd.Series) -> bool: # TODO: without the object check this passes string categories... is there a better way? if pdt.is_categorical_dtype(series): return False elif not pdt.is_object_dtype(series): if pandas_has_string_dtype_flag and pdt.is_string_dtype(series): return True return False if series.hasnans: series = series.dropna() if series.empty: return False return all(isinstance(v, str) for v in series)