Add new 'clean' function, extracted from 'yield_lines'.

jaraco · Jul 14, 2024 · 98bd89f · 98bd89f
1 parent 1064e98
commit 98bd89f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/jaraco/text/__init__.py b/jaraco/text/__init__.py
@@ -3,6 +3,8 @@
 import re
 import textwrap
 
+from typing import Iterable
+
 try:
  from importlib.resources import files # type: ignore
 except ImportError: # pragma: nocover
@@ -554,7 +556,14 @@ def yield_lines(iterable):
 
 @yield_lines.register(str)
 def _(text):
- return filter(_nonblank, map(str.strip, text.splitlines()))
+ return clean(text.splitlines())
+
+
+def clean(lines: Iterable[str]):
+ """
+ Yield non-blank, non-comment elements from lines.
+ """
+ return filter(_nonblank, map(str.strip, lines))
 
 
 def drop_comment(line):

diff --git a/newsfragments/+cefc5be5.feature.rst b/newsfragments/+cefc5be5.feature.rst
@@ -0,0 +1 @@
+Add new 'clean' function, extracted from 'yield_lines'.