Source code for woodwork.logical_types

import pandas as pd

from woodwork.accessor_utils import _is_dask_series, _is_koalas_series
from woodwork.exceptions import TypeConversionError
from woodwork.type_sys.utils import _get_specified_ltype_params
from woodwork.utils import (
    _infer_datetime_format,
    _reformat_to_latlong,
    camel_to_snake,
    import_or_none
)

dd = import_or_none('dask.dataframe')
ks = import_or_none('databricks.koalas')


class ClassNameDescriptor(object):
    """Descriptor to convert a class's name from camelcase to snakecase"""

    def __get__(self, instance, class_):
        return camel_to_snake(class_.__name__)


class LogicalTypeMetaClass(type):

    def __repr__(cls):
        return cls.__name__


class LogicalType(object, metaclass=LogicalTypeMetaClass):
    """Base class for all other Logical Types"""
    type_string = ClassNameDescriptor()
    primary_dtype = 'string'
    backup_dtype = None
    standard_tags = set()

    def __eq__(self, other, deep=False):
        return isinstance(other, self.__class__) and _get_specified_ltype_params(other) == _get_specified_ltype_params(self)

    def __str__(self):
        return str(self.__class__)

    @classmethod
    def _get_valid_dtype(cls, series_type):
        """Return the dtype that is considered valid for a series with the given logical_type"""
        if ks and series_type == ks.Series and cls.backup_dtype:
            return cls.backup_dtype
        else:
            return cls.primary_dtype

    def transform(self, series):
        """Converts the series dtype to match the logical type's if it is different."""
        new_dtype = self._get_valid_dtype(type(series))
        if new_dtype != str(series.dtype):
            # Update the underlying series
            try:
                series = series.astype(new_dtype)
            except (TypeError, ValueError):
                raise TypeConversionError(series, new_dtype, type(self))
        return series


[docs]class Address(LogicalType): """Represents Logical Types that contain address values. Examples: .. code-block:: python ['1 Miller Drive, New York, NY 12345', '1 Berkeley Street, Boston, MA 67891'] ['26387 Russell Hill, Dallas, TX 34521', '54305 Oxford Street, Seattle, WA 95132'] """ primary_dtype = 'string'
[docs]class Age(LogicalType): """Represents Logical Types that contain non-negative numbers indicating a person's age. Has 'numeric' as a standard tag. Examples: .. code-block:: python [15, 22, 45] [30, 62, 87] """ primary_dtype = 'int64' standard_tags = {'numeric'}
[docs]class AgeNullable(LogicalType): """Represents Logical Types that contain non-negative numbers indicating a person's age. Has 'numeric' as a standard tag. May also contain null values. Examples: .. code-block:: python [np.nan, 22, 45] [30, 62, np.nan] """ primary_dtype = 'Int64' standard_tags = {'numeric'}
[docs]class Boolean(LogicalType): """Represents Logical Types that contain binary values indicating true/false. Examples: .. code-block:: python [True, False, True] [0, 1, 1] """ primary_dtype = 'bool'
[docs]class BooleanNullable(LogicalType): """Represents Logical Types that contain binary values indicating true/false. May also contain null values. Examples: .. code-block:: python [True, False, None] [0, 1, 1] """ primary_dtype = 'boolean'
[docs]class Categorical(LogicalType): """Represents Logical Types that contain unordered discrete values that fall into one of a set of possible values. Has 'category' as a standard tag. Examples: .. code-block:: python ["red", "green", "blue"] ["produce", "dairy", "bakery"] [3, 1, 2] """ primary_dtype = 'category' backup_dtype = 'string' standard_tags = {'category'}
[docs] def __init__(self, encoding=None): # encoding dict(str -> int) # user can specify the encoding to use downstream pass
[docs]class CountryCode(LogicalType): """Represents Logical Types that use the ISO-3166 standard country code to represent countries. ISO 3166-1 (countries) are supported. These codes should be in the Alpha-2 format. Examples: .. code-block:: python ["AU", "US", "UA"] ["GB", "NZ", "DE"] """ primary_dtype = 'category' backup_dtype = 'string' standard_tags = {'category'}
[docs]class Datetime(LogicalType): """Represents Logical Types that contain date and time information. Args: datetime_format (str): Desired datetime format for data Examples: .. code-block:: python ["2020-09-10", "2020-01-10 00:00:00", "01/01/2000 08:30"] """ primary_dtype = 'datetime64[ns]' datetime_format = None
[docs] def __init__(self, datetime_format=None): self.datetime_format = datetime_format
def transform(self, series): """Converts the series data to a formatted datetime. Datetime format will be inferred if datetime_format is None.""" new_dtype = self._get_valid_dtype(type(series)) if new_dtype != str(series.dtype): sample_length = len(series.index) // 10 or len(series.index) self.datetime_format = self.datetime_format or _infer_datetime_format(series, n=sample_length) try: if _is_dask_series(series): name = series.name series = dd.to_datetime(series, format=self.datetime_format) series.name = name elif _is_koalas_series(series): series = ks.Series(ks.to_datetime(series.to_numpy(), format=self.datetime_format), name=series.name) else: series = pd.to_datetime(series, format=self.datetime_format) except (TypeError, ValueError): raise TypeConversionError(series, new_dtype, type(self)) return super().transform(series)
[docs]class Double(LogicalType): """Represents Logical Types that contain positive and negative numbers, some of which include a fractional component. Includes zero (0). Has 'numeric' as a standard tag. Examples: .. code-block:: python [1.2, 100.4, 3.5] [-15.34, 100, 58.3] """ primary_dtype = 'float64' standard_tags = {'numeric'}
[docs]class Integer(LogicalType): """Represents Logical Types that contain positive and negative numbers without a fractional component, including zero (0). Has 'numeric' as a standard tag. Examples: .. code-block:: python [100, 35, 0] [-54, 73, 11] """ primary_dtype = 'int64' standard_tags = {'numeric'}
[docs]class IntegerNullable(LogicalType): """Represents Logical Types that contain positive and negative numbers without a fractional component, including zero (0). May contain null values. Has 'numeric' as a standard tag. Examples: .. code-block:: python [100, 35, np.nan] [-54, 73, 11] """ primary_dtype = 'Int64' standard_tags = {'numeric'}
[docs]class EmailAddress(LogicalType): """Represents Logical Types that contain email address values. Examples: .. code-block:: python ["john.smith@example.com", "support@example.com", "team@example.com"] """ primary_dtype = 'string'
[docs]class Filepath(LogicalType): """Represents Logical Types that specify locations of directories and files in a file system. Examples: .. code-block:: python ["/usr/local/bin", "/Users/john.smith/dev/index.html", "/tmp"] """ primary_dtype = 'string'
[docs]class PersonFullName(LogicalType): """Represents Logical Types that may contain first, middle and last names, including honorifics and suffixes. Examples: .. code-block:: python ["Mr. John Doe, Jr.", "Doe, Mrs. Jane", "James Brown"] """ primary_dtype = 'string'
[docs]class IPAddress(LogicalType): """Represents Logical Types that contain IP addresses, including both IPv4 and IPv6 addresses. Examples: .. code-block:: python ["172.16.254.1", "192.0.0.0", "2001:0db8:0000:0000:0000:ff00:0042:8329"] """ primary_dtype = 'string'
[docs]class LatLong(LogicalType): """Represents Logical Types that contain latitude and longitude values in decimal degrees. Note: LatLong values will be stored with the object dtype as a tuple of floats (or a list of floats for Koalas DataFrames) and must contain only two values. Null latitude or longitude values will be stored as np.nan, and a fully null LatLong (np.nan, np.nan) will be stored as just a single nan. Examples: .. code-block:: python [(33.670914, -117.841501), (40.423599, -86.921162), (-45.031705, nan)] """ primary_dtype = 'object' def transform(self, series): """Formats a series to be a tuple (or list for Koalas) of two floats.""" if _is_dask_series(series): name = series.name meta = (series, tuple([float, float])) series = series.apply(_reformat_to_latlong, meta=meta) series.name = name elif _is_koalas_series(series): formatted_series = series.to_pandas().apply(_reformat_to_latlong, use_list=True) series = ks.from_pandas(formatted_series) else: series = series.apply(_reformat_to_latlong) return super().transform(series)
[docs]class NaturalLanguage(LogicalType): """Represents Logical Types that contain text or characters representing natural human language Examples: .. code-block:: python ["This is a short sentence.", "I like to eat pizza!", "When will humans go to mars?"] """ primary_dtype = 'string'
[docs]class Unknown(LogicalType): """Represents Logical Types that cannot be inferred as a specific Logical Type. It is assumed to contain string data. Examples: .. code-block:: python ["ax23n9ck23l", "1,28&*_%*&&xejc", "xnmvz@@Dcmeods-0"] """ primary_dtype = 'string'
[docs]class Ordinal(LogicalType): """Represents Logical Types that contain ordered discrete values. Has 'category' as a standard tag. Args: order (list or tuple): An list or tuple specifying the order of the ordinal values from low to high. The underlying series cannot contain values that are not present in the order values. Examples: .. code-block:: python ["first", "second", "third"] ["bronze", "silver", "gold"] """ primary_dtype = 'category' backup_dtype = 'string' standard_tags = {'category'}
[docs] def __init__(self, order=None): self.order = order
def _validate_data(self, series): """Make sure order values are properly defined and confirm the supplied series does not contain any values that are not in the specified order values""" if self.order is None: raise TypeError("Must use an Ordinal instance with order values defined") elif not isinstance(self.order, (list, tuple)): raise TypeError("Order values must be specified in a list or tuple") if len(self.order) != len(set(self.order)): raise ValueError("Order values cannot contain duplicates") if isinstance(series, pd.Series): missing_order_vals = set(series.dropna().values).difference(self.order) if missing_order_vals: error_msg = f'Ordinal column {series.name} contains values that are not present ' \ f'in the order values provided: {sorted(list(missing_order_vals))}' raise ValueError(error_msg) def transform(self, series): """Validates the series and converts the dtype to match the logical type's if it is different.""" self._validate_data(series) return super().transform(series)
[docs]class PhoneNumber(LogicalType): """Represents Logical Types that contain numeric digits and characters representing a phone number Examples: .. code-block:: python ["1-(555)-123-5495", "+1-555-123-5495", "5551235495"] """ primary_dtype = 'string'
[docs]class SubRegionCode(LogicalType): """Represents Logical Types that use the ISO-3166 standard sub-region code to represent a portion of a larger geographic region. ISO 3166-2 (sub-regions) codes are supported. These codes should be in the Alpha-2 format. Examples: .. code-block:: python ["US-CO", "US-MA", "US-CA"] ["AU-NSW", "AU-TAS", "AU-QLD"] """ primary_dtype = 'category' backup_dtype = 'string' standard_tags = {'category'}
[docs]class Timedelta(LogicalType): """Represents Logical Types that contain values specifying a duration of time Examples: .. code-block:: python [pd.Timedelta('1 days 00:00:00'), pd.Timedelta('-1 days +23:40:00'), pd.Timedelta('4 days 12:00:00')] """ primary_dtype = 'timedelta64[ns]'
[docs]class URL(LogicalType): """Represents Logical Types that contain URLs, which may include protocol, hostname and file name Examples: .. code-block:: python ["http://google.com", "https://example.com/index.html", "example.com"] """ primary_dtype = 'string'
[docs]class PostalCode(LogicalType): """Represents Logical Types that contain a series of postal codes for representing a group of addresses. Has 'category' as a standard tag. Examples: .. code-block:: python ["90210" "60018-0123", "SW1A"] """ primary_dtype = 'category' backup_dtype = 'string' standard_tags = {'category'}