mbern_refactor_rename_to_iter (#75)

.cookiecutter.json

@@ -6,12 +6,12 @@
     "author": "Martin Bernstorff",
     "copyright_year": "2023",
     "email": "martinbernstorff@gmail.com",
-    "friendly_name": "FunctionalPy",
-    "github_repo": "FunctionalPy",
+    "friendly_name": "Iter",
+    "github_repo": "Iter",
     "github_user": "MartinBernstorff",
     "license": "MIT",
-    "package_name": "FunctionalPy",
-    "project_name": "FunctionalPy",
+    "package_name": "Iter",
+    "project_name": "Iter",
     "release_to_pypi": "yes",
     "version": "0.0.0"
 }

.cruft.json

@@ -4,13 +4,13 @@
   "checkout": null,
   "context": {
     "cookiecutter": {
-      "project_name": "FunctionalPy",
-      "package_name": "FunctionalPy",
-      "friendly_name": "FunctionalPy",
+      "project_name": "Iter",
+      "package_name": "Iter",
+      "friendly_name": "Iter",
       "author": "Martin Bernstorff",
       "email": "martinbernstorff@gmail.com",
       "github_user": "MartinBernstorff",
-      "github_repo": "FunctionalPy",
+      "github_repo": "Iter",
       "version": "0.0.0",
       "copyright_year": "2023",
       "release_to_pypi": "no",
@@ -22,4 +22,4 @@
     }
   },
   "directory": null
-}
+}

.devcontainer/devcontainer.json

@@ -7,7 +7,7 @@
         "context": "..",
         // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
         "dockerfile": "../Dockerfile",
-        "cacheFrom": "ghcr.io/martinbernstorff/functionalpy-devcontainer:latest"
+        "cacheFrom": "ghcr.io/martinbernstorff/iter-devcontainer:latest"
     },
     // "features": {},
     "customizations": {

.github/workflows/tests.yml

@@ -35,8 +35,8 @@ jobs:
       - name: Pre-build dev container image
         uses: devcontainers/ci@v0.3
         with:
-          imageName: ghcr.io/martinbernstorff/functionalpy-devcontainer
-          cacheFrom: ghcr.io/martinbernstorff/functionalpy-devcontainer:latest
+          imageName: ghcr.io/martinbernstorff/iter-devcontainer
+          cacheFrom: ghcr.io/martinbernstorff/iter-devcontainer:latest
           push: filter
           refFilterForPush: refs/heads/main
           runCmd:

.gitignore

@@ -18,4 +18,4 @@ build/
 
 # MacOS
 .DS_Store
-functionalpy.egg-info
+iter.egg-info

CONTRIBUTING.md

@@ -12,9 +12,9 @@ Here is a list of important resources for contributors:
 - [Code of Conduct]
 
 [mit license]: https://opensource.org/licenses/MIT
-[source code]: https://github.com/MartinBernstorff/FunctionalPy
-[documentation]: https://functionalpy.readthedocs.io/
-[issue tracker]: https://github.com/MartinBernstorff/FunctionalPy/issues
+[source code]: https://github.com/MartinBernstorff/Iter
+[documentation]: https://iter.readthedocs.io/
+[issue tracker]: https://github.com/MartinBernstorff/Iter/issues
 
 ## How to report a bug
 
@@ -77,7 +77,7 @@ $ nox --session=pre-commit -- install
 It is recommended to open an issue before starting work on anything.
 This will allow a chance to talk it over with the owners and validate your approach.
 
-[pull request]: https://github.com/MartinBernstorff/FunctionalPy/pulls
+[pull request]: https://github.com/MartinBernstorff/Iter/pulls
 
 <!-- github-only -->
 

Makefile

@@ -1,4 +1,4 @@
-SRC_PATH = functionalpy
+SRC_PATH = iter
 MAKEFLAGS = --no-print-directory
 
 install-dev:

README.md

@@ -1,23 +1,23 @@
-# FunctionalPy
+# Iter
 [![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)][dev container]
-[![PyPI](https://img.shields.io/pypi/v/functionalpy.svg)][pypi status]
-[![Python Version](https://img.shields.io/pypi/pyversions/FunctionalPy)][pypi status]
-[![Tests](https://github.com/MartinBernstorff/FunctionalPy/actions/workflows/tests.yml/badge.svg)][tests]
+[![PyPI](https://img.shields.io/pypi/v/iter.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/Iter)][pypi status]
+[![Tests](https://github.com/MartinBernstorff/Iter/actions/workflows/tests.yml/badge.svg)][tests]
 
-[pypi status]: https://pypi.org/project/FunctionalPy/
-[tests]: https://github.com/MartinBernstorff/FunctionalPy/actions?workflow=Tests
-[dev container]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/MartinBernstorff/FunctionalPy/
+[pypi status]: https://pypi.org/project/Iter/
+[tests]: https://github.com/MartinBernstorff/Iter/actions?workflow=Tests
+[dev container]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/MartinBernstorff/Iter/
 
 
 <!-- start short-description -->
 **ALPHA**: APIs can change dramatically without notice.
 
-Python has implemented `map`, `filter` etc. as functions, rather than methods on a sequence. This makes the result harder to read and Iterators less used than they could be. FunctionalPy exists to change that. 
+Python has implemented `map`, `filter` etc. as functions, rather than methods on a sequence. This makes the result harder to read and Iterators less used than they could be. Iter exists to change that. 
 
 You get this 🔥:
 
 ```python
-result = (Seq([1,2,3])
+result = (Iter([1,2,3])
             .map(multiply_by_2)
             .filter(is_even))
 ```
@@ -39,14 +39,14 @@ result = filter(is_even, map(multiply_by_2, [1,2,3]))
 
 ## Install
 ```bash
-pip install functionalpy
+pip install iterpy
 ```
 
 ## Usage
 ```python
-from functionalpy import Seq
+from iter import Seq
 
-result = (Seq([1, 2])
+result = (Iter([1, 2])
             .filter(lambda x: x % 2 == 0)
             .map(lambda x: x * 2)
             .to_list()
@@ -55,7 +55,7 @@ assert result == [4]
 ```
 
 ## Prior art
-FunctionalPy stands on the shoulders of Scala, Rust etc. 
+Iter stands on the shoulders of Scala, Rust etc. 
 
 Other Python projects have had similar ideas:
 * [PyFunctional](https://github.com/EntilZha/PyFunctional) has existed for 7+ years with a comprehensive feature set. It is performant, with built-in lineage and caching. Unfortunately, this makes typing [non-trivial, with a 4+ year ongoing effort to add types](https://github.com/EntilZha/PyFunctional/issues/118).
@@ -83,7 +83,7 @@ In cases where this conflicts with typical python implementations, the API shoul
 #### Devcontainer
 1. Install [Orbstack](https://orbstack.dev/) or Docker Desktop. Make sure to complete the full install process before continuing.
 2. If not installed, install VSCode
-3. Press this [link](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/MartinBernstorff/FunctionalPy/)
+3. Press this [link](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/MartinBernstorff/Iter/)
 4. Complete the setup process
 5. Done! Easy as that.
 
@@ -96,7 +96,7 @@ In cases where this conflicts with typical python implementations, the API shoul
 | 👩‍💻 **Usage Questions**          | [GitHub Discussions]   |
 | 🗯 **General Discussion**       | [GitHub Discussions]   |
 
-[github issue tracker]: https://github.com/MartinBernstorff/FunctionalPy/issues
-[github discussions]: https://github.com/MartinBernstorff/FunctionalPy/discussions
+[github issue tracker]: https://github.com/MartinBernstorff/Iter/issues
+[github discussions]: https://github.com/MartinBernstorff/Iter/discussions
 
 

functionalpy.egg-info/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.1
+Name: functionalpy
+Version: 0.16.0
+Summary: functionalpy
+Author-email: Martin Bernstorff <martinbernstorff@gmail.com>
+License: MIT License
+
+        Copyright © 2023 Martin Bernstorff
+
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+
+Project-URL: homepage, https://github.com/MartinBernstorff/FunctionalPy
+Project-URL: repository, https://github.com/MartinBernstorff/FunctionalPy
+Project-URL: documentation, https://MartinBernstorff.github.io/FunctionalPy/
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: linetimer
+Requires-Dist: polars
+Provides-Extra: dev
+Requires-Dist: cruft==2.15.0; extra == "dev"
+Requires-Dist: pyright==1.1.344; extra == "dev"
+Requires-Dist: pytest==7.4.4; extra == "dev"
+Requires-Dist: pytest-cov==4.1.0; extra == "dev"
+Requires-Dist: pytest-xdist==3.5.0; extra == "dev"
+Requires-Dist: pytest-sugar==0.9.7; extra == "dev"
+Requires-Dist: diff-cover==8.0.2; extra == "dev"
+Requires-Dist: ruff==0.1.9; extra == "dev"
+
+# FunctionalPy
+[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)][dev container]
+[![PyPI](https://img.shields.io/pypi/v/functionalpy.svg)][pypi status]
+[![Python Version](https://img.shields.io/pypi/pyversions/FunctionalPy)][pypi status]
+[![Tests](https://github.com/MartinBernstorff/FunctionalPy/actions/workflows/tests.yml/badge.svg)][tests]
+
+[pypi status]: https://pypi.org/project/FunctionalPy/
+[tests]: https://github.com/MartinBernstorff/FunctionalPy/actions?workflow=Tests
+[dev container]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/MartinBernstorff/FunctionalPy/
+
+
+<!-- start short-description -->
+**ALPHA**: APIs can change dramatically without notice.
+
+Python has implemented `map`, `filter` etc. as functions, rather than methods on a sequence. This makes the result harder to read and Iterators less used than they could be. FunctionalPy exists to change that. 
+
+You get this 🔥:
+
+```python
+result = (Seq([1,2,3])
+            .map(multiply_by_2)
+            .filter(is_even))
+```
+
+Instead of this:
+
+```python
+sequence = [1,2,3]
+multiplied = [multiply_by_2(x) for x in sequence]
+result = [x for x in multiplied if is_even(x)]
+```
+
+Or this:
+
+```python
+result = filter(is_even, map(multiply_by_2, [1,2,3]))
+```
+<!-- end short-description -->
+
+## Install
+```bash
+pip install functionalpy
+```
+
+## Usage
+```python
+from functionalpy import Seq
+
+result = (Seq([1, 2])
+            .filter(lambda x: x % 2 == 0)
+            .map(lambda x: x * 2)
+            .to_list()
+)
+assert result == [4]
+```
+
+## Prior art
+FunctionalPy stands on the shoulders of Scala, Rust etc. 
+
+Other Python projects have had similar ideas:
+* [PyFunctional](https://github.com/EntilZha/PyFunctional) has existed for 7+ years with a comprehensive feature set. It is performant, with built-in lineage and caching. Unfortunately, this makes typing [non-trivial, with a 4+ year ongoing effort to add types](https://github.com/EntilZha/PyFunctional/issues/118).
+* [flupy](https://github.com/olirice/flupy) is highly similar, well typed, and mature. I had some issues with `.flatten()` not being type-hinted correctly, but at the current level of maturity, `flupy` is likely a better library.
+* Your library here? Feel free to make an issue if you have a good alternative!
+
+## Contributing
+### Conventions
+#### Philosophy
+* Make it work: Concise syntax borrowed from Scala, Rust etc.
+* Make it right: Fully typed, no exceptions
+* Make it fast: 
+    * Concurrency through `.pmap`
+    * (Future): Caching
+    * (Future): Refactor operations to use generators
+* Keep it simple: No dependencies
+
+#### API design
+As a heuristic, we follow the APIs of:
+* Rust's [std::iter](https://doc.rust-lang.org/stable/std/iter/)
+* Rust's [itertools](https://docs.rs/itertools/latest/itertools/index.html)
+
+In cases where this conflicts with typical python implementations, the API should be as predictable as possible for Python users.
+
+#### Devcontainer
+1. Install [Orbstack](https://orbstack.dev/) or Docker Desktop. Make sure to complete the full install process before continuing.
+2. If not installed, install VSCode
+3. Press this [link](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/MartinBernstorff/FunctionalPy/)
+4. Complete the setup process
+5. Done! Easy as that.
+
+## 💬 Where to ask questions
+
+| Type                           |                        |
+| ------------------------------ | ---------------------- |
+| 🚨 **Bug Reports**              | [GitHub Issue Tracker] |
+| 🎁 **Feature Requests & Ideas** | [GitHub Issue Tracker] |
+| 👩‍💻 **Usage Questions**          | [GitHub Discussions]   |
+| 🗯 **General Discussion**       | [GitHub Discussions]   |
+
+[github issue tracker]: https://github.com/MartinBernstorff/FunctionalPy/issues
+[github discussions]: https://github.com/MartinBernstorff/FunctionalPy/discussions
+
+

functionalpy.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+.cookiecutter.json
+.cruft.json
+.gitignore
+.pre-commit-config.yaml
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+Dockerfile
+LICENSE
+Makefile
+README.md
+pyproject.toml
+.devcontainer/devcontainer.json
+.github/dependabot.yml
+.github/recommended_repo_setup.md
+.github/workflows/check_for_rej.yml
+.github/workflows/dependabot.yml
+.github/workflows/dependabot_automerge.yml
+.github/workflows/release.yml
+.github/workflows/stalebot.yml
+.github/workflows/tests.yml
+functionalpy/__init__.py
+functionalpy/_sequence.py
+functionalpy/_sequence.pyi
+functionalpy/py.typed
+functionalpy/test_sequence.py
+functionalpy.egg-info/PKG-INFO
+functionalpy.egg-info/SOURCES.txt
+functionalpy.egg-info/dependency_links.txt
+functionalpy.egg-info/requires.txt
+functionalpy.egg-info/top_level.txt
+functionalpy/benchmark/utils.py
+functionalpy/benchmark/query_1/input_data.py
+functionalpy/benchmark/query_1/iterators_q1.py
+functionalpy/benchmark/query_1/polars_q1.py

functionalpy.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

functionalpy.egg-info/requires.txt

@@ -0,0 +1,12 @@
+linetimer
+polars
+
+[dev]
+cruft==2.15.0
+pyright==1.1.344
+pytest==7.4.4
+pytest-cov==4.1.0
+pytest-xdist==3.5.0
+pytest-sugar==0.9.7
+diff-cover==8.0.2
+ruff==0.1.9

functionalpy.egg-info/top_level.txt

@@ -0,0 +1 @@
+functionalpy

iter/__init__.py

@@ -0,0 +1 @@
+from ._iter import Iter # noqa: F401 # type: ignore