64 lines
2.0 KiB
Python
64 lines
2.0 KiB
Python
|
#!/usr/bin/env python
|
||
|
|
|
||
|
|
from agate.aggregations.has_nulls import HasNulls
|
||
|
|
from agate.computations.base import Computation
|
||
|
|
from agate.data_types import Text
|
||
|
|
from agate.exceptions import DataTypeError
|
||
|
|
from agate.utils import slugify, issequence
|
||
|
|
|
||
|
|
|
||
|
|
class Slug(Computation):
|
||
|
|
"""
|
||
|
|
Convert text values from one or more columns into slugs. If multiple column
|
||
|
|
names are given, values from those columns will be appended in the given
|
||
|
|
order before standardizing.
|
||
|
|
|
||
|
|
:param column_name:
|
||
|
|
The name of a column or a sequence of column names containing
|
||
|
|
:class:`.Text` values.
|
||
|
|
:param ensure_unique:
|
||
|
|
If True, any duplicate values will be appended with unique identifers.
|
||
|
|
Defaults to False.
|
||
|
|
"""
|
||
|
|
def __init__(self, column_name, ensure_unique=False, **kwargs):
|
||
|
|
self._column_name = column_name
|
||
|
|
self._ensure_unique = ensure_unique
|
||
|
|
self._slug_args = kwargs
|
||
|
|
|
||
|
|
def get_computed_data_type(self, table):
|
||
|
|
return Text()
|
||
|
|
|
||
|
|
def validate(self, table):
|
||
|
|
if issequence(self._column_name):
|
||
|
|
column_names = self._column_name
|
||
|
|
else:
|
||
|
|
column_names = [self._column_name]
|
||
|
|
|
||
|
|
for column_name in column_names:
|
||
|
|
column = table.columns[column_name]
|
||
|
|
|
||
|
|
if not isinstance(column.data_type, Text):
|
||
|
|
raise DataTypeError('Slug column must contain Text data.')
|
||
|
|
|
||
|
|
if HasNulls(column_name).run(table):
|
||
|
|
raise ValueError('Slug column cannot contain `None`.')
|
||
|
|
|
||
|
|
def run(self, table):
|
||
|
|
"""
|
||
|
|
:returns:
|
||
|
|
:class:`string`
|
||
|
|
"""
|
||
|
|
new_column = []
|
||
|
|
|
||
|
|
for row in table.rows:
|
||
|
|
if issequence(self._column_name):
|
||
|
|
column_value = ''
|
||
|
|
for column_name in self._column_name:
|
||
|
|
column_value = column_value + ' ' + row[column_name]
|
||
|
|
|
||
|
|
new_column.append(column_value)
|
||
|
|
else:
|
||
|
|
new_column.append(row[self._column_name])
|
||
|
|
|
||
|
|
return slugify(new_column, ensure_unique=self._ensure_unique, **self._slug_args)
|