From c6fca944b41f292b66efaba27ebf3fd0a37956b8 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Fri, 25 Mar 2022 09:15:08 -0700 Subject: [PATCH] Adds shuffle/scramble to list_utils. --- list_utils.py | 27 ++++++++++++++++++++++++++- string_utils.py | 4 ++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/list_utils.py b/list_utils.py index 91af8f9..7f28ade 100644 --- a/list_utils.py +++ b/list_utils.py @@ -2,9 +2,10 @@ """Some useful(?) utilities for dealing with Lists.""" +import random from collections import Counter from itertools import islice -from typing import Any, Iterator, List, Sequence, Tuple +from typing import Any, Iterator, List, MutableSequence, Sequence, Tuple def shard(lst: List[Any], size: int) -> Iterator[Any]: @@ -232,6 +233,30 @@ def _permute(seq: str, path: str): yield from _permute(cdr, path + car) +def shuffle(seq: MutableSequence[Any]) -> MutableSequence[Any]: + """Shuffles a sequence into a random order. + + >>> random.seed(22) + >>> shuffle([1, 2, 3, 4, 5]) + [3, 4, 1, 5, 2] + + >>> shuffle('example') + 'empaelx' + + """ + if isinstance(seq, str): + import string_utils + + return string_utils.shuffle(seq) + else: + random.shuffle(seq) + return seq + + +def scramble(seq: MutableSequence[Any]) -> MutableSequence[Any]: + return shuffle(seq) + + def binary_search(lst: Sequence[Any], target: Any, *, sanity_check=False) -> Tuple[bool, int]: """Performs a binary search on lst (which must already be sorted). Returns a Tuple composed of a bool which indicates whether the diff --git a/string_utils.py b/string_utils.py index 37851e0..0899576 100644 --- a/string_utils.py +++ b/string_utils.py @@ -971,6 +971,10 @@ def shuffle(in_str: str) -> str: return from_char_list(chars) +def scramble(in_str: str) -> str: + return shuffle(in_str) + + def strip_html(in_str: str, keep_tag_content: bool = False) -> str: """ Remove html code contained into the given string. -- 2.45.2