sync with Atlas

04-text-byte/charfinder/README.rst

@@ -0,0 +1,72 @@
+========================
+Character Finder Utility
+========================
+
+Usage tips
+==========
+
+`cf.py` works as an executable on Unix-like systems,
+if you have `python3` on your `$PATH`::
+
+    $ chmod +x cf.py
+    $ ./cf.py cat eyes
+    U+1F638	😸	GRINNING CAT FACE WITH SMILING EYES
+    U+1F63B	😻	SMILING CAT FACE WITH HEART-SHAPED EYES
+    U+1F63D	😽	KISSING CAT FACE WITH CLOSED EYES
+
+Use `wc -l` to count the number of hits::
+
+    $ ./cf.py hieroglyph | wc -l
+    1663
+
+With `tee` you can get the output and the count::
+
+    $ ./cf.py trigram | tee >(wc -l)
+    U+2630	☰	TRIGRAM FOR HEAVEN
+    U+2631	☱	TRIGRAM FOR LAKE
+    U+2632	☲	TRIGRAM FOR FIRE
+    U+2633	☳	TRIGRAM FOR THUNDER
+    U+2634	☴	TRIGRAM FOR WIND
+    U+2635	☵	TRIGRAM FOR WATER
+    U+2636	☶	TRIGRAM FOR MOUNTAIN
+    U+2637	☷	TRIGRAM FOR EARTH
+    8
+
+
+Running the tests
+=================
+
+Run the ``doctest`` module from the command line on 
+this README.rst file (using ``-v`` to make tests visible)::
+
+    $ python3 -m doctest README.rst -v
+
+That's what the ``test.sh`` script does.
+
+
+Tests
+-----
+
+Import functions for testing::
+
+    >>> from cf import find, main
+
+Test ``find`` with single result::
+
+    >>> find('sign', 'registered')  # doctest:+NORMALIZE_WHITESPACE
+    U+00AE	®	REGISTERED SIGN
+
+Test ``find`` with two results::
+
+    >>> find('chess', 'queen', last=0xFFFF)  # doctest:+NORMALIZE_WHITESPACE
+    U+2655	♕	WHITE CHESS QUEEN
+    U+265B	♛	BLACK CHESS QUEEN
+
+Test ``find`` with no results::
+
+    >>> find('no_such_character')
+
+Test ``main`` with no words::
+
+    >>> main([])
+    Please provide words to find.

04-text-byte/charfinder/cf.py

@@ -4,18 +4,13 @@ import unicodedata
 
 FIRST, LAST = ord(' '), sys.maxunicode              # <1>
 
-
 def find(*query_words, first=FIRST, last=LAST):     # <2>
     query = {w.upper() for w in query_words}        # <3>
-    count = 0
     for code in range(first, last + 1):
         char = chr(code)                            # <4>
         name = unicodedata.name(char, None)         # <5>
         if name and query.issubset(name.split()):   # <6>
             print(f'U+{code:04X}\t{char}\t{name}')  # <7>
-            count += 1
-    print(f'({count} found)')
-
 
 def main(words):
     if words:
@@ -23,6 +18,5 @@ def main(words):
     else:
         print('Please provide words to find.')
 
-
 if __name__ == '__main__':
     main(sys.argv[1:])

04-text-byte/charfinder/cf_tests.rst

@@ -1,36 +0,0 @@
-Doctests for ``cf.py``
-======================
-
-How to run the tests
-----------------------
-
-Run the ``doctest`` module from the command line::
-
-    $ python3 -m doctest cf_tests.rst
-
-
-Tests
------
-
-Import functions for testing::
-
-    >>> from cf import find, main
-
-Test ``find`` with single result::
-
-    >>> find("sign", "registered")  # doctest:+NORMALIZE_WHITESPACE
-    U+00AE  ®   REGISTERED SIGN
-    (1 found)
-
-
-Test ``find`` with two results::
-
-    >>> find("chess", "queen", last=0xFFFF)  # doctest:+NORMALIZE_WHITESPACE
-    U+2655	♕	WHITE CHESS QUEEN
-    U+265B	♛	BLACK CHESS QUEEN
-    (2 found)
-
-Test ``main`` with no words::
-
-    >>> main([])
-    Please provide words to find.

04-text-byte/charfinder/test.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-python3 -m doctest cf_tests.rst $1
+python3 -m doctest README.rst $1