colorfulstring 0.0.0__py3-none-any.whl

colorfulstring/__init__.py

@@ -0,0 +1,74 @@
+"""
+# colorfulstring
+`colorfulstring` is a lightweight Python utility for building ANSI-colored terminal
+strings with a fluent, chainable API.
+
+## Quick Start
+
+```python
+from colorfulstring import c
+
+print(c.r << "Error:" << " something went wrong")
+print(c.g("OK"))
+```
+
+## Usage
+
+### 1) Color Shortcuts
+
+Available color properties are `d/r/g/y/b/p/c/w`, which map to dark, red, green, yellow,
+blue, purple, cyan, and white.
+
+```python
+print(c.y << "Warning")
+```
+
+### 2) Pipe-Style Chaining
+
+Use `<<` (or `@`) to append fragments in sequence:
+
+```python
+print(c.b << "[INFO]" << " service started")
+```
+
+### 3) Conditional Output
+
+- `iftrue(condition)`: include the next fragment only when `condition` is `True`.
+- `ifnot(condition)`: include the next fragment only when `condition` is `False`.
+- `ifelse(condition)`: choose between the next two fragments.
+
+```python
+
+ok = True
+line = c << "status: " << c.ifelse(ok) << c.g("success") << c.r("failed")
+print(line)
+```
+
+### 4) Immediate Printing
+
+`c.print` outputs each generated fragment immediately (without an automatic newline). It
+can be combined with `c.endl`.
+
+```python
+line = c.print << "hello" << c.endl
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/colorfulstring/
+
+### PyPI project
+* https://pypi.org/project/colorfulstring/
+
+
+## License
+This project falls under the BSD 3-Clause License.
+
+"""
+
+from . import core
+from ._version import __version__
+from .core import *
+
+__all__: list[str] = []
+__all__.extend(core.__all__)

colorfulstring/_typing.py

@@ -0,0 +1,10 @@
+"""
+Contains typing classes.
+
+NOTE: this module is not intended to be imported at runtime.
+
+"""
+
+import loggings
+
+loggings.warning("this module is not intended to be imported at runtime")

colorfulstring/_version.py

@@ -0,0 +1,3 @@
+"""Version file."""
+
+__version__ = "0.0.0"

colorfulstring/core.py

@@ -0,0 +1,252 @@
+"""
+Contains the core of colorfulstring.
+
+This module defines :class:`ColorfulString` and the singleton ``c`` used to build
+ANSI-colored terminal strings with a fluent API.
+
+NOTE: this module is private. All functions and objects are available in the main
+`colorfulstring` namespace - use that instead.
+
+"""
+
+from functools import partial
+from typing import Any, Callable, Self
+
+__all__ = ["c"]
+
+
+class _DefaultReceiver:
+    """Fallback receiver used by conditional pipelines."""
+
+    def __lshift__(self, obj: "ColorfulString") -> "ColorfulString":
+        return obj
+
+
+class ColorfulString:
+    """Fluent builder for ANSI-colored strings.
+
+    ``ColorfulString`` supports color shortcuts (``.r``, ``.g`` ...), concatenation,
+    piping with ``<<``/``@``, and conditional output with ``ifelse``/``iftrue``/``ifnot``.
+
+    Typical usage starts from the module-level singleton ``c``.
+    """
+
+    def __init__(
+        self,
+        default_color: str = "",
+        string: str | None = None,
+        status: tuple[bool, bool] | None = None,
+        receiver: Self | _DefaultReceiver = _DefaultReceiver(),
+        printer: Callable | None = None,
+    ) -> None:
+        """Create an internal builder state.
+
+        Args:
+            default_color: Default color token applied to plain strings.
+            string: Accumulated output string.
+            status: Internal state for conditional chaining.
+            receiver: Target builder used by conditional chains.
+            printer: Optional side-effect callback invoked on generated fragments.
+        """
+        self._default_color = default_color
+        self._string = string
+        self._status = status
+        self._receiver = receiver
+        self._printer = printer
+
+    def __repr__(self) -> str:
+        """Return accumulated string when finalized, else default repr."""
+        if self._status is None and self._string is not None:
+            return self._string
+        return super().__repr__()
+
+    def __str__(self) -> str:
+        """Return the user-facing string representation."""
+        return repr(self)
+
+    def __add__(self, string: str) -> str:
+        """Append a Python string to the built output."""
+        return self.__asstr() + string
+
+    def __radd__(self, string: str) -> str:
+        """Prepend a Python string to the built output."""
+        return string + self.__asstr()
+
+    def __call__(self, string: str) -> str:
+        """Convert input to colored output according to current color context."""
+        return self.__make_str(string)
+
+    def __lshift__(self, obj: str | Self | Any) -> Self:
+        """Pipe data into the builder.
+
+        ``builder << value`` appends ``value`` after converting color tokens.
+        Passing another ``ColorfulString`` is used internally to wire conditional chains.
+        """
+        if isinstance(obj, self.__class__):
+            if obj._status is not None:
+                if (
+                    not isinstance(obj._receiver, _DefaultReceiver)
+                    or obj._string is not None
+                ):
+                    raise ValueError("unfinished call to ifelse(), iftrue() or ifnot()")
+                obj._receiver = self
+                return obj
+
+            if obj._string is None:
+                raise ValueError("<< c alone is not allowed")
+        return self.__recv(obj)
+
+    def __rlshift__(self, obj: str | Self | Any) -> Self:
+        """Support ``value << builder`` style piping."""
+        return c << obj << self
+
+    def __rshift__[T](self, obj: type[T]) -> T:
+        """Cast the finalized string to another type.
+
+        Example:
+            ``(c.r << "42") >> int``
+        """
+        if self._status is None and self._string is not None:
+            return obj(self._string)
+        raise ValueError(f"nothing to convert to {obj}")
+
+    def __matmul__(self, obj: str | Self | Any) -> Self:
+        """Alias of ``<<`` for users who prefer ``@`` syntax."""
+        return self << obj
+
+    def ifelse(self, condition: bool) -> Self:
+        """Start a two-branch conditional chain.
+
+        The first subsequent value is used when ``condition`` is true; the second one
+        is used otherwise.
+        """
+        if self._status is not None:
+            raise ValueError("duplicated call to ifelse(), iftrue() or ifnot()")
+        return self.copy(status=(bool(condition), True))
+
+    def iftrue(self, condition: bool) -> Self:
+        """Append next value only when ``condition`` is true."""
+        if self._status is not None:
+            raise ValueError("duplicated call to ifelse(), iftrue() or ifnot()")
+        return self.copy(string="", status=(not bool(condition), False))
+
+    def ifnot(self, condition: bool) -> Self:
+        """Append next value only when ``condition`` is false."""
+        if self._status is not None:
+            raise ValueError("duplicated call to ifelse(), iftrue() or ifnot()")
+        return self.copy(string="", status=(bool(condition), False))
+
+    def copy(
+        self,
+        *,
+        default_color: str = ...,
+        string: str | None = ...,
+        status: tuple[bool, bool] | None = ...,
+        receiver: Self | _DefaultReceiver = ...,
+        printer: Callable | None = ...,
+    ) -> Self:
+        """Return a cloned builder with selected fields overridden."""
+        return self.__class__(
+            self._default_color if default_color is Ellipsis else default_color,
+            self._string if string is Ellipsis else string,
+            self._status if status is Ellipsis else status,
+            self._receiver if receiver is Ellipsis else receiver,
+            self._printer if printer is Ellipsis else printer,
+        )
+
+    def __recv(self, obj: str | Self | Any) -> Self:
+        """Receive an object and merge it into current/conditional pipeline."""
+        if self._status is None:
+            return self.copy(string=self.__asstr() + self.__make_str(obj))
+        b, now = self._status
+        if now:
+            if b:
+                return self.copy(
+                    string=self.__asstr() + self.__make_str(obj), status=(b, False)
+                )
+            return self.copy(status=(b, False))
+        elif b:
+            return self._receiver << self.copy(status=None)
+        return self._receiver << self.copy(
+            string=self.__asstr() + self.__make_str(obj), status=None
+        )
+
+    def __make_str(self, obj: str | Self | Any) -> str:
+        """Convert value to final ANSI text and optionally emit to printer."""
+        if isinstance(obj, ColorfulString):
+            string = str(obj)
+        else:
+            string = str(obj)
+            if self._default_color and string:
+                string = f"${self._default_color}{string}$"
+            string = (
+                string.replace("$D", "\033[30m")  # Dark
+                .replace("$R", "\033[31m")  # Red
+                .replace("$G", "\033[32m")  # Green
+                .replace("$Y", "\033[33m")  # Yellow
+                .replace("$B", "\033[34m")  # Blue
+                .replace("$P", "\033[35m")  # Purple
+                .replace("$C", "\033[36m")  # Cyan
+                .replace("$W", "\033[37m")  # White
+                .replace("$", "\033[0m")
+            )
+        if self._printer is not None:
+            self._printer(string)
+        return string
+
+    def __asstr(self) -> str:
+        """Get accumulated output or an empty string."""
+        return "" if self._string is None else self._string
+
+    @property
+    def print(self) -> Self:
+        """Return builder that prints each generated fragment immediately."""
+        return self.copy(printer=partial(print, end=""))
+
+    @property
+    def endl(self) -> Self:
+        """Return a newline fragment."""
+        return ColorfulString(string="\n")
+
+    @property
+    def d(self) -> Self:
+        """Return a builder with dark/black default color."""
+        return self.copy(default_color="D")
+
+    @property
+    def r(self) -> Self:
+        """Return a builder with red default color."""
+        return self.copy(default_color="R")
+
+    @property
+    def g(self) -> Self:
+        """Return a builder with green default color."""
+        return self.copy(default_color="G")
+
+    @property
+    def y(self) -> Self:
+        """Return a builder with yellow default color."""
+        return self.copy(default_color="Y")
+
+    @property
+    def b(self) -> Self:
+        """Return a builder with blue default color."""
+        return self.copy(default_color="B")
+
+    @property
+    def p(self) -> Self:
+        """Return a builder with purple default color."""
+        return self.copy(default_color="P")
+
+    @property
+    def c(self) -> Self:
+        """Return a builder with cyan default color."""
+        return self.copy(default_color="C")
+
+    @property
+    def w(self) -> Self:
+        """Return a builder with white default color."""
+        return self.copy(default_color="W")
+
+
+c = ColorfulString()

colorfulstring-0.0.0.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: colorfulstring
+Version: 0.0.0
+Summary: Make colorful strings.
+Project-URL: Documentation, https://github.com/Chitaoji/colorfulstring/blob/main/README.md
+Project-URL: Repository, https://github.com/Chitaoji/colorfulstring/
+Author-email: Chitaoji <2360742040@qq.com>
+Maintainer-email: Chitaoji <2360742040@qq.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: config
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# colorfulstring
+`colorfulstring` is a lightweight Python utility for building ANSI-colored terminal strings with a fluent, chainable API.
+
+## Installation
+
+```bash
+pip install colorfulstring
+```
+
+## Quick Start
+
+```python
+from colorfulstring import c
+
+print(c.r << "Error:" << " something went wrong")
+print(c.g("OK"))
+```
+
+## Usage
+
+### 1) Color Shortcuts
+
+Available color properties are `d/r/g/y/b/p/c/w`, which map to dark, red, green, yellow, blue, purple, cyan, and white.
+
+```python
+print(c.y << "Warning")
+```
+
+### 2) Pipe-Style Chaining
+
+Use `<<` (or `@`) to append fragments in sequence:
+
+```python
+print(c.b << "[INFO]" << " service started")
+```
+
+### 3) Conditional Output
+
+- `iftrue(condition)`: include the next fragment only when `condition` is `True`.
+- `ifnot(condition)`: include the next fragment only when `condition` is `False`.
+- `ifelse(condition)`: choose between the next two fragments.
+
+```python
+
+ok = True
+line = c << "status: " << c.ifelse(ok) << c.g("success") << c.r("failed")
+print(line)
+```
+
+### 4) Immediate Printing
+
+`c.print` outputs each generated fragment immediately (without an automatic newline). It can be combined with `c.endl`.
+
+```python
+line = c.print << "hello" << c.endl
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/colorfulstring/
+
+### PyPI project
+* https://pypi.org/project/colorfulstring/
+
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.0.0
+* Initial release.

colorfulstring-0.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+colorfulstring/__init__.py,sha256=3PfM3wVEUjbQXRZMFiw5u_Vn15pQLmCmvzyJTlIdHUw,1509
+colorfulstring/_typing.py,sha256=hYjHTC9lc_cxiFj6weQnY2_00hNAFKISbWHEfhHhPhE,188
+colorfulstring/_version.py,sha256=Yh1NHsKxLt_X-EdEq7AJFF-QqDaJmXkvE2TY7RmcOa4,43
+colorfulstring/core.py,sha256=phBcXeSqP5n5vowBvLzqU7Vkgkj_Kvd96BJp6JiRPQ8,8913
+colorfulstring-0.0.0.dist-info/METADATA,sha256=GU70RxJhSYosVERzwY8D6xwSMVXLzLUocrTsnhqwdOA,2046
+colorfulstring-0.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+colorfulstring-0.0.0.dist-info/licenses/LICENSE,sha256=rlOb8JrIQs-p03IkqjgLlXbFGIwdABeHAaRckd4b8N8,1495
+colorfulstring-0.0.0.dist-info/RECORD,,

colorfulstring-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

colorfulstring-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Chitaoji
+
+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.