Merge pull request #21 from tushushu/wip-constructors

Construction methods

Author: tushushu

.github/workflows/main.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        python-version: ['3.6']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

.github/workflows/sphinx.yml

@@ -1,13 +1,14 @@
-name: "Pull Request Docs Check"
+name: "doc"
 on: 
+- pull_request
 - release
 
 jobs:
   docs:
     runs-on: macos-latest
     strategy:
       matrix:
-        python-version: ['3.6']
+        python-version: ['3.8']
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

README.md

@@ -1,10 +1,11 @@
 # ulist
 
-![PyPI](https://img.shields.io/pypi/v/ulist)
-![License](https://img.shields.io/github/license/tushushu/ulist)
-![CI](https://github.com/tushushu/ulist/workflows/CI/badge.svg)
+[![PyPI](https://img.shields.io/pypi/v/ulist)](https://pypi.org/project/ulist/)
+[![License](https://img.shields.io/github/license/tushushu/ulist)](https://github.com/tushushu/ulist/blob/main/LICENSE)
+[![CI](https://github.com/tushushu/ulist/workflows/CI/badge.svg)](https://github.com/tushushu/ulist/actions/workflows/main.yml)
+[![doc](https://github.com/tushushu/ulist/workflows/doc/badge.svg)](https://github.com/tushushu/ulist/actions/workflows/sphinx.yml)
 ![PyPI - Format](https://img.shields.io/pypi/format/ulist)
-![Code Style](https://img.shields.io/badge/code%20style-flake8-blue)  
+[![Code Style](https://img.shields.io/badge/code%20style-flake8-blue)](https://github.com/PyCQA/flake8)  
 
 
 [**Documentation**](https://tushushu.github.io/ulist/) | [**Source Code**](https://github.com/tushushu/ulist)  
@@ -15,7 +16,7 @@ Ulist is an ultra fast list data structures written in Rust with Python bindings
 
 
 ### Requirements
-Python: 3.6+  
+Python: 3.7+  
 OS: Linux or MacOS
 
 
@@ -29,7 +30,7 @@ Run `pip install ulist`
 ```Python
 import ulist as ul
 
-arr = ul.from_iter([1.0, 2.0, 3.0, 2.0, 4.0, 5.0], dtype="float")
+arr = ul.from_seq([1.0, 2.0, 3.0, 2.0, 4.0, 5.0], dtype="float")
 result = arr.unique().mean()
 print(result)
 ```
@@ -39,8 +40,8 @@ print(result)
 ```Python
 import ulist as ul
 
-arr1 = ul.from_iter(range(1, 4), dtype="int")
-arr2 = ul.from_iter(range(1, 4), dtype="int")
+arr1 = ul.arange(1, 4)
+arr2 = ul.arange(1, 4)
 result = arr1.mul(arr2).sum()
 print(result)
 ```
@@ -50,7 +51,7 @@ print(result)
 ```Python
 import ulist as ul
 
-arr = ul.from_iter([1, 2, 3, 4, 5], dtype="float")
+arr = ul.from_seq([1, 2, 3, 4, 5], dtype="float")
 result = arr.sub_scala(arr.mean()).to_list()
 print(result)
 ```
@@ -60,7 +61,7 @@ print(result)
 ```Python
 import ulist as ul
 
-arr = ul.from_iter([1, 2, 3], dtype="float")
+arr = ul.from_seq([1, 2, 3], dtype="float")
 result = ((arr - arr.mean()) ** 2).mean()
 print(result)
 ```
@@ -72,7 +73,9 @@ print(result)
 * `zip` method for `List` and `ListPair` class
 * `agg` method for `ListPair`
 * `StringList` or `BytesList` class
-* More construction methods for `List`, such as `from_str`, `from_iter` `zeros`, `ones`, `empty` and `arrange`
+* Support Windows users
+* Doctest to check examples in Docstrings
+* Inplace and non-inplace mode
 * Support missing values
 * Airspeed velocity to benchmark
 * Further optimizing the benchmark with SIMD

tests/test_base.py

@@ -13,24 +13,40 @@
     "test_method, dtype, nums, expected_value",
     [
         (
-            "__str__",
+            "__repr__",
             "bool",
             [True, False] * 50,
             "UltraFastList([True, False, True, ..., False, True, False])",
         ),
-        ('__str__', 'bool', [True, False], 'UltraFastList([True, False])'),
-        ('__str__', 'float', [1.0, 2.0], 'UltraFastList([1.0, 2.0])'),
-        ('__str__', 'float', range(0, 100),
+        ('__repr__', 'bool', [True, False], 'UltraFastList([True, False])'),
+        ('__repr__', 'float', [1.0, 2.0], 'UltraFastList([1.0, 2.0])'),
+        ('__repr__', 'float', range(0, 100),
          'UltraFastList([0.0, 1.0, 2.0, ..., 97.0, 98.0, 99.0])'),
-        ('__str__', 'int', [1, 2], 'UltraFastList([1, 2])'),
-        ('__str__', 'int', range(0, 100),
+        ('__repr__', 'int', [1, 2], 'UltraFastList([1, 2])'),
+        ('__repr__', 'int', range(0, 100),
          'UltraFastList([0, 1, 2, ..., 97, 98, 99])'),
+
+        (
+            "__str__",
+            "bool",
+            [True, False] * 50,
+            "[True, False, True, ..., False, True, False]",
+        ),
+        ('__str__', 'bool', [True, False], '[True, False]'),
+        ('__str__', 'float', [1.0, 2.0], '[1.0, 2.0]'),
+        ('__str__', 'float', range(0, 100),
+         '[0.0, 1.0, 2.0, ..., 97.0, 98.0, 99.0]'),
+        ('__str__', 'int', [1, 2], '[1, 2]'),
+        ('__str__', 'int', range(0, 100), '[0, 1, 2, ..., 97, 98, 99]'),
+
         ('copy', 'bool', [True, False], [True, False]),
         ('copy', 'float', [1.0, 2.0], [1.0, 2.0]),
         ('copy', 'int', [1, 2], [1, 2]),
+
         ('size', 'bool', [True, False], 2),
         ('size', 'float', [1.0, 2.0], 2),
         ('size', 'int', [1, 2], 2),
+
         ('to_list', 'bool', [True, False], [True, False]),
         ('to_list', 'bool', [True, False], [True, False]),
         ('to_list', 'float', [1.0, 2.0], [1.0, 2.0]),
@@ -43,7 +59,7 @@ def test_methods_no_arg(
     nums: LIST_TYPE,
     expected_value: NUM_OR_LIST_TYPE,
 ):
-    arr = ul.from_iter(nums, dtype)
+    arr = ul.from_seq(nums, dtype)
     result = getattr(arr, test_method)()
     check_test_result(dtype, test_method, result, expected_value)
 
@@ -54,6 +70,7 @@ def test_methods_no_arg(
         ('__getitem__', 'bool', [True, False, True], True, {'index': 2}),
         ('__getitem__', 'float', [1.0, 2.0, 3.0], 2.0, {'index': 1}),
         ('__getitem__', 'int', [1, 2, 3], 1, {'index': 0}),
+
         ('get', 'bool', [True, False, True], True, {'index': 2}),
         ('get', 'float', [1.0, 2.0, 3.0], 2.0, {'index': 1}),
         ('get', 'int', [1, 2, 3], 1, {'index': 0}),
@@ -66,7 +83,7 @@ def test_methods_with_args(
     expected_value: NUM_OR_LIST_TYPE,
     kwargs: dict,
 ):
-    arr = ul.from_iter(nums, dtype)
+    arr = ul.from_seq(nums, dtype)
     result = getattr(arr, test_method)(**kwargs)
     check_test_result(dtype, test_method, result, expected_value)
 
@@ -79,17 +96,21 @@ def test_methods_with_args(
         ('__setitem__', 'float', [1.0, 2.0], [
          1.0, 3.0], {'index': 1, 'num': 3.0}),
         ('__setitem__', 'int', [1, 2], [1, 3], {'index': 1, 'num': 3}),
+
         ('append', 'bool', [True], [True, False], {'num': False}),
         ('append', 'float', [1.0], [1.0, 2.0], {'num': 2.0}),
         ('append', 'int', [1], [1, 2], {'num': 2}),
+
         ('pop', 'bool', [True, False], [True], {}),
         ('pop', 'float', [1.0, 2.0], [1.0], {}),
         ('pop', 'int', [1, 2], [1], {}),
+
         ('replace', 'bool', [True, False, True], [
          False, False, False], {'old': True, 'new': False}),
         ('replace', 'float', [1.0, 0.0, 1.0], [
          0.0, 0.0, 0.0], {'old': 1.0, 'new': 0.0}),
         ('replace', 'int', [1, 0, 1], [0, 0, 0], {'old': 1, 'new': 0}),
+
         ('set', 'bool', [True, False], [
          True, True], {'index': 1, 'num': True}),
         ('set', 'float', [1.0, 2.0], [1.0, 3.0], {'index': 1, 'num': 3.0}),
@@ -103,7 +124,7 @@ def test_multable_methods(
     expected_value: LIST_TYPE,
     kwargs: dict,
 ):
-    arr = ul.from_iter(nums, dtype)
+    arr = ul.from_seq(nums, dtype)
     getattr(arr, test_method)(**kwargs)
     check_test_result(dtype, test_method, arr, expected_value)
 
@@ -126,7 +147,7 @@ def test_indexing_operations(
     num = kwargs["num"]
     # Set
     test_method = "set-item"
-    arr = ul.from_iter(nums, dtype)
+    arr = ul.from_seq(nums, dtype)
     arr[index] = num
     check_test_result(dtype, test_method, arr, expected_value)
 

tests/test_boolean.py

@@ -24,6 +24,7 @@
             [True, True, True],
             True,
         ),
+
         (
             "any",
             [False, False, False],
@@ -39,6 +40,7 @@
             [True, True, True],
             True,
         ),
+
         (
             "not_",
             [True, False],
@@ -52,7 +54,7 @@ def test_methods(
     expected_value: Union[bool, List[bool]],
 ):
     dtype = "bool"
-    arr = ul.from_iter(nums, dtype=dtype)
+    arr = ul.from_seq(nums, dtype=dtype)
     result = getattr(arr, test_method)()
     check_test_result(dtype, test_method, result, expected_value)
 
@@ -81,8 +83,8 @@ def test_methods_with_args(
     expected_value: List[bool],
 ):
     dtype = "bool"
-    arr1 = ul.from_iter(nums, dtype=dtype)
-    arr2 = ul.from_iter(other, dtype=dtype)
+    arr1 = ul.from_seq(nums, dtype=dtype)
+    arr2 = ul.from_seq(other, dtype=dtype)
     result = getattr(arr1, test_method)(arr2)
     check_test_result(dtype, test_method, result, expected_value)
 
@@ -117,9 +119,9 @@ def test_operators(
     expected_value: List[bool],
 ):
     dtype = "bool"
-    arr1 = ul.from_iter(nums, dtype)
+    arr1 = ul.from_seq(nums, dtype)
     if other is not None:
-        arr2 = ul.from_iter(other, dtype)
+        arr2 = ul.from_seq(other, dtype)
         result = test_method(arr1, arr2)
     else:
         result = test_method(arr1)

tests/test_constructor.py

@@ -0,0 +1,58 @@
+from typing import Callable, List
+
+import pytest
+import ulist as ul
+from ulist.utils import check_test_result
+
+
+@pytest.mark.parametrize(
+    "test_method, args, kwargs, expected_value",
+    [
+        (ul.arange, (3,), {}, [0, 1, 2],),
+        (ul.arange, (0, 3,), {}, [0, 1, 2],),
+        (ul.arange, (0, 4, 2,), {}, [0, 2],),
+        (ul.arange, (0, 5, 2,), {}, [0, 2, 4],),
+        (ul.arange, (), {"start": 3}, [0, 1, 2],),
+        (ul.arange, (), {"start": 0, "stop": 3}, [0, 1, 2],),
+        (ul.arange, (), {"start": 5, "step": 2}, [0, 2, 4],),
+        (ul.arange, (), {"start": 0, "stop": 5, "step": 2}, [0, 2, 4],),
+        (ul.arange, (5,), {"step": 2}, [0, 2, 4],),
+        (ul.arange, (0,), {"stop": 5, "step": 2}, [0, 2, 4],),
+
+        (ul.repeat, (0, 3), {}, [0, 0, 0],),
+        (ul.repeat, (1.0, 3), {}, [1.0, 1.0, 1.0],),
+        (ul.repeat, (False, 3), {}, [False, False, False],),
+
+        (ul.from_seq, (range(3), "int"), {}, [0, 1, 2],),
+        (ul.from_seq, (range(3), "float"), {}, [0.0, 1.0, 2.0],),
+        (ul.from_seq, ([False, True], "bool"), {}, [False, True],),
+        (ul.from_seq, ([0, 1, 2], "int"), {}, [0, 1, 2],),
+        (ul.from_seq, ((0, 1, 2), "int"), {}, [0, 1, 2],),
+
+        (ul.cycle, (range(3), 1, 'int'), {}, [0],),
+        (ul.cycle, (range(3), 2, 'int'), {}, [0, 1],),
+        (ul.cycle, (range(3), 3, 'int'), {}, [0, 1, 2],),
+        (ul.cycle, (range(3), 4, 'int'), {}, [0, 1, 2, 0],),
+        (ul.cycle, (range(3), 5, 'int'), {}, [0, 1, 2, 0, 1],),
+        (ul.cycle, (range(3), 6, 'int'), {}, [0, 1, 2, 0, 1, 2],),
+        (ul.cycle, ([0.0, 1.0], 3, 'float'), {}, [0.0, 1.0, 0.0],),
+        (ul.cycle, ((True, False), 3, 'bool'), {}, [True, False, True],),
+
+    ],
+)
+def test_constructors(
+    test_method: Callable,
+    args: tuple,
+    kwargs: dict,
+    expected_value: List[bool],
+):
+    result = test_method(*args, **kwargs)
+    if type(expected_value[0]) == int:
+        dtype = "int"
+    elif type(expected_value[0]) == float:
+        dtype = "float"
+    elif type(expected_value[0]) == bool:
+        dtype = "bool"
+    else:
+        raise TypeError(f"Unexpected type {type(expected_value[0])}!")
+    check_test_result(dtype, test_method, result, expected_value)

tests/test_integer.py

@@ -42,7 +42,7 @@ def test_methods(
     kwargs: dict,
 ):
     dtype = "int"
-    arr = ul.from_iter(nums, dtype=dtype)
+    arr = ul.from_seq(nums, dtype=dtype)
     result = getattr(arr, test_method)(**kwargs).to_list()
     check_test_result(dtype, test_method, result, expected_value)
 
@@ -63,9 +63,9 @@ def test_operators(
     kwargs: dict,
 ):
     dtype = "int"
-    arr = ul.from_iter(nums, dtype)
+    arr = ul.from_seq(nums, dtype)
     if isinstance(kwargs["other"], list):
-        other = ul.from_iter(kwargs["other"], dtype)
+        other = ul.from_seq(kwargs["other"], dtype)
     else:
         other = kwargs["other"]
     result = test_method(arr, other)