py3toolset 1.2.18__py3-none-any.whl

py3toolset/txt_color.py

@@ -0,0 +1,168 @@
+"""
+Module to print colored text in a terminal.
+"""
+import shutil
+
+
+class Color:
+    RED = '\033[91m'
+    GREEN = '\033[92m'
+    YELLOW = '\033[93m'
+    BLUE = '\033[94m'
+    END = '\033[0m'
+
+
+class Style:
+    BOLD = "\033[1m"
+
+
+def col(col, txt):
+    """
+    Colorizes txt using ANSI escape code (encoded in :class:`.Color`).
+
+    Args:
+        col: ``int``
+            ``Color.RED``, ``Color.GREEN``, ``Color.YELLOW``, ``Color.BLUE``.
+        txt: ``str``
+            the txt to colorize.
+
+    Return:
+        ``txt`` encoded in ``col`` color.
+
+    """
+    if col not in [Color.BLUE, Color.YELLOW, Color.GREEN, Color.RED]:
+        raise Exception("Not valid color")
+    return col + txt.replace(Color.END, Color.END+""+col) + Color.END
+
+
+def frame(title, col=Color.BLUE, centering=True):
+    """Frames the text ``title`` in color.
+
+    The enclosing frame is made of colored dash characters.
+
+    Args:
+        title: ``str``
+            The text to frame.
+        col: ``int``
+            ``Color.RED``, ``Color.GREEN``, ``Color.YELLOW``, ``Color.BLUE``
+            (default).
+        centering: ``bool``
+            ``True`` (default) for centered ``title`` in terminal,
+            ``False`` otherwise.
+
+    Return:
+        ``title`` encoded in ``col`` color with dash characters above and
+        below.
+    """
+    return (col + "-"*get_width() + "\n" +
+            Style.BOLD+(centering and center(title) or title) + "\n" +
+            Color.END + col + "-"*get_width() + Color.END)
+
+
+def big_frame(title, col=Color.RED, centering=True):
+    """Frames the text ``title`` in color.
+
+       Same as :func:`.frame` but text in red by default with enclosing frame
+       made of ``=`` characters.
+    """
+    return (col + "="*get_width() + "\n" +
+            Style.BOLD+(centering and center(title) or title) + "\n" +
+            Color.END + col + "="*get_width() + Color.END)
+
+
+def center(txt):
+    """Centers a text according to the terminal number of columns.
+
+    The centering is made by space insertions.
+
+    Return:
+        The centered text of ``txt``.
+    """
+    return " "*((get_width() - len(txt)) // 2) + txt
+
+
+def print_center(txt):
+    """ Centers and prints text ``txt``.
+
+    .. seealso::
+        :func:`.center`
+    """
+    print(center(txt))
+
+
+def print_frame(title, col=Color.BLUE, centering=True):
+    """Prints ``title`` enclosed in frame (dash characters).
+
+    .. seealso::
+        :func:`.frame`
+    """
+    print(frame(title, col, centering))
+
+
+def get_width():
+    "Gets the terminal number of columns."
+    return shutil.get_terminal_size()[0]
+
+
+def print_big_frame(title, col=Color.RED, centering=True):
+    """Prints ``title`` enclosed in big frame (``=`` characters).
+
+    .. seealso::
+        :func:`.big_frame`
+    """
+    print(big_frame(title, col, centering))
+
+
+def bold(txt):
+    "Returns txt in bold style (for terminal display)"
+    return Style.BOLD + txt + Color.END
+
+
+def warn(msg):
+    "Formats and print ``msg`` as a warning message (prefix 'WARNING:' in red)"
+    print(col(Color.RED, "WARNING: ")+msg)
+
+
+def err(msg):
+    """Formats a msg as an error message.
+
+    Format: prefix 'Error:' in bold style and all message in red.
+    """
+    if not msg.lower().startswith("error"):
+        msg = bold("Error: ") + msg
+    print_frame(msg, Color.RED, centering=False)
+
+
+def red(txt):
+    """
+    Returns ``txt`` as red ``str`` (see ``col``).
+    """
+    return col(Color.RED, txt)
+
+
+def green(txt):
+    """
+    Returns ``txt`` as green ``str`` (see ``col``).
+    """
+    return col(Color.GREEN, txt)
+
+
+def blue(txt):
+    """
+    Returns ``txt`` as blue ``str`` (see ``col``).
+    """
+    return col(Color.BLUE, txt)
+
+
+def yellow(txt):
+    """
+    Returns ``txt`` as yellow ``str`` (see ``col``).
+    """
+    return col(Color.YELLOW, txt)
+
+
+# def alias color functions
+r = red
+g = green
+b = blue
+y = yellow

py3toolset-1.2.18.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: py3toolset
+Version: 1.2.18
+Summary: Python utility modules.
+Home-page: 
+License: 3-clause BSD 2.0
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy>=2
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+Python collection of utility modules: [bash_autocomp](https://lpg-umr6112.fr//api.html#module-0), [cmd_interact](https://lpg-umr6112.fr//api.html#module-1), [dep](https://lpg-umr6112.fr//api.html#module-2), [file_backup](https://lpg-umr6112.fr//api.html#module-3), [fs](https://lpg-umr6112.fr//api.html#module-4), [nmath](https://lpg-umr6112.fr//api.html#module-5), [tuple_file](https://lpg-umr6112.fr//api.html#module-6), [txt_color](https://lpg-umr6112.fr//api.html#module-7)...
+
+This package software engineering has been funded by the [Laboratoire de Planétologie et Géosciences](https://lpg-umr6112.fr/), Nantes (France).
+    

py3toolset-1.2.18.dist-info/RECORD

@@ -0,0 +1,16 @@
+py3toolset/LICENSE.md,sha256=vm9EOiT_FH8ZkfAlTcGf_aYTaqyp3XtWLQk-Nw1_5Ug,1487
+py3toolset/__init__.py,sha256=OsEpnz6RA6ToHhem7m_1iQqm0C-EddSft_dZtxOKhOw,24
+py3toolset/bash_autocomp.py,sha256=AJI2ilnS0s8X2IE9KIlRuOYOKiKODl6NmnUwBVwXrO4,2677
+py3toolset/cmd_interact.py,sha256=xGQtK4OGcyoQThmlJ_40DleMHE9F9jWaYpGRufrG6uU,3542
+py3toolset/dep.py,sha256=WgkWSAQOH37rokMxXZJbqXe6DCDPk_X8W_LdRwPLKRA,4760
+py3toolset/file_backup.py,sha256=971w2ZUjjalVUSfGzW59ke4zhUgfX_0eVOHiU3PxuFw,4407
+py3toolset/fs.py,sha256=VgkeioxZqmna3JCcfkNR_ieKXIBdBRYKjVQqP0e4lH0,16065
+py3toolset/nmath.py,sha256=SRZBj3mmno3p3tzUKC327DK1mLFD41VGQcq8snlpKzs,13595
+py3toolset/setup.py,sha256=lHXURiDo5ujPYpnXSovEFwEjkiK01X9xca_cmEkLQ_c,1167
+py3toolset/tuple_file.py,sha256=DfdEFM5EvTIjsrFbMxQ3nGVWmmYSZRMp7wMudcAHaOI,3197
+py3toolset/txt_color.py,sha256=ml5QRqSOA9Kcbt6B89b7-wKNCRcluN0x2lKcH0no0Z8,3854
+py3toolset-1.2.18.dist-info/licenses/LICENSE.md,sha256=vm9EOiT_FH8ZkfAlTcGf_aYTaqyp3XtWLQk-Nw1_5Ug,1487
+py3toolset-1.2.18.dist-info/METADATA,sha256=Lw4seCJhph0kHpI02id6MIFMyDI93mbSJwC0-2fJLHU,1145
+py3toolset-1.2.18.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+py3toolset-1.2.18.dist-info/top_level.txt,sha256=qvAiIlJzi4hfz3GOt5HT_zr_XCyukWdNuBqDtxpBKO0,11
+py3toolset-1.2.18.dist-info/RECORD,,

py3toolset-1.2.18.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

py3toolset-1.2.18.dist-info/licenses/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2017-2023 Éric Beucler, Hakim Hadj-Djilani
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

py3toolset-1.2.18.dist-info/top_level.txt

@@ -0,0 +1 @@
+py3toolset