# ansi-string
ANSI String Formatter in Python for CLI Color and Style Formatting
## Introduction
This code was originally written for [greplica](https://pypi.org/project/greplica/), but I felt it deserved its own, separate library.
The main goals for this project are:
- To provide a simple way to construct a string-like object with embedded ANSI formatting without requiring the developer to know how ANSI formatting works
- Provide a way to further format the object using format string
- Allow for concatenation of the object
## Contribution
Feel free to open a bug report or make a merge request on [github](https://github.com/Tails86/ansi-string/issues).
## Installation
This project is uploaded to PyPI at https://pypi.org/project/ansi-string
To install, ensure you are connected to the internet and execute: `python3 -m pip install ansi-string --upgrade`
## Examples
Refer to the [test file](https://github.com/Tails86/ansi-string/blob/main/tests/test_ansi_string.py) for more examples on how to use the AnsiString class.
## Usage
To begin, import AnsiString from the ansi_string module.
```py
from ansi_string import en_tty_ansi, AnsiFormat, AnsiString
```
### Enabling ANSI Formatting
Windows requires ANSI formatting to be enabled before it can be used. This can either be set in the environment or by simply calling the following before printing so that ANSI is enabled locally.
```py
en_tty_ansi()
```
If this also needs to be enabled for stderr, stderr may also be passed to this method.
```py
import sys
en_tty_ansi(sys.stderr)
```
For Windows, this returns True if the given IO is a TTY (i.e. not piped to a file) and enabling ANSI was successful. For all other operating systems, this will return True if and only if the given IO is a TTY (i.e. isatty()); no other action is taken.
### Construction
The AnsiString class contains the following `__init__` method.
```py
class AnsiString:
def __init__(self, s:str='', *setting_or_settings:Union[List[str], str, List[int], int, List[AnsiFormat], AnsiFormat]): ...
```
The first argument, `s`, is a string to be formatted. The next 0 to N arguments are formatting setting directives that can be applied to the entire string. These arguments can be in the form of any of the following.
- An AnsiFormat enum (ex: `AnsiFormat.BOLD`)
- The result of calling `AnsiFormat.rgb()`, `AnsiFormat.fg_rgb()`, `AnsiFormat.bg_rgb()`, `AnsiFormat.ul_rgb()`, or `AnsiFormat.dul_rgb()`
- A string color or formatting name (i.e. any name of the AnsiFormat enum in lower or upper case)
- An `rgb(...)` function directive as a string (ex: `"rgb(255, 255, 255)"`)
- `rgb(...)` or `fg_rgb(...)` to adjust text color
- `bg_rgb(...)` to adjust background color
- `ul_rgb(...)` to enable underline and set the underline color
- `dul_rgb(...)` to enable double underline and set the underline color
- Value given may be either a 24-bit integer or 3 x 8-bit integers, separated by commas
- Each given value within the parenthesis is treated as hexadecimal if the value starts with "0x", otherwise it is treated as a decimal value
A formatting setting may also be any of the following, but it's not advised to specify settings in any of these ways unless there is a specific reason to do so.
- An AnsiSetting object
- A string containing known ANSI directives (ex: `"01;31"` for BOLD and FG_RED)
- The string will normally be parsed into separate settings unless the character "[" is the first character of the string (ex: `"[38;5;214"`)
- Never specify the reset directive (0) because this is implicitly handled internally
- A single ANSI directive as an integer
Examples:
```py
# Set foreground to light_sea_green using string directive
# Set background to chocolate using AnsiFormat directive
# Underline in gray using ul_rgb() directive
# Enable italics using explicit string directive ("3")
# Enable bold using explicit integer directive (1)
s = AnsiString("This is an ANSI string", "light_sea_green", AnsiFormat.BG_CHOCOLATE, "ul_rgb(0x808080)", "3", 1)
print(s)
```
### Concatenation
- The static method `AnsiString.join()` is provided to join together 0 to many `str` and `AnsiString` values into a single `AnsiString`.
- The `+` operator may be used to join an `AnsiString` with another `AnsiString` or `str` into a new `AnsiString`
- The `+` operator may not be used if the left-hand-side value is a `str` and the right-hand-side values is an `AnsiString`
- The `+=` operator may be used to append an `AnsiString` or `str` to an `AnsiString`
Examples:
```py
s = AnsiString.join("This ", AnsiString("string", AnsiFormat.BOLD))
s += AnsiString(" contains ") + AnsiString("multiple", AnsiFormat.BG_BLUE)
s += AnsiString(" color ", AnsiFormat.FG_ORANGE, AnsiFormat.ITALIC) + "settings accross different ranges"
print(s)
```
### Formatting
#### apply_formatting
The method `AnsiString.apply_formatting()` is provided to append formatting to a previously constructed `AnsiString`.
Example:
```py
s = AnsiString("This string contains multiple color settings across different ranges")
s.apply_formatting(AnsiFormat.BOLD, 5, 11)
s.apply_formatting(AnsiFormat.BG_BLUE, 21, 29)
s.apply_formatting([AnsiFormat.FG_ORANGE, AnsiFormat.ITALIC], 21, 35)
print(s)
```
#### Format String
A format string may be used to format an AnsiString before printing. The format specification string must be in the format `"[string_format][:ansi_format]"` where `string_format` is the standard string format specifier and `ansi_format` contains 0 or more ANSI directives separated by semicolons (;). The ANSI directives may be any of the same string values that can be passed to the `AnsiString` constructor. If no `string_format` is desired, then it can be set to an empty string.
Examples:
```py
ansi_str = AnsiString("This is an ANSI string")
# Right justify with width of 100, formatted bold and red
print("{:>100:bold;red}".format(ansi_str))
# No justification settings, formatted bold and red
print("{::bold;red}".format(ansi_str))
# No justification settings, formatted bold and red
print("{::bold;rgb(255, 0, 0)}".format(ansi_str))
# No justification settings, formatted bold and red
print(f"{ansi_str::bold;red}")
# Format text, background, and underline with custom colors
fg_color = 0x8A2BE2
bg_colors = [100, 232, 170]
ul_colors = [0xFF, 0x63, 0x47]
print(f"{ansi_str::rgb({fg_color});bg_rgb({bg_colors});ul_rgb({ul_colors})}")
```
#### format_matching and unformat_matching
The method `AnsiString.format_matching()` and `AnsiString.unformat_matching()` are provided to apply or remove formatting of an `AnsiString` based on a match specification.
Example:
```py
s = AnsiString("Here is a strING that I will match formatting", AnsiFormat.BOLD)
# This will make the word "formatting" cyan with a pink background
s.format_matching("[A-Za-z]+ing", "cyan", AnsiFormat.BG_PINK, regex=True, match_case=True)
# This will remove BOLD from "strING" and "formatting"
s.unformat_matching("[A-Za-z]+ing", AnsiFormat.BOLD, regex=True)
print(s)
```
#### clear_formatting
Calling the method `AnsiString.clear_formatting()` will clear all formatting applied.
### String Assignment
The method `AnsiString.assign_str()` may be used to assign the internal string and adjust formatting as necessary.
### Base String Retrieval
The attribute `AnsiString.base_str` may be used to retrieve the unformatted base string.
### Format Status
The methods `AnsiString.ansi_settings_at()` and `AnsiString.settings_at()` may be used to retrieve the settings applied over a single character.
### Other String Methods
Many other methods that are found in the `str` class such as `replace()` are available in `AnsiString` which manipulate the string while applying formatting where necessary.
- capitalize
- casefold
- center
- count
- encode
- endswith
- expandtabs
- find
- index
- isalnum
- isalpha
- isascii
- isdecimal
- isdigit
- isidentifier
- islower
- isnumeric
- isprintable
- isspace
- istitle
- isupper
- ljust
- lower
- lstrip
- partition
- removeprefix
- removesuffix
- replace
- rfind
- rindex
- rjust
- rpartition
- rsplit
- rstrip
- split
- splitlines
- strip
- swapcase
- title
- upper
- zfill
Raw data
{
"_id": null,
"home_page": "https://github.com/Tails86/ansi-string",
"name": "ansi-string",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "ANSI, string",
"author": "James Smith",
"author_email": "jmsmith86@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/e6/5d6800d4148b447b49b29b2ddb14221a5f4a352db0f2b47158f6af593d93/ansi-string-1.0.5.tar.gz",
"platform": null,
"description": "# ansi-string\n\nANSI String Formatter in Python for CLI Color and Style Formatting\n\n## Introduction\n\nThis code was originally written for [greplica](https://pypi.org/project/greplica/), but I felt it deserved its own, separate library.\n\nThe main goals for this project are:\n- To provide a simple way to construct a string-like object with embedded ANSI formatting without requiring the developer to know how ANSI formatting works\n- Provide a way to further format the object using format string\n- Allow for concatenation of the object\n\n## Contribution\n\nFeel free to open a bug report or make a merge request on [github](https://github.com/Tails86/ansi-string/issues).\n\n## Installation\nThis project is uploaded to PyPI at https://pypi.org/project/ansi-string\n\nTo install, ensure you are connected to the internet and execute: `python3 -m pip install ansi-string --upgrade`\n\n## Examples\n\n\n\nRefer to the [test file](https://github.com/Tails86/ansi-string/blob/main/tests/test_ansi_string.py) for more examples on how to use the AnsiString class.\n\n## Usage\n\nTo begin, import AnsiString from the ansi_string module.\n\n```py\nfrom ansi_string import en_tty_ansi, AnsiFormat, AnsiString\n```\n\n### Enabling ANSI Formatting\n\nWindows requires ANSI formatting to be enabled before it can be used. This can either be set in the environment or by simply calling the following before printing so that ANSI is enabled locally.\n```py\nen_tty_ansi()\n```\n\nIf this also needs to be enabled for stderr, stderr may also be passed to this method.\n```py\nimport sys\nen_tty_ansi(sys.stderr)\n```\n\nFor Windows, this returns True if the given IO is a TTY (i.e. not piped to a file) and enabling ANSI was successful. For all other operating systems, this will return True if and only if the given IO is a TTY (i.e. isatty()); no other action is taken.\n\n### Construction\n\nThe AnsiString class contains the following `__init__` method.\n\n```py\nclass AnsiString:\n def __init__(self, s:str='', *setting_or_settings:Union[List[str], str, List[int], int, List[AnsiFormat], AnsiFormat]): ...\n```\n\nThe first argument, `s`, is a string to be formatted. The next 0 to N arguments are formatting setting directives that can be applied to the entire string. These arguments can be in the form of any of the following.\n- An AnsiFormat enum (ex: `AnsiFormat.BOLD`)\n- The result of calling `AnsiFormat.rgb()`, `AnsiFormat.fg_rgb()`, `AnsiFormat.bg_rgb()`, `AnsiFormat.ul_rgb()`, or `AnsiFormat.dul_rgb()`\n- A string color or formatting name (i.e. any name of the AnsiFormat enum in lower or upper case)\n- An `rgb(...)` function directive as a string (ex: `\"rgb(255, 255, 255)\"`)\n - `rgb(...)` or `fg_rgb(...)` to adjust text color\n - `bg_rgb(...)` to adjust background color\n - `ul_rgb(...)` to enable underline and set the underline color\n - `dul_rgb(...)` to enable double underline and set the underline color\n - Value given may be either a 24-bit integer or 3 x 8-bit integers, separated by commas\n - Each given value within the parenthesis is treated as hexadecimal if the value starts with \"0x\", otherwise it is treated as a decimal value\n\nA formatting setting may also be any of the following, but it's not advised to specify settings in any of these ways unless there is a specific reason to do so.\n- An AnsiSetting object\n- A string containing known ANSI directives (ex: `\"01;31\"` for BOLD and FG_RED)\n - The string will normally be parsed into separate settings unless the character \"[\" is the first character of the string (ex: `\"[38;5;214\"`)\n - Never specify the reset directive (0) because this is implicitly handled internally\n- A single ANSI directive as an integer\n\nExamples:\n\n```py\n# Set foreground to light_sea_green using string directive\n# Set background to chocolate using AnsiFormat directive\n# Underline in gray using ul_rgb() directive\n# Enable italics using explicit string directive (\"3\")\n# Enable bold using explicit integer directive (1)\ns = AnsiString(\"This is an ANSI string\", \"light_sea_green\", AnsiFormat.BG_CHOCOLATE, \"ul_rgb(0x808080)\", \"3\", 1)\nprint(s)\n```\n\n### Concatenation\n\n- The static method `AnsiString.join()` is provided to join together 0 to many `str` and `AnsiString` values into a single `AnsiString`.\n- The `+` operator may be used to join an `AnsiString` with another `AnsiString` or `str` into a new `AnsiString`\n - The `+` operator may not be used if the left-hand-side value is a `str` and the right-hand-side values is an `AnsiString`\n- The `+=` operator may be used to append an `AnsiString` or `str` to an `AnsiString`\n\nExamples:\n\n```py\ns = AnsiString.join(\"This \", AnsiString(\"string\", AnsiFormat.BOLD))\ns += AnsiString(\" contains \") + AnsiString(\"multiple\", AnsiFormat.BG_BLUE)\ns += AnsiString(\" color \", AnsiFormat.FG_ORANGE, AnsiFormat.ITALIC) + \"settings accross different ranges\"\nprint(s)\n```\n\n### Formatting\n\n#### apply_formatting\n\nThe method `AnsiString.apply_formatting()` is provided to append formatting to a previously constructed `AnsiString`.\n\nExample:\n\n```py\ns = AnsiString(\"This string contains multiple color settings across different ranges\")\ns.apply_formatting(AnsiFormat.BOLD, 5, 11)\ns.apply_formatting(AnsiFormat.BG_BLUE, 21, 29)\ns.apply_formatting([AnsiFormat.FG_ORANGE, AnsiFormat.ITALIC], 21, 35)\nprint(s)\n```\n\n#### Format String\n\nA format string may be used to format an AnsiString before printing. The format specification string must be in the format `\"[string_format][:ansi_format]\"` where `string_format` is the standard string format specifier and `ansi_format` contains 0 or more ANSI directives separated by semicolons (;). The ANSI directives may be any of the same string values that can be passed to the `AnsiString` constructor. If no `string_format` is desired, then it can be set to an empty string.\n\nExamples:\n\n```py\nansi_str = AnsiString(\"This is an ANSI string\")\n# Right justify with width of 100, formatted bold and red\nprint(\"{:>100:bold;red}\".format(ansi_str))\n# No justification settings, formatted bold and red\nprint(\"{::bold;red}\".format(ansi_str))\n# No justification settings, formatted bold and red\nprint(\"{::bold;rgb(255, 0, 0)}\".format(ansi_str))\n# No justification settings, formatted bold and red\nprint(f\"{ansi_str::bold;red}\")\n# Format text, background, and underline with custom colors\nfg_color = 0x8A2BE2\nbg_colors = [100, 232, 170]\nul_colors = [0xFF, 0x63, 0x47]\nprint(f\"{ansi_str::rgb({fg_color});bg_rgb({bg_colors});ul_rgb({ul_colors})}\")\n```\n\n#### format_matching and unformat_matching\n\nThe method `AnsiString.format_matching()` and `AnsiString.unformat_matching()` are provided to apply or remove formatting of an `AnsiString` based on a match specification.\n\nExample:\n\n```py\ns = AnsiString(\"Here is a strING that I will match formatting\", AnsiFormat.BOLD)\n# This will make the word \"formatting\" cyan with a pink background\ns.format_matching(\"[A-Za-z]+ing\", \"cyan\", AnsiFormat.BG_PINK, regex=True, match_case=True)\n# This will remove BOLD from \"strING\" and \"formatting\"\ns.unformat_matching(\"[A-Za-z]+ing\", AnsiFormat.BOLD, regex=True)\nprint(s)\n```\n\n#### clear_formatting\n\nCalling the method `AnsiString.clear_formatting()` will clear all formatting applied.\n\n### String Assignment\n\nThe method `AnsiString.assign_str()` may be used to assign the internal string and adjust formatting as necessary.\n\n### Base String Retrieval\n\nThe attribute `AnsiString.base_str` may be used to retrieve the unformatted base string.\n\n### Format Status\n\nThe methods `AnsiString.ansi_settings_at()` and `AnsiString.settings_at()` may be used to retrieve the settings applied over a single character.\n\n### Other String Methods\n\nMany other methods that are found in the `str` class such as `replace()` are available in `AnsiString` which manipulate the string while applying formatting where necessary.\n\n- capitalize\n- casefold\n- center\n- count\n- encode\n- endswith\n- expandtabs\n- find\n- index\n- isalnum\n- isalpha\n- isascii\n- isdecimal\n- isdigit\n- isidentifier\n- islower\n- isnumeric\n- isprintable\n- isspace\n- istitle\n- isupper\n- ljust\n- lower\n- lstrip\n- partition\n- removeprefix\n- removesuffix\n- replace\n- rfind\n- rindex\n- rjust\n- rpartition\n- rsplit\n- rstrip\n- split\n- splitlines\n- strip\n- swapcase\n- title\n- upper\n- zfill\n",
"bugtrack_url": null,
"license": null,
"summary": "ANSI String Formatter in Python for CLI Color and Style Formatting",
"version": "1.0.5",
"project_urls": {
"Bug Reports": "https://github.com/Tails86/ansi-string/issues",
"Documentation": "https://github.com/Tails86/ansi-string",
"Homepage": "https://github.com/Tails86/ansi-string",
"Source Code": "https://github.com/Tails86/ansi-string"
},
"split_keywords": [
"ansi",
" string"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f24bf57a78ea7bf35acb087c266f2ba81bfa459db9ef4edaf4cd2873948de552",
"md5": "5e4f8a633e9182c29f6a37d89984e011",
"sha256": "8ce995ab6807f555e871e10c7ecd037b5fb01786c4831848a73269f452b18a41"
},
"downloads": -1,
"filename": "ansi_string-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e4f8a633e9182c29f6a37d89984e011",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 27993,
"upload_time": "2024-05-01T00:08:19",
"upload_time_iso_8601": "2024-05-01T00:08:19.163459Z",
"url": "https://files.pythonhosted.org/packages/f2/4b/f57a78ea7bf35acb087c266f2ba81bfa459db9ef4edaf4cd2873948de552/ansi_string-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ee65d6800d4148b447b49b29b2ddb14221a5f4a352db0f2b47158f6af593d93",
"md5": "5246cc256821ba76af86eb9f4cf3c0cc",
"sha256": "280fa2f18d0cd29bf84fae8663c06d7cefa9f3d9094db00fca7bfef5c772609c"
},
"downloads": -1,
"filename": "ansi-string-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5246cc256821ba76af86eb9f4cf3c0cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 31349,
"upload_time": "2024-05-01T00:08:21",
"upload_time_iso_8601": "2024-05-01T00:08:21.036856Z",
"url": "https://files.pythonhosted.org/packages/1e/e6/5d6800d4148b447b49b29b2ddb14221a5f4a352db0f2b47158f6af593d93/ansi-string-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 00:08:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tails86",
"github_project": "ansi-string",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ansi-string"
}
JSON
