Merge branch 'master' of https://github.com/python-discord/seasonalbot into partnerzodiac

1 files changed, 23 insertions, 0 deletions

diff --git a/bot/utils/randomization.py b/bot/utils/randomization.py
new file mode 100644
index 00000000..8f47679a
--- /dev/null
+++ b/bot/utils/randomization.py
@@ -0,0 +1,23 @@
+import itertools
+import random
+import typing as t
+
+
+class RandomCycle:
+    """
+    Cycles through elements from a randomly shuffled iterable, repeating indefinitely.
+
+    The iterable is reshuffled after each full cycle.
+    """
+
+    def __init__(self, iterable: t.Iterable) -> None:
+        self.iterable = list(iterable)
+        self.index = itertools.cycle(range(len(iterable)))
+
+    def __next__(self) -> t.Any:
+        idx = next(self.index)
+
+        if idx == 0:
+            random.shuffle(self.iterable)
+
+        return self.iterable[idx]