iterflat 0.0.0.dev0__tar.gz → 0.1.0__tar.gz

{iterflat-0.0.0.dev0/src/iterflat.egg-info → iterflat-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iterflat
-Version: 0.0.0.dev0
+Version: 0.1.0
 Summary: iterflat
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
@@ -27,7 +27,8 @@ License: The MIT License (MIT)
 Project-URL: Download, https://pypi.org/project/iterflat/#files
 Project-URL: Index, https://pypi.org/project/iterflat/
 Project-URL: Source, https://github.com/johannes-programming/iterflat/
-Classifier: Development Status :: 1 - Planning
+Project-URL: Website, https://iterflat.johannes-programming.online/
+Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent

{iterflat-0.0.0.dev0 → iterflat-0.1.0}/pyproject.toml

@@ -9,7 +9,7 @@ authors = [
     { email = "johannes.programming@gmail.com", name = "Johannes" },
 ]
 classifiers = [
-    "Development Status :: 1 - Planning",
+    "Development Status :: 3 - Alpha",
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
@@ -24,7 +24,7 @@ keywords = []
 name = "iterflat"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "0.0.0.dev0"
+version = "0.1.0"
 
 [project.license]
 file = "LICENSE.txt"
@@ -33,3 +33,4 @@ file = "LICENSE.txt"
 Download = "https://pypi.org/project/iterflat/#files"
 Index = "https://pypi.org/project/iterflat/"
 Source = "https://github.com/johannes-programming/iterflat/"
+Website = "https://iterflat.johannes-programming.online/"

{iterflat-0.0.0.dev0 → iterflat-0.1.0}/src/iterchain/__init__.py

@@ -1,5 +1,2 @@
 from iterflat.core import *
 from iterflat.tests import *
-
-if __name__ == "__main__":
-    main()

iterflat-0.1.0/src/iterchain/core/__init__.py

@@ -0,0 +1,21 @@
+import operator
+from typing import *
+
+__all__ = ["iterflat"]
+
+
+def iterflat(data: Any, *, depth: SupportsIndex = 1) -> Generator[Any, None, None]:
+    n: int
+    x: Iterable
+    n = operator.index(depth)
+    if n < -1:
+        yield iterflat(data, depth=n + 1)
+        return
+    if n == -1:
+        yield data
+        return
+    if n == 0:
+        yield from data
+        return
+    for x in data:
+        yield from iterflat(x, depth=n - 1)

iterflat-0.1.0/src/iterchain/tests/test_0.py

@@ -0,0 +1,80 @@
+import types
+import unittest
+
+from iterflat.core import iterflat
+
+
+class TestIterflat(unittest.TestCase):
+    def test_depth_1_flattens_one_level(self):
+        data = [[1, 2], [3], []]
+        self.assertEqual(list(iterflat(data, depth=1)), [1, 2, 3])
+
+    def test_depth_2_flattens_two_levels(self):
+        data = [[[1], [2, 3]], [[4]], []]
+        self.assertEqual(list(iterflat(data, depth=2)), [1, 2, 3, 4])
+
+    def test_inv(self):
+        data = [[[1], [2, 3]], [[4]], []]
+        for n in range(5):
+            self.assertEqual(list(iterflat(iterflat(data, depth=-n), depth=n)), data)
+
+    def test_depth_0_iterates_input(self):
+        data = (1, 2, 3)
+        self.assertEqual(list(iterflat(data, depth=0)), [1, 2, 3])
+
+    def test_depth_minus_1_yields_data_as_single_element(self):
+        data = [1, 2, 3]
+        out = list(iterflat(data, depth=-1))
+        self.assertEqual(out, [data])  # data yielded as a single item
+
+    def test_depth_less_than_minus_1_wraps_again(self):
+        data = [1, 2]
+        out = list(iterflat(data, depth=-2))
+        # Should yield exactly one element, which itself is a generator
+        self.assertEqual(len(out), 1)
+        self.assertIsInstance(out[0], types.GeneratorType)
+        # Iterating that inner generator should give [data]
+        inner = list(out[0])
+        self.assertEqual(inner, [data])
+
+    def test_supports_index_custom_type(self):
+        class DepthLike:
+            def __index__(self):
+                return 1  # act like depth=1
+
+        data = [[10], [20, 30]]
+        self.assertEqual(list(iterflat(data, depth=DepthLike())), [10, 20, 30])
+
+    def test_generator_input_with_depth_0(self):
+        def gen():
+            for i in range(3):
+                yield i
+
+        self.assertEqual(list(iterflat(gen(), depth=0)), [0, 1, 2])
+
+    def test_strings(self):
+        # depth=0 iterates the string
+        self.assertEqual(list(iterflat("ab", depth=0)), ["a", "b"])
+        # depth=-1 treats the whole string as a single element
+        self.assertEqual(list(iterflat("ab", depth=-1)), ["ab"])
+        # depth=1 over a list of strings flattens one level into characters
+        self.assertEqual(list(iterflat(["ab", "c"], depth=1)), ["a", "b", "c"])
+
+    def test_type_error_when_nested_item_not_iterable_for_positive_depth(self):
+        # For depth=1, inner items must be iterable; ints are not, so this should raise
+        with self.assertRaises(TypeError):
+            list(iterflat([1, 2], depth=1))
+
+    def test_empty_input(self):
+        self.assertEqual(list(iterflat([], depth=0)), [])
+        self.assertEqual(list(iterflat([], depth=1)), [])
+        self.assertEqual(list(iterflat([], depth=2)), [])
+
+    def test_large_depth_exact(self):
+        # Perfectly nested 3 levels
+        data = [[[[1], [2]], [[3]]]]
+        self.assertEqual(list(iterflat(data, depth=3)), [1, 2, 3])
+
+
+if __name__ == "__main__":
+    unittest.main()

{iterflat-0.0.0.dev0 → iterflat-0.1.0/src/iterflat.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iterflat
-Version: 0.0.0.dev0
+Version: 0.1.0
 Summary: iterflat
 Author-email: Johannes <johannes.programming@gmail.com>
 License: The MIT License (MIT)
@@ -27,7 +27,8 @@ License: The MIT License (MIT)
 Project-URL: Download, https://pypi.org/project/iterflat/#files
 Project-URL: Index, https://pypi.org/project/iterflat/
 Project-URL: Source, https://github.com/johannes-programming/iterflat/
-Classifier: Development Status :: 1 - Planning
+Project-URL: Website, https://iterflat.johannes-programming.online/
+Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent

{iterflat-0.0.0.dev0 → iterflat-0.1.0}/src/iterflat.egg-info/SOURCES.txt

@@ -4,10 +4,9 @@ README.rst
 pyproject.toml
 setup.cfg
 src/iterchain/__init__.py
-src/iterchain/__main__.py
 src/iterchain/core/__init__.py
 src/iterchain/tests/__init__.py
-src/iterchain/tests/test_1984.py
+src/iterchain/tests/test_0.py
 src/iterflat.egg-info/PKG-INFO
 src/iterflat.egg-info/SOURCES.txt
 src/iterflat.egg-info/dependency_links.txt

iterflat-0.0.0.dev0/src/iterchain/__main__.py

@@ -1,4 +0,0 @@
-from iterflat import main
-
-if __name__ == "__main__":
-    main()

iterflat-0.0.0.dev0/src/iterchain/core/__init__.py

@@ -1,8 +0,0 @@
-from typing import *
-
-__all__ = ["main"]
-
-
-def main(args: Optional[Iterable] = None) -> None:
-    "This function prints 'Hello World!'."
-    print("Hello World!")

iterflat-0.0.0.dev0/src/iterchain/tests/test_1984.py

@@ -1,11 +0,0 @@
-import unittest
-from typing import *
-
-
-class Test1984(unittest.TestCase):
-    def test_1984(self: Self) -> None:
-        self.assertEqual(2 + 2, 4, "Ignorance is Strength")
-
-
-if __name__ == "__main__":
-    unittest.main()