pixeltable 0.2.5__py3-none-any.whl → 0.2.7__py3-none-any.whl

pixeltable/tests/test_dataframe.py

@@ -1,440 +0,0 @@
-import datetime
-import pickle
-from pathlib import Path
-from typing import Any, Dict
-
-import bs4
-import numpy as np
-import pytest
-import requests
-
-import pixeltable as pxt
-from pixeltable import catalog
-from pixeltable import exceptions as excs
-from pixeltable.iterators import FrameIterator
-from pixeltable.tests.utils import get_video_files, get_audio_files, skip_test_if_not_installed
-
-
-class TestDataFrame:
-
-    @pxt.udf(return_type=pxt.JsonType(nullable=False), param_types=[pxt.JsonType(nullable=False)])
-    def yolo_to_coco(detections):
-        bboxes, labels = detections['bboxes'], detections['labels']
-        num_annotations = len(detections['bboxes'])
-        assert num_annotations == len(detections['labels'])
-        result = []
-        for i in range(num_annotations):
-            bbox = bboxes[i]
-            ann = {
-                'bbox': [round(bbox[0]), round(bbox[1]), round(bbox[2] - bbox[0]), round(bbox[3] - bbox[1])],
-                'category': labels[i],
-            }
-            result.append(ann)
-        return result
-
-    def test_select_where(self, test_tbl: catalog.Table) -> None:
-        t = test_tbl
-        res1 = t[t.c1, t.c2, t.c3].show(0)
-        res2 = t.select(t.c1, t.c2, t.c3).show(0)
-        assert res1 == res2
-
-        res1 = t[t.c2 < 10][t.c1, t.c2, t.c3].show(0)
-        res2 = t.where(t.c2 < 10).select(t.c1, t.c2, t.c3).show(0)
-        assert res1 == res2
-
-        res3 = t.where(t.c2 < 10).select(c1=t.c1, c2=t.c2, c3=t.c3).show(0)
-        assert res1 == res3
-
-        res4 = t.where(t.c2 < 10).select(t.c1, c2=t.c2, c3=t.c3).show(0)
-        assert res1 == res4
-
-        _ = t.where(t.c2 < 10).select(t.c2, t.c2).show(0) # repeated name no error
-
-        # duplicate select list
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c1).select(t.c2).show(0)
-        assert 'already specified' in str(exc_info.value)
-
-        # invalid expr in select list: Callable is not a valid literal
-        with pytest.raises(TypeError) as exc_info:
-            _ = t.select(datetime.datetime.now).show(0)
-        assert 'Not a valid literal' in str(exc_info.value)
-
-        # catch invalid name in select list from user input
-        # only check stuff that's not caught by python kwargs checker
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c1, **{'c2-1': t.c2}).show(0)
-        assert 'Invalid name' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c1, **{'': t.c2}).show(0)
-        assert 'Invalid name' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c1, **{'foo.bar': t.c2}).show(0)
-        assert 'Invalid name' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c1, _c3=t.c2).show(0)
-        assert 'Invalid name' in str(exc_info.value)
-
-        # catch repeated name from user input
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c2, c2=t.c1).show(0)
-        assert 'Repeated column name' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.select(t.c2+1, col_0=t.c2).show(0)
-        assert 'Repeated column name' in str(exc_info.value)
-
-    def test_result_set_iterator(self, test_tbl: catalog.Table) -> None:
-        t = test_tbl
-        res = t.select(t.c1, t.c2, t.c3).collect()
-        pd_df = res.to_pandas()
-
-        def check_row(row: Dict[str, Any], idx: int) -> None:
-            assert len(row) == 3
-            assert 'c1' in row
-            assert row['c1'] == pd_df['c1'][idx]
-            assert 'c2' in row
-            assert row['c2'] == pd_df['c2'][idx]
-            assert 'c3' in row
-            assert row['c3'] == pd_df['c3'][idx]
-
-        # row iteration
-        for idx, row in enumerate(res):
-            check_row(row, idx)
-
-        # row access
-        row = res[0]
-        check_row(row, 0)
-
-        # column access
-        col_values = res['c2']
-        assert col_values == pd_df['c2'].values.tolist()
-
-        # cell access
-        assert res[0, 'c2'] == pd_df['c2'][0]
-        assert res[0, 'c2'] == res[0, 1]
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = res['does_not_exist']
-        assert 'Invalid column name' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = res[0, 'does_not_exist']
-        assert 'Invalid column name' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = res[0, 0, 0]
-        assert 'Bad index' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = res['c2', 0]
-        assert 'Bad index' in str(exc_info.value)
-
-    def test_order_by(self, test_tbl: catalog.Table) -> None:
-        t = test_tbl
-        res = t.select(t.c4, t.c2).order_by(t.c4).order_by(t.c2, asc=False).show(0)
-
-        # invalid expr in order_by()
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.order_by(datetime.datetime.now()).show(0)
-        assert 'Invalid expression' in str(exc_info.value)
-
-    def test_head_tail(self, test_tbl: catalog.Table) -> None:
-        t = test_tbl
-        res = t.head(10).to_pandas()
-        assert np.all(res.c2 == list(range(10)))
-        # Where is applied
-        res = t.where(t.c2 > 9).head(10).to_pandas()
-        assert np.all(res.c2 == list(range(10, 20)))
-        # order_by() is an error
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.order_by(t.c2).head(10)
-        assert 'cannot be used with order_by' in str(exc_info.value)
-
-        res = t.tail().to_pandas()
-        assert np.all(res.c2 == list(range(90, 100)))
-        res = t.where(t.c2 < 90).tail().to_pandas()
-        assert np.all(res.c2 == list(range(80, 90)))
-        # order_by() is an error
-        with pytest.raises(excs.Error) as exc_info:
-            _ = t.order_by(t.c2).tail(10)
-        assert 'cannot be used with order_by' in str(exc_info.value)
-
-    def test_describe(self, test_tbl: catalog.Table) -> None:
-        t = test_tbl
-        df = t.select(t.c1).where(t.c2 < 10).limit(10)
-        df.describe()
-
-        # TODO: how to you check the output of these?
-        _ = df.__repr__()
-        _ = df._repr_html_()
-
-    def test_count(self, test_tbl: catalog.Table, small_img_tbl) -> None:
-        skip_test_if_not_installed('nos')
-        t = test_tbl
-        cnt = t.count()
-        assert cnt == 100
-
-        cnt = t.where(t.c2 < 10).count()
-        assert cnt == 10
-
-        # count() doesn't work with similarity search
-        t = small_img_tbl
-        probe = t.select(t.img).show(1)
-        img = probe[0, 0]
-        with pytest.raises(excs.Error):
-            _ = t.where(t.img.nearest(img)).count()
-        with pytest.raises(excs.Error):
-            _ = t.where(t.img.nearest('car')).count()
-
-        # for now, count() doesn't work with non-SQL Where clauses
-        with pytest.raises(excs.Error):
-            _ = t.where(t.img.width > 100).count()
-
-    def test_select_literal(self, test_tbl: catalog.Table) -> None:
-        t = test_tbl
-        res = t.select(1.0).where(t.c2 < 10).collect()
-        assert res[res.column_names()[0]] == [1.0] * 10
-
-    # TODO This test doesn't work on Windows due to reliance on the structure of file URLs
-    @pytest.mark.skip('Test is not portable')
-    def test_html_media_url(self, test_client: pxt.Client) -> None:
-        tab = test_client.create_table('test_html_repr', {'video': pxt.VideoType(), 'audio': pxt.AudioType()})
-        status = tab.insert(video=get_video_files()[0], audio=get_audio_files()[0])
-        assert status.num_rows == 1
-        assert status.num_excs == 0
-
-        res = tab.select(tab.video, tab.audio).collect()
-        doc = bs4.BeautifulSoup(res._repr_html_(), features='html.parser')
-        video_tags = doc.find_all('video')
-        assert len(video_tags) == 1
-        audio_tags = doc.find_all('audio')
-        assert len(audio_tags) == 1
-
-        # get the source elements and test their src attributes
-        for tag in video_tags + audio_tags:
-            sources = tag.find_all('source')
-            assert len(sources) == 1
-            for src in sources:
-                response = requests.get(src['src'])
-                assert response.status_code == 200
-
-    def test_to_pytorch_dataset(self, all_datatypes_tbl: catalog.Table):
-        """ tests all types are handled correctly in this conversion
-        """
-        skip_test_if_not_installed('torch')
-        import torch
-
-        t = all_datatypes_tbl
-        df = t.where(t.row_id < 1)
-        assert df.count() > 0
-        ds = df.to_pytorch_dataset()
-        type_dict = dict(zip(df.get_column_names(),df.get_column_types()))
-        for tup in ds:
-            for col in df.get_column_names():
-                assert col in tup
-
-            arrval = tup['c_array']
-            assert isinstance(arrval, np.ndarray)
-            col_type = type_dict['c_array']
-            assert arrval.dtype == col_type.numpy_dtype()
-            assert arrval.shape == col_type.shape
-            assert arrval.dtype == np.float32
-            assert arrval.flags["WRITEABLE"], 'required by pytorch collate function'
-
-            assert isinstance(tup['c_bool'], bool)
-            assert isinstance(tup['c_int'], int)
-            assert isinstance(tup['c_float'], float)
-            assert isinstance(tup['c_timestamp'], float)
-            assert torch.is_tensor(tup['c_image'])
-            assert isinstance(tup['c_video'], str)
-            assert isinstance(tup['c_json'], dict)
-
-    def test_to_pytorch_image_format(self, all_datatypes_tbl: catalog.Table) -> None:
-        """ tests the image_format parameter is honored
-        """
-        skip_test_if_not_installed('torch')
-        import torch
-        import torchvision.transforms as T
-
-        W, H = 220, 224 # make different from each other
-        t = all_datatypes_tbl
-        df = t.select(
-            t.row_id,
-            t.c_image,
-            c_image_xformed=t.c_image.resize([W, H]).convert('RGB')
-        ).where(t.row_id < 1)
-
-        pandas_df = df.show().to_pandas()
-        im_plain = pandas_df['c_image'].values[0]
-        im_xformed = pandas_df['c_image_xformed'].values[0]
-        assert pandas_df.shape[0] == 1
-
-        ds = df.to_pytorch_dataset(image_format='np')
-        ds_ptformat = df.to_pytorch_dataset(image_format='pt')
-
-        elt_count = 0
-        for elt, elt_pt in zip(ds, ds_ptformat):
-            arr_plain = elt['c_image']
-            assert isinstance(arr_plain, np.ndarray)
-            assert arr_plain.flags["WRITEABLE"], 'required by pytorch collate function'
-
-            # NB: compare numpy array bc PIL.Image object itself is not using same file.
-            assert (arr_plain == np.array(im_plain)).all(), 'numpy image should be the same as the original'
-            arr_xformed = elt['c_image_xformed']
-            assert isinstance(arr_xformed, np.ndarray)
-            assert arr_xformed.flags["WRITEABLE"], 'required by pytorch collate function'
-
-            assert arr_xformed.shape == (H, W, 3)
-            assert arr_xformed.dtype == np.uint8
-            # same as above, compare numpy array bc PIL.Image object itself is not using same file.
-            assert (arr_xformed == np.array(im_xformed)).all(),\
-                'numpy image array for xformed image should be the same as the original'
-
-            # now compare pytorch version
-            arr_pt = elt_pt['c_image']
-            assert torch.is_tensor(arr_pt)
-            arr_pt = elt_pt['c_image_xformed']
-            assert torch.is_tensor(arr_pt)
-            assert arr_pt.shape == (3, H, W)
-            assert arr_pt.dtype == torch.float32
-            assert (0.0 <= arr_pt).all()
-            assert (arr_pt <= 1.0).all()
-            assert torch.isclose(T.ToTensor()(arr_xformed), arr_pt).all(),\
-                'pytorch image should be consistent with numpy image'
-            elt_count += 1
-        assert elt_count == 1
-
-    @pytest.mark.skip('Flaky test (fails intermittently)')
-    def test_to_pytorch_dataloader(self, all_datatypes_tbl: catalog.Table) -> None:
-        """ Tests the dataset works well with pytorch dataloader:
-            1. compatibility with multiprocessing
-            2. compatibility of all types with default collate_fn
-        """
-        skip_test_if_not_installed('torch')
-        import torch.utils.data
-        @pxt.udf(param_types=[pxt.JsonType()], return_type=pxt.JsonType())
-        def restrict_json_for_default_collate(obj):
-            keys = ['id', 'label', 'iscrowd', 'bounding_box']
-            return {k: obj[k] for k in keys}
-
-        t = all_datatypes_tbl
-        df = t.select(
-            t.row_id,
-            t.c_int,
-            t.c_float,
-            t.c_bool,
-            t.c_timestamp,
-            t.c_array,
-            t.c_video,
-            # default collate_fn doesnt support null values, nor lists of different lengths
-            # but does allow some dictionaries if they are uniform
-            c_json = restrict_json_for_default_collate(t.c_json.detections[0]),
-            # images must be uniform shape for pytorch collate_fn to not fail
-            c_image=t.c_image.resize([220, 224]).convert('RGB')
-        )
-        df_size = df.count()
-        ds = df.to_pytorch_dataset(image_format='pt')
-        # test serialization:
-        #  - pickle.dumps() and pickle.loads() must work so that
-        #   we can use num_workers > 0
-        x = pickle.dumps(ds)
-        _ = pickle.loads(x)
-
-        # test we get all rows
-        def check_recover_all_rows(ds, size : int, **kwargs):
-            dl = torch.utils.data.DataLoader(ds, **kwargs)
-            loaded_ids = set()
-            for batch in dl:
-                for row_id in batch['row_id']:
-                    val = int(row_id) # np.int -> int or will fail set equality test below.
-                    assert val not in loaded_ids, val
-                    loaded_ids.add(val)
-
-            assert loaded_ids == set(range(size))
-
-        # check different number of workers
-        check_recover_all_rows(ds, size=df_size, batch_size=3, num_workers=0) # within this process
-        check_recover_all_rows(ds, size=df_size, batch_size=3, num_workers=2) # two separate processes
-
-        # check edge case where some workers get no rows
-        short_size = 1
-        df_short = df.where(t.row_id < short_size)
-        ds_short = df_short.to_pytorch_dataset(image_format='pt')
-        check_recover_all_rows(ds_short, size=short_size, batch_size=13, num_workers=short_size+1)
-
-    def test_pytorch_dataset_caching(self, all_datatypes_tbl: catalog.Table) -> None:
-        """ Tests that dataset caching works
-            1. using the same dataset twice in a row uses the cache
-            2. adding a row to the table invalidates the cached version
-            3. changing the select list invalidates the cached version
-        """
-        skip_test_if_not_installed('torch')
-        t = all_datatypes_tbl
-
-        t.drop_column('c_video') # null value video column triggers internal assertions in DataRow
-        # see https://github.com/pixeltable/pixeltable/issues/38
-
-        t.drop_column('c_array') # no support yet for null array values in the pytorch dataset
-
-        def _get_mtimes(dir: Path):
-            return {p.name: p.stat().st_mtime for p in dir.iterdir()}
-
-        #  check result cached
-        ds1 = t.to_pytorch_dataset(image_format='pt')
-        ds1_mtimes = _get_mtimes(ds1.path)
-
-        ds2 = t.to_pytorch_dataset(image_format='pt')
-        ds2_mtimes = _get_mtimes(ds2.path)
-        assert ds2.path == ds1.path, 'result should be cached'
-        assert ds2_mtimes == ds1_mtimes, 'no extra file system work should have occurred'
-
-        # check invalidation on insert
-        t_size = t.count()
-        t.insert(row_id=t_size)
-        ds3 = t.to_pytorch_dataset(image_format='pt')
-        assert ds3.path != ds1.path, 'different path should be used'
-
-        # check select list invalidation
-        ds4 = t.select(t.row_id).to_pytorch_dataset(image_format='pt')
-        assert ds4.path != ds3.path, 'different select list, hence different path should be used'
-
-    def test_to_coco(self, test_client: pxt.Client) -> None:
-        skip_test_if_not_installed('nos')
-        from pycocotools.coco import COCO
-        cl = test_client
-        base_t = cl.create_table('videos', {'video': pxt.VideoType()})
-        args = {'video': base_t.video, 'fps': 1}
-        view_t = cl.create_view('frames', base_t, iterator_class=FrameIterator, iterator_args=args)
-        from pixeltable.functions.nos.object_detection_2d import yolox_medium
-        view_t.add_column(detections=yolox_medium(view_t.frame))
-        base_t.insert(video=get_video_files()[0])
-
-        query = view_t.select({'image': view_t.frame, 'annotations': self.yolo_to_coco(view_t.detections)})
-        path = query.to_coco_dataset()
-        # we get a valid COCO dataset
-        coco_ds = COCO(path)
-        assert len(coco_ds.imgs) == view_t.count()
-
-        # we call to_coco_dataset() again and get the cached dataset
-        new_path = query.to_coco_dataset()
-        assert path == new_path
-
-        # the cache is invalidated when we add more data
-        base_t.insert(video=get_video_files()[1])
-        new_path = query.to_coco_dataset()
-        assert path != new_path
-        coco_ds = COCO(new_path)
-        assert len(coco_ds.imgs) == view_t.count()
-
-        # incorrect select list
-        with pytest.raises(excs.Error) as exc_info:
-            _ = view_t.select({'image': view_t.frame, 'annotations': view_t.detections}).to_coco_dataset()
-        assert '"annotations" is not a list' in str(exc_info.value)
-
-        with pytest.raises(excs.Error) as exc_info:
-            _ = view_t.select(view_t.detections).to_coco_dataset()
-        assert 'missing key "image"' in str(exc_info.value).lower()

pixeltable/tests/test_dirs.py

@@ -1,107 +0,0 @@
-import pytest
-
-import pixeltable as pxt
-from pixeltable import exceptions as excs
-from pixeltable.tests.utils import make_tbl
-
-
-class TestDirs:
-    def test_create(self, test_client: pxt.Client) -> None:
-        cl = test_client
-        dirs = ['dir1', 'dir1.sub1', 'dir1.sub1.subsub1']
-        for name in dirs:
-            cl.create_dir(name)
-
-        # invalid names
-        with pytest.raises(excs.Error):
-            cl.create_dir('1dir')
-        with pytest.raises(excs.Error):
-            cl.create_dir('_dir1')
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir 1')
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1..sub2')
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1.sub2.')
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1:sub2.')
-
-        # existing dirs
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1')
-        cl.create_dir('dir1', ignore_errors=True)
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1.sub1')
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1.sub1.subsub1')
-
-        # existing table
-        make_tbl(cl, 'dir1.t1')
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir1.t1')
-
-        with pytest.raises(excs.Error):
-            cl.create_dir('dir2.sub2')
-        make_tbl(cl, 't2')
-        with pytest.raises(excs.Error):
-            cl.create_dir('t2.sub2')
-
-        # new client: force loading from store
-        cl2 = pxt.Client(reload=True)
-
-        listing = cl2.list_dirs(recursive=True)
-        assert listing == dirs
-        listing = cl2.list_dirs(recursive=False)
-        assert listing == ['dir1']
-        listing = cl2.list_dirs('dir1', recursive=True)
-        assert listing == ['dir1.sub1', 'dir1.sub1.subsub1']
-        listing = cl2.list_dirs('dir1', recursive=False)
-        assert listing == ['dir1.sub1']
-        listing = cl2.list_dirs('dir1.sub1', recursive=True)
-        assert listing == ['dir1.sub1.subsub1']
-        listing = cl2.list_dirs('dir1.sub1', recursive=False)
-        assert listing == ['dir1.sub1.subsub1']
-
-    def test_rm(self, test_client: pxt.Client) -> None:
-        cl = test_client
-        dirs = ['dir1', 'dir1.sub1', 'dir1.sub1.subsub1']
-        for name in dirs:
-            cl.create_dir(name)
-        make_tbl(cl, 't1')
-        make_tbl(cl, 'dir1.t1')
-
-        # bad name
-        with pytest.raises(excs.Error):
-            cl.rm_dir('1dir')
-        # bad path
-        with pytest.raises(excs.Error):
-            cl.rm_dir('dir1..sub1')
-        # doesn't exist
-        with pytest.raises(excs.Error):
-            cl.rm_dir('dir2')
-        # not empty
-        with pytest.raises(excs.Error):
-            cl.rm_dir('dir1')
-
-        cl.rm_dir('dir1.sub1.subsub1')
-        assert cl.list_dirs('dir1.sub1') == []
-
-        # check after reloading
-        cl = pxt.Client(reload=True)
-        assert cl.list_dirs('dir1.sub1') == []
-
-    def test_move(self, test_client: pxt.Client) -> None:
-        cl = test_client
-        cl.create_dir('dir1')
-        cl.create_dir('dir1.sub1')
-        make_tbl(cl, 'dir1.sub1.t1')
-        assert cl.list_tables('dir1') == ['dir1.sub1.t1']
-        cl.move('dir1.sub1.t1', 'dir1.sub1.t2')
-        assert cl.list_tables('dir1') == ['dir1.sub1.t2']
-        cl.create_dir('dir2')
-        cl.move('dir1', 'dir2.dir1')
-        assert cl.list_tables('dir2') == ['dir2.dir1.sub1.t2']
-
-        # new client: force loading from store
-        cl2 = pxt.Client(reload=True)
-        assert cl2.list_tables('dir2') == ['dir2.dir1.sub1.t2']

pixeltable/tests/test_document.py

@@ -1,120 +0,0 @@
-import itertools
-import json
-import re
-from typing import Optional, Set, List
-
-import pytest
-
-import pixeltable as pxt
-from pixeltable.iterators.document import DocumentSplitter
-from pixeltable.tests.utils import get_documents, get_video_files, get_audio_files, get_image_files
-from pixeltable.tests.utils import skip_test_if_not_installed
-from pixeltable.type_system import DocumentType
-
-
-class TestDocument:
-    def valid_doc_paths(self) -> List[str]:
-        return get_documents()
-
-    def invalid_doc_paths(self) -> List[str]:
-        return [get_video_files()[0], get_audio_files()[0], get_image_files()[0]]
-
-    def test_insert(self, test_client: pxt.Client) -> None:
-        file_paths = self.valid_doc_paths()
-        cl = test_client
-        doc_t = cl.create_table('docs', {'doc': DocumentType()})
-        status = doc_t.insert({'doc': p} for p in file_paths)
-        assert status.num_rows == len(file_paths)
-        assert status.num_excs == 0
-        stored_paths = doc_t.select(output=doc_t.doc.localpath).collect()['output']
-        assert set(stored_paths) == set(file_paths)
-
-        file_paths = self.invalid_doc_paths()
-        status = doc_t.insert(({'doc': p} for p in file_paths), fail_on_exception=False)
-        assert status.num_rows == len(file_paths)
-        assert status.num_excs == len(file_paths)
-
-    def test_doc_splitter(self, test_client: pxt.Client) -> None:
-        skip_test_if_not_installed('tiktoken')
-        file_paths = self.valid_doc_paths()
-        cl = test_client
-        doc_t = cl.create_table('docs', {'doc': DocumentType()})
-        status = doc_t.insert({'doc': p} for p in file_paths)
-        assert status.num_excs == 0
-
-        def normalize(s: str) -> str:
-            # remove whitespace
-            res = re.sub(r'\s+', '', s)
-            # remove non-ascii
-            res = res.encode('ascii', 'ignore').decode()
-            return res
-
-        # run all combinations of (heading, paragraph, sentence) x (token_limit, char_limit, None)
-        # and make sure they extract the same text in aggregate
-        all_text_reference: Optional[str] = None  # all text as a single string; normalized
-        headings_reference: Set[str] = {}  # headings metadata as a json-serialized string
-        for sep1 in ['heading', 'paragraph', 'sentence']:
-            for sep2 in [None, 'token_limit', 'char_limit']:
-                chunk_limits = [10, 20, 100] if sep2 is not None else [None]
-                for limit in chunk_limits:
-                    iterator_args = {
-                        'document': doc_t.doc,
-                        'separators': sep1 + (',' + sep2 if sep2 is not None else ''),
-                        'metadata': 'title,headings,sourceline'
-                    }
-                    if sep2 is not None:
-                        iterator_args['limit'] = limit
-                        iterator_args['overlap'] = 0
-                    chunks_t = cl.create_view(
-                        f'chunks', doc_t, iterator_class=DocumentSplitter, iterator_args=iterator_args)
-                    res = list(chunks_t.order_by(chunks_t.doc, chunks_t.pos).collect())
-
-                    if all_text_reference is None:
-                        all_text_reference = normalize(''.join([r['text'] for r in res]))
-                        headings_reference = set(json.dumps(r['headings']) for r in res)
-                    else:
-                        all_text = normalize(''.join([r['text'] for r in res]))
-                        headings = set(json.dumps(r['headings']) for r in res)
-
-                        # for debugging
-                        first_diff_index = next(
-                            (i for i, (c1, c2) in enumerate(zip(all_text, all_text_reference)) if c1 != c2),
-                            len(all_text) if len(all_text) != len(all_text_reference) else None)
-                        if first_diff_index is not None:
-                            a = all_text[max(0, first_diff_index - 10):first_diff_index + 10]
-                            b = all_text_reference[max(0, first_diff_index - 10):first_diff_index + 10]
-
-                        assert all_text == all_text_reference, f'{sep1}, {sep2}, {limit}'
-                        assert headings == headings_reference, f'{sep1}, {sep2}, {limit}'
-                        # TODO: verify chunk limit
-                    cl.drop_table('chunks')
-
-    def test_doc_splitter_headings(self, test_client: pxt.Client) -> None:
-        skip_test_if_not_installed('spacy')
-        file_paths = self.valid_doc_paths()
-        cl = test_client
-        doc_t = cl.create_table('docs', {'doc': DocumentType()})
-        status = doc_t.insert({'doc': p} for p in file_paths)
-        assert status.num_excs == 0
-
-        # verify that only the requested metadata is present in the view
-        md_elements = ['title', 'headings', 'sourceline']
-        md_tuples = list(itertools.chain.from_iterable(itertools.combinations(md_elements, i) for i in range(len(md_elements) + 1)))
-        _ = [','.join(t) for t in md_tuples]
-        for md_str in [','.join(t) for t in md_tuples]:
-            iterator_args = {
-                'document': doc_t.doc,
-                'separators': 'sentence',
-                'metadata': md_str
-            }
-            chunks_t = cl.create_view(
-                f'chunks', doc_t, iterator_class=DocumentSplitter, iterator_args=iterator_args)
-            res = chunks_t.order_by(chunks_t.doc, chunks_t.pos).collect()
-            requested_md_elements = set(md_str.split(','))
-            for md_element in md_elements:
-                if md_element in requested_md_elements:
-                    _ = res[md_element]
-                else:
-                    with pytest.raises(pxt.Error):
-                        _ = res[md_element]
-            cl.drop_table('chunks')