Skip to main content

Add a RepeatableIterable type and a function to obtain it

Project description

python-repeatable-iterable

PyPI-version-badge Downloads-badge Code-style:black:badge Imports:isort:badge Typecheck:mypy:badge Linting:pylint:badge CodeFactor-badge CodeClimateMaintainability-badge Codacy-badge GitHub-top-language-badge GitHub-license-badge PyPI-python-version-badge GitHub-code-size-in-bytes-badge

A new type RepeatableIterable for Python
and a way to obtain one instance

Since in Python an Iterator is an Iterable and that you cannot iterate multiple times on an iterator, you may encounter WTF bugs, even with type checking. This package provides possible solutions to this problem. See here for a discussion on this problem: https://stackoverflow.com/questions/63104689 (/what-is-the-pythonic-way-to-represent-an-iterable -that-can-be-iterated-over-mult).

Before:

def foo(iterable: Iterable):
    for that in iterable:
        bar(that)
    for that in iterable:
        # possible bug
        baz(that)

foo(something)

After solution 1:

from python_repeatable_iterable import RepeatableIterable

def foo(iterable: RepeatableIterable[object]):
    for that in iterable:
        bar(that)
    for that in iterable:
        baz(that)

something_else = RepeatableIterable(something)
foo(something_else)

After solution 2:

from python_repeatable_iterable import RepeatableIterable

def foo(iterable: Iterable):
    iterable = RepeatableIterable(iterable)
    for that in iterable:
        bar(that)
    for that in iterable:
        baz(that)

foo(something)

If you develop something where you have no control on what another dev might give you as input, you have 2 possibilities:

  • hope for the best ;),
  • or harden your code to have less support work to do :).

This applies if you dev something that is:

  • closed source or open source,
  • available to everyone on the Internet, available only to customers or colleagues that you may personally know or not.

Solution 2 above is a nice solution with a reasonable performance cost :).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_repeatable_iterable-2.1.8.tar.gz (104.3 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page