| Name | flats JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Minimal library that enables flattening of nested instances of iterable containers. |
| upload_time | 2024-12-24 03:53:12 |
| maintainer | None |
| docs_url | None |
| author | Andrei Lapets |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=====
flats
=====
Minimal library that enables flattening of nested instances of iterable containers.
|pypi| |readthedocs| |actions| |coveralls|
.. |pypi| image:: https://badge.fury.io/py/flats.svg#
:target: https://badge.fury.io/py/flats
:alt: PyPI version and link.
.. |readthedocs| image:: https://readthedocs.org/projects/flats/badge/?version=latest
:target: https://flats.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.
.. |actions| image:: https://github.com/lapets/flats/workflows/lint-test-cover-docs/badge.svg#
:target: https://github.com/lapets/flats/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.
.. |coveralls| image:: https://coveralls.io/repos/github/lapets/flats/badge.svg?branch=main
:target: https://coveralls.io/github/lapets/flats?branch=main
:alt: Coveralls test coverage summary.
Purpose
-------
This library provides a function for flattening `iterable <https://docs.python.org/3/glossary.html#term-iterable>`__ data structure instances that may be nested (*i.e.*, that contain iterables). The depth up to which flattening occurs can be specified.
Installation and Usage
----------------------
This library is available as a `package on PyPI <https://pypi.org/project/flats>`__:
.. code-block:: bash
python -m pip install flats
The library can be imported in the usual ways:
.. code-block:: python
import flats
from flats import flats
Examples
^^^^^^^^
.. |Iterable| replace:: ``Iterable``
.. _Iterable: https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable
.. |Generator| replace:: ``Generator``
.. _Generator: https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator
This library provides a function that can flatten any instance of a container type that is the root of a tree of nested instances of container types, returning as an iterable the sequence of all objects or values (that are not of a container type) encountered during an in-order traversal. Any instance of the |Iterable|_ class or the |Generator|_ class is considered to be an instance of a container type by this library:
.. code-block:: python
>>> from flats import flats
>>> list(flats([[1, 2, 3], [4, 5, 6, 7]]))
[1, 2, 3, 4, 5, 6, 7]
The nested instances need not be of the same type:
.. code-block:: python
>>> tuple(flats([{1}, {2}, {3}, frozenset({4}), iter([5, 6, 7])]))
(1, 2, 3, 4, 5, 6, 7)
>>> list(flats(['abc', 'xyz']))
['a', 'b', 'c', 'x', 'y', 'z']
>>> list(flats([range(3), range(3)]))
[0, 1, 2, 0, 1, 2]
It is also possible to limit the depth to which nested instances of a container type are recursively traversed during the flattening process (leaving unmodified the nesting of any instances that are found at a greater depth):
.. code-block:: python
>>> list(flats([[[1, 2], 3], [4, 5, 6, 7]], depth=1))
[[1, 2], 3, 4, 5, 6, 7]
>>> list(flats([[[1, 2], 3], [4, 5, 6, 7]], depth=2))
[1, 2, 3, 4, 5, 6, 7]
>>> list(flats([[[1, [2]], 3], [4, [[[5]]], 6, 7]], depth=float('inf')))
[1, 2, 3, 4, 5, 6, 7]
Development
-----------
All installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:
.. code-block:: bash
python -m pip install ".[docs,lint]"
Documentation
^^^^^^^^^^^^^
The documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:
.. code-block:: bash
python -m pip install ".[docs]"
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html
Testing and Conventions
^^^^^^^^^^^^^^^^^^^^^^^
All unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):
.. code-block:: bash
python -m pip install ".[test]"
python -m pytest
Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:
.. code-block:: bash
python src/flats/flats.py -v
Style conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:
.. code-block:: bash
python -m pip install ".[lint]"
python -m pylint src/flats
Contributions
^^^^^^^^^^^^^
In order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/lapets/flats>`__ for this library.
Versioning
^^^^^^^^^^
Beginning with version 0.1.0, the version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`__.
Publishing
^^^^^^^^^^
This library can be published as a `package on PyPI <https://pypi.org/project/flats>`__ via the GitHub Actions workflow found in ``.github/workflows/build-publish-sign-release.yml`` that follows the `recommendations found in the Python Packaging User Guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`__.
Ensure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions.
To publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number):
.. code-block:: bash
git tag ?.?.?
git push origin ?.?.?
Raw data
{
"_id": null,
"home_page": null,
"name": "flats",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Andrei Lapets",
"author_email": "a@lapets.io",
"download_url": "https://files.pythonhosted.org/packages/0e/01/ee5603fc5eb0e06c73c592a44e2a9d250dd6c9ae6aaac08bdc670a169c2e/flats-1.0.0.tar.gz",
"platform": null,
"description": "=====\nflats\n=====\n\nMinimal library that enables flattening of nested instances of iterable containers.\n\n|pypi| |readthedocs| |actions| |coveralls|\n\n.. |pypi| image:: https://badge.fury.io/py/flats.svg#\n :target: https://badge.fury.io/py/flats\n :alt: PyPI version and link.\n\n.. |readthedocs| image:: https://readthedocs.org/projects/flats/badge/?version=latest\n :target: https://flats.readthedocs.io/en/latest/?badge=latest\n :alt: Read the Docs documentation status.\n\n.. |actions| image:: https://github.com/lapets/flats/workflows/lint-test-cover-docs/badge.svg#\n :target: https://github.com/lapets/flats/actions/workflows/lint-test-cover-docs.yml\n :alt: GitHub Actions status.\n\n.. |coveralls| image:: https://coveralls.io/repos/github/lapets/flats/badge.svg?branch=main\n :target: https://coveralls.io/github/lapets/flats?branch=main\n :alt: Coveralls test coverage summary.\n\nPurpose\n-------\nThis library provides a function for flattening `iterable <https://docs.python.org/3/glossary.html#term-iterable>`__ data structure instances that may be nested (*i.e.*, that contain iterables). The depth up to which flattening occurs can be specified.\n\nInstallation and Usage\n----------------------\nThis library is available as a `package on PyPI <https://pypi.org/project/flats>`__:\n\n.. code-block:: bash\n\n python -m pip install flats\n\nThe library can be imported in the usual ways:\n\n.. code-block:: python\n\n import flats\n from flats import flats\n\nExamples\n^^^^^^^^\n\n.. |Iterable| replace:: ``Iterable``\n.. _Iterable: https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable\n\n.. |Generator| replace:: ``Generator``\n.. _Generator: https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator\n\nThis library provides a function that can flatten any instance of a container type that is the root of a tree of nested instances of container types, returning as an iterable the sequence of all objects or values (that are not of a container type) encountered during an in-order traversal. Any instance of the |Iterable|_ class or the |Generator|_ class is considered to be an instance of a container type by this library:\n\n.. code-block:: python\n\n >>> from flats import flats\n >>> list(flats([[1, 2, 3], [4, 5, 6, 7]]))\n [1, 2, 3, 4, 5, 6, 7]\n\nThe nested instances need not be of the same type:\n\n.. code-block:: python\n\n >>> tuple(flats([{1}, {2}, {3}, frozenset({4}), iter([5, 6, 7])]))\n (1, 2, 3, 4, 5, 6, 7)\n >>> list(flats(['abc', 'xyz']))\n ['a', 'b', 'c', 'x', 'y', 'z']\n >>> list(flats([range(3), range(3)]))\n [0, 1, 2, 0, 1, 2]\n\nIt is also possible to limit the depth to which nested instances of a container type are recursively traversed during the flattening process (leaving unmodified the nesting of any instances that are found at a greater depth):\n\n.. code-block:: python\n\n >>> list(flats([[[1, 2], 3], [4, 5, 6, 7]], depth=1))\n [[1, 2], 3, 4, 5, 6, 7]\n >>> list(flats([[[1, 2], 3], [4, 5, 6, 7]], depth=2))\n [1, 2, 3, 4, 5, 6, 7]\n >>> list(flats([[[1, [2]], 3], [4, [[[5]]], 6, 7]], depth=float('inf')))\n [1, 2, 3, 4, 5, 6, 7]\n\nDevelopment\n-----------\nAll installation and development dependencies are fully specified in ``pyproject.toml``. The ``project.optional-dependencies`` object is used to `specify optional requirements <https://peps.python.org/pep-0621>`__ for various development tasks. This makes it possible to specify additional options (such as ``docs``, ``lint``, and so on) when performing installation using `pip <https://pypi.org/project/pip>`__:\n\n.. code-block:: bash\n\n python -m pip install \".[docs,lint]\"\n\nDocumentation\n^^^^^^^^^^^^^\nThe documentation can be generated automatically from the source files using `Sphinx <https://www.sphinx-doc.org>`__:\n\n.. code-block:: bash\n\n python -m pip install \".[docs]\"\n cd docs\n sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html\n\nTesting and Conventions\n^^^^^^^^^^^^^^^^^^^^^^^\nAll unit tests are executed and their coverage is measured when using `pytest <https://docs.pytest.org>`__ (see the ``pyproject.toml`` file for configuration details):\n\n.. code-block:: bash\n\n python -m pip install \".[test]\"\n python -m pytest\n\nAlternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`__:\n\n.. code-block:: bash\n\n python src/flats/flats.py -v\n\nStyle conventions are enforced using `Pylint <https://pylint.readthedocs.io>`__:\n\n.. code-block:: bash\n\n python -m pip install \".[lint]\"\n python -m pylint src/flats\n\nContributions\n^^^^^^^^^^^^^\nIn order to contribute to the source code, open an issue or submit a pull request on the `GitHub page <https://github.com/lapets/flats>`__ for this library.\n\nVersioning\n^^^^^^^^^^\nBeginning with version 0.1.0, the version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`__.\n\nPublishing\n^^^^^^^^^^\nThis library can be published as a `package on PyPI <https://pypi.org/project/flats>`__ via the GitHub Actions workflow found in ``.github/workflows/build-publish-sign-release.yml`` that follows the `recommendations found in the Python Packaging User Guide <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`__.\n\nEnsure that the correct version number appears in ``pyproject.toml``, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has an `automation rule <https://docs.readthedocs.io/en/stable/automation-rules.html>`__ that activates and sets as the default all tagged versions.\n\nTo publish the package, create and push a tag for the version being published (replacing ``?.?.?`` with the version number):\n\n.. code-block:: bash\n\n git tag ?.?.?\n git push origin ?.?.?\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Minimal library that enables flattening of nested instances of iterable containers.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://flats.readthedocs.io",
"Repository": "https://github.com/lapets/flats"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cbc18a6d3492e9cc9292f1772edff60ab6b47cd54c480c3d99451a7bc34ee45e",
"md5": "6f0e8ae930ad7e81f6138fb025fe1ff3",
"sha256": "63d1cf8f289ec779d52664bd52f031060e4a45b5bc0d5aa020bc54e76dc283d2"
},
"downloads": -1,
"filename": "flats-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f0e8ae930ad7e81f6138fb025fe1ff3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6435,
"upload_time": "2024-12-24T03:53:10",
"upload_time_iso_8601": "2024-12-24T03:53:10.302538Z",
"url": "https://files.pythonhosted.org/packages/cb/c1/8a6d3492e9cc9292f1772edff60ab6b47cd54c480c3d99451a7bc34ee45e/flats-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e01ee5603fc5eb0e06c73c592a44e2a9d250dd6c9ae6aaac08bdc670a169c2e",
"md5": "441767349827cb2bae32fff15ed51886",
"sha256": "0578f9575ef514342474ac32b001f28c0dc374b9864d8fc42f9e02f226644bff"
},
"downloads": -1,
"filename": "flats-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "441767349827cb2bae32fff15ed51886",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6447,
"upload_time": "2024-12-24T03:53:12",
"upload_time_iso_8601": "2024-12-24T03:53:12.993966Z",
"url": "https://files.pythonhosted.org/packages/0e/01/ee5603fc5eb0e06c73c592a44e2a9d250dd6c9ae6aaac08bdc670a169c2e/flats-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 03:53:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lapets",
"github_project": "flats",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flats"
}
