-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
243 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
|
|
||
| name: 'Package - Build' | ||
| run-name: 'Package: Build from ${{github.ref}}' | ||
|
|
||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| paths: | ||
| - 'pyproject.toml' | ||
|
|
||
| jobs: | ||
|
|
||
| publish-pypi: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| id-token: write | ||
| environment: | ||
| name: PyPI | ||
| steps: | ||
| - name: 'Checkout repository from ${{github.ref}}' | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: 'Build sdist' | ||
| run: | | ||
| pipx run build --sdist --wheel --outdir dist/ | ||
| - name: 'Upload package' | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| # https://github.com/marketplace/actions/pypi-publish | ||
| with: | ||
| packages-dir: dist | ||
| verify-metadata: false | ||
| verbose: true | ||
| print-hash: true | ||
| skip-existing: false | ||
|
|
||
| publish-testpypi: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| id-token: write | ||
| environment: | ||
| name: TestPyPI | ||
| steps: | ||
| - name: 'Checkout repository from ${{github.ref}}' | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: 'Build sdist' | ||
| run: | | ||
| pipx run build --sdist --wheel --outdir dist/ | ||
| - name: 'Upload package' | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| # https://github.com/marketplace/actions/pypi-publish | ||
| with: | ||
| packages-dir: dist | ||
| repository-url: https://test.pypi.org/legacy/ | ||
| verify-metadata: false | ||
| verbose: true | ||
| print-hash: true | ||
| skip-existing: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
|
|
||
| [build-system] | ||
| requires = ["setuptools>=61.0", "versioningit"] | ||
| build-backend = "setuptools.build_meta" | ||
|
|
||
|
|
||
| # ----------------------------------------- setuptools ------------------------------------------- | ||
| [tool.setuptools] | ||
| include-package-data = true | ||
| zip-safe = false | ||
|
|
||
| [tool.setuptools.packages.find] | ||
| where = ["src"] | ||
| namespaces = true | ||
|
|
||
|
|
||
| # ----------------------------------------- Project Metadata ------------------------------------- | ||
| # | ||
| [project] | ||
| version = "0.0.0.dev1" | ||
| name = "ANSI-SGR" | ||
| requires-python = ">=3.10" |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| """ | ||
| References | ||
| ---------- | ||
| - https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters | ||
| """ | ||
|
|
||
| from typing import Optional | ||
| import re | ||
|
|
||
|
|
||
| _TEXT_STYLE = { | ||
| 'normal': '0', | ||
| 'bold': '1', | ||
| 'faint': '2', | ||
| 'italic': '3', | ||
| 'underline': '4', | ||
| 'blink': '5', | ||
| 'blink_fast': '6', | ||
| 'reverse': '7', | ||
| 'conceal': '8', | ||
| 'strike': '9', | ||
| } | ||
| _COLOR = { | ||
| 'black': 30, | ||
| 'red': 31, | ||
| 'green': 32, | ||
| 'yellow': 33, | ||
| 'blue': 34, | ||
| 'magenta': 35, | ||
| 'cyan': 36, | ||
| 'white': 37, | ||
| 'b_black': 90, | ||
| 'b_red': 91, | ||
| 'b_green': 92, | ||
| 'b_yellow': 93, | ||
| 'b_blue': 94, | ||
| 'b_magenta': 95, | ||
| 'b_cyan': 96, | ||
| 'b_white': 97, | ||
| } | ||
| _TEMPLATE = "\033[{}m" | ||
| RESET = _TEMPLATE.format(0) | ||
|
|
||
|
|
||
| def style( | ||
| text_styles: int | str | list[int | str] = None, | ||
| text_color: int | str | tuple = None, | ||
| background_color: int | str | tuple = None | ||
| ): | ||
|
|
||
| def add_color(color: int | str | tuple, bg: bool = False): | ||
| int_range = ( | ||
| list(range(40, 48)) + list(range(100, 108)) if bg else | ||
| list(range(30, 38)) + list(range(90, 98)) | ||
| ) | ||
| int_offset = 10 if bg else 0 | ||
| rgb_code = 48 if bg else 38 | ||
| if isinstance(color, int): | ||
| if color not in int_range: | ||
| raise ValueError(f"Invalid color code: {color}") | ||
| return f"{color};" | ||
| if isinstance(color, str): | ||
| if color not in _COLOR: | ||
| raise ValueError(f"Invalid color name: {color}") | ||
| return f"{_COLOR[color] + int_offset};" | ||
| if isinstance(color, tuple): | ||
| if len(color) != 3: | ||
| raise ValueError(f"Invalid color tuple: {color}") | ||
| if not all(isinstance(c, int) for c in color): | ||
| raise ValueError(f"Invalid color tuple: {color}") | ||
| if not all(c in range(256) for c in color): | ||
| raise ValueError(f"Invalid color tuple: {color}") | ||
| return f"{rgb_code};2;{';'.join([str(c) for c in color])};" | ||
| raise TypeError(f"Invalid color type: {type(color)}") | ||
|
|
||
| style_str = "" | ||
| if text_styles: | ||
| if isinstance(text_styles, (str, int)): | ||
| text_styles = [text_styles] | ||
| if not isinstance(text_styles, list): | ||
| raise TypeError("styles must be a string, an integer, or a list of strings or integers") | ||
| for text_style in text_styles: | ||
| if isinstance(text_style, int): | ||
| if text_style not in range(10): | ||
| raise ValueError(f"Invalid style code: {text_style}") | ||
| text_style_code = str(text_style) | ||
| elif isinstance(text_style, str): | ||
| if text_style not in _TEXT_STYLE: | ||
| raise ValueError(f"Invalid style name: {text_style}") | ||
| text_style_code = _TEXT_STYLE[text_style] | ||
| else: | ||
| raise TypeError(f"Invalid style type: {type(text_style)}") | ||
| style_str += f"{text_style_code};" | ||
| if text_color: | ||
| style_str += add_color(text_color, bg=False) | ||
| if background_color: | ||
| style_str += add_color(background_color, bg=True) | ||
| if not style_str: | ||
| return RESET | ||
| return _TEMPLATE.format(style_str.removesuffix(";")) | ||
|
|
||
|
|
||
| def format(text, control_sequence: str): | ||
| return f"{control_sequence}{text}{RESET}" | ||
|
|
||
|
|
||
| def remove_format(text: str): | ||
| """ | ||
| Remove ANSI escape sequences from a string. | ||
| Parameters | ||
| ---------- | ||
| text | ||
| Notes | ||
| ----- | ||
| ANSI escape codes start with the \033 (\x1b) escape character, | ||
| followed by '[', then zero or more numbers separated by ';', and ending with a letter. | ||
| Regex Details: | ||
| - [0-?]*: This part matches zero or more characters in the range between 0 and ?. | ||
| This covers all the numbers and semicolons that might be present in the escape sequence. | ||
| For example, in the code \x1b[31;42m, 31 and 42 are matched by this part. | ||
| - [ -/]*: This is a sequence of characters that might appear in some of the ANSI sequences. | ||
| It's more of a catch-all for certain sequences and may not be strictly necessary for many common sequences. | ||
| But it ensures we catch even those rare ANSI codes. | ||
| - [@-~]: Finally, ANSI escape sequences end with a character from @ to ~: | ||
| @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z | ||
| [ \ ] ^ _ ` a b c d e f g h i j k l m n o p q r s t u v w x y z {. | ||
| This part matches that ending character. This character typically indicates what action | ||
| should be taken (e.g., change color, move cursor, clear screen, etc.). | ||
| """ | ||
| return re.compile(r'\x1b\[[0-?]*[ -/]*[@-~]').sub('', text) |