txtwrap 1.1.1__tar.gz → 1.2.0__tar.gz

{txtwrap-1.1.1/txtwrap.egg-info → txtwrap-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: txtwrap
-Version: 1.1.1
+Version: 1.2.0
 Summary: A simple text wrapping tool.
 Author: azzammuhyala
 License: MIT
@@ -18,16 +18,18 @@ A tool for wrapping a text.🔨
 > **⚠️All documents are in the each module.⚠️**
 
 All constants and functions❕:
-- `LOREM_IPSUM_W`
-- `LOREM_IPSUM_S`
-- `LOREM_IPSUM_P`
-- `mono`
-- `word`
-- `wrap`
-- `align` (Updated!)
-- `fillstr`
-- `printwrap`
-- `shorten`
+- `LOREM_IPSUM_WORDS` (same as `LOREM_IPSUM_W`)
+- `LOREM_IPSUM_SENTENCES` (same as `LOREM_IPSUM_S`)
+- `LOREM_IPSUM_PARAGRAPHS` (same as `LOREM_IPSUM_P`)
+- `mono` (Fixed)
+- `word` (Fixed)
+- `wrap` (Fixed)
+- `align` (Updated)
+- `fillstr` (Updated)
+- `printwrap` (Updated)
+- `indent` (New)
+- `dedent` (New)
+- `shorten` (Fixed)
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -38,7 +40,7 @@ Examples❓:
 ## Render a wrap text in PyGame🎮
 ```py
 from typing import Literal, Optional
-from txtwrap import align, LOREM_IPSUM_P
+from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
 import pygame
 
 def render_wrap(
@@ -57,9 +59,8 @@ def render_wrap(
 
 ) -> pygame.Surface:
 
-    # Only supports in txtwrap 1.1.1+
     align_info = align(
-        text=text,
+        text_or_wrapped=str(text),
         width=width,
         linegap=linegap,
         sizefunc=font.size,
@@ -90,7 +91,7 @@ screen = pygame.display.set_mode((wscrn, hscrn))
 clock = pygame.time.Clock()
 surface = render_wrap(
     font=pygame.font.Font(None, 20),
-    text=LOREM_IPSUM_P,
+    text=LOREM_IPSUM_PARAGRAPHS,
     width=wscrn,
     antialias=True,
     color='#ffffff',
@@ -113,24 +114,22 @@ while running:
 
 ## Print a wrap text to terminal🔡
 ```py
-# Only supports in txtwrap 1.1.0+
-from txtwrap import printwrap, LOREM_IPSUM_W
+from txtwrap import printwrap, LOREM_IPSUM_WORDS
 
-printwrap(LOREM_IPSUM_W, width=20, alignment='left')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='left')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='center')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='center')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='right')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='right')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='fill')
 ```
 
 ## Short a long text🔤
 ```py
-from txtwrap import shorten, LOREM_IPSUM_S
+from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
-# Only supports in txtwrap 1.1.0+
+short_lorem = shorten(LOREM_IPSUM_SENTENCES, width=20, placeholder='…')
 test = shorten('   Helllo,   \t\r\n World!!  \f', width=20, placeholder='…', strip_space=True)
 
 print(short_lorem)
@@ -143,18 +142,17 @@ print(test)
 
 from re import compile
 from random import randint
-from txtwrap import printwrap, LOREM_IPSUM_P
+from txtwrap import printwrap, LOREM_IPSUM_PARAGRAPHS
 
 # Set the text to be printed here
-text = LOREM_IPSUM_P
+text = LOREM_IPSUM_PARAGRAPHS
 
-remove_ansi_regex = compile(r'\x1b\[[0-9;]*[mK]').sub
+remove_ansi_regex = compile(r'\x1b\[(K|.*?m)').sub
 
 def ralen(s: str) -> int:
     return len(remove_ansi_regex('', s))
 
 while True:
-    # Only supports in txtwrap 1.1.0+
     printwrap(
         ''.join(f'\x1b[{randint(31, 36)}m{char}' for char in text) + '\x1b[0m',
         end='\x1b[H\x1b[J',

{txtwrap-1.1.1 → txtwrap-1.2.0}/README.md

@@ -4,16 +4,18 @@ A tool for wrapping a text.🔨
 > **⚠️All documents are in the each module.⚠️**
 
 All constants and functions❕:
-- `LOREM_IPSUM_W`
-- `LOREM_IPSUM_S`
-- `LOREM_IPSUM_P`
-- `mono`
-- `word`
-- `wrap`
-- `align` (Updated!)
-- `fillstr`
-- `printwrap`
-- `shorten`
+- `LOREM_IPSUM_WORDS` (same as `LOREM_IPSUM_W`)
+- `LOREM_IPSUM_SENTENCES` (same as `LOREM_IPSUM_S`)
+- `LOREM_IPSUM_PARAGRAPHS` (same as `LOREM_IPSUM_P`)
+- `mono` (Fixed)
+- `word` (Fixed)
+- `wrap` (Fixed)
+- `align` (Updated)
+- `fillstr` (Updated)
+- `printwrap` (Updated)
+- `indent` (New)
+- `dedent` (New)
+- `shorten` (Fixed)
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -24,7 +26,7 @@ Examples❓:
 ## Render a wrap text in PyGame🎮
 ```py
 from typing import Literal, Optional
-from txtwrap import align, LOREM_IPSUM_P
+from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
 import pygame
 
 def render_wrap(
@@ -43,9 +45,8 @@ def render_wrap(
 
 ) -> pygame.Surface:
 
-    # Only supports in txtwrap 1.1.1+
     align_info = align(
-        text=text,
+        text_or_wrapped=str(text),
         width=width,
         linegap=linegap,
         sizefunc=font.size,
@@ -76,7 +77,7 @@ screen = pygame.display.set_mode((wscrn, hscrn))
 clock = pygame.time.Clock()
 surface = render_wrap(
     font=pygame.font.Font(None, 20),
-    text=LOREM_IPSUM_P,
+    text=LOREM_IPSUM_PARAGRAPHS,
     width=wscrn,
     antialias=True,
     color='#ffffff',
@@ -99,24 +100,22 @@ while running:
 
 ## Print a wrap text to terminal🔡
 ```py
-# Only supports in txtwrap 1.1.0+
-from txtwrap import printwrap, LOREM_IPSUM_W
+from txtwrap import printwrap, LOREM_IPSUM_WORDS
 
-printwrap(LOREM_IPSUM_W, width=20, alignment='left')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='left')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='center')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='center')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='right')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='right')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='fill')
 ```
 
 ## Short a long text🔤
 ```py
-from txtwrap import shorten, LOREM_IPSUM_S
+from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
-# Only supports in txtwrap 1.1.0+
+short_lorem = shorten(LOREM_IPSUM_SENTENCES, width=20, placeholder='…')
 test = shorten('   Helllo,   \t\r\n World!!  \f', width=20, placeholder='…', strip_space=True)
 
 print(short_lorem)
@@ -129,18 +128,17 @@ print(test)
 
 from re import compile
 from random import randint
-from txtwrap import printwrap, LOREM_IPSUM_P
+from txtwrap import printwrap, LOREM_IPSUM_PARAGRAPHS
 
 # Set the text to be printed here
-text = LOREM_IPSUM_P
+text = LOREM_IPSUM_PARAGRAPHS
 
-remove_ansi_regex = compile(r'\x1b\[[0-9;]*[mK]').sub
+remove_ansi_regex = compile(r'\x1b\[(K|.*?m)').sub
 
 def ralen(s: str) -> int:
     return len(remove_ansi_regex('', s))
 
 while True:
-    # Only supports in txtwrap 1.1.0+
     printwrap(
         ''.join(f'\x1b[{randint(31, 36)}m{char}' for char in text) + '\x1b[0m',
         end='\x1b[H\x1b[J',

{txtwrap-1.1.1 → txtwrap-1.2.0}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', encoding='utf-8') as readme:
 
 setup(
     name='txtwrap',
-    version='1.1.1',
+    version='1.2.0',
     description='A simple text wrapping tool.',
     long_description=long_description,
     long_description_content_type='text/markdown',

{txtwrap-1.1.1 → txtwrap-1.2.0}/txtwrap/__init__.py

@@ -6,8 +6,9 @@ A simple text wrapping tool
 
 from .txtwrap import (
     version,
-    LOREM_IPSUM_W, LOREM_IPSUM_S, LOREM_IPSUM_P,
+    LOREM_IPSUM_WORDS, LOREM_IPSUM_SENTENCES, LOREM_IPSUM_PARAGRAPHS,
     mono, word, wrap, align, fillstr, printwrap,
+    indent, dedent,
     shorten
 )
 
@@ -15,14 +16,16 @@ __version__ = version
 __author__ = 'azzammuhyala'
 __license__ = 'MIT'
 __all__ = [
-    'LOREM_IPSUM_W',
-    'LOREM_IPSUM_S',
-    'LOREM_IPSUM_P',
+    'LOREM_IPSUM_WORDS',
+    'LOREM_IPSUM_SENTENCES',
+    'LOREM_IPSUM_PARAGRAPHS',
     'mono',
     'word',
     'wrap',
     'align',
     'fillstr',
     'printwrap',
+    'indent',
+    'dedent',
     'shorten'
 ]

{txtwrap-1.1.1 → txtwrap-1.2.0}/txtwrap/__main__.py

@@ -1,8 +1,19 @@
 from argparse import ArgumentParser
-from txtwrap import version, printwrap, shorten
+from os import name, get_terminal_size
+from txtwrap import version, printwrap, indent, dedent, shorten
+
+if name == 'nt':
+    pyname = 'python|py'
+elif name == 'posix':
+    pyname = 'python3'
+else:
+    pyname = 'python'
 
 parser = ArgumentParser(
-    description='Command-line tool for wrapping, aligning, or shortening text.'
+    prog='txtwrap',
+    description='Command-line tool for wrapping, aligning, or shortening text.',
+    epilog=f'for example: {pyname} -m txtwrap "Lorem ipsum odor amet, consectetuer adipiscing '
+            'elit." -w 20 -m word -a center'
 )
 
 parser.add_argument(
@@ -37,9 +48,9 @@ parser.add_argument(
 parser.add_argument(
     '-m', '--method',
     type=str,
-    choices={'word', 'mono', 'shorten'},
+    choices={'word', 'mono', 'indent', 'dedent', 'shorten'},
     default='word',
-    metavar='{word|mono|shorten}',
+    metavar='{word|mono|indent|dedent|shorten}',
     help='Method to be applied to the text (default: "word")'
 )
 
@@ -58,6 +69,14 @@ parser.add_argument(
     help='Neglect empty lines in the text'
 )
 
+parser.add_argument(
+    '-x', '--prefix',
+    type=str,
+    default=None,
+    metavar='<str>',
+    help='Prefix to be added (indent) or remove (dedent) to the text'
+)
+
 parser.add_argument(
     '-s', '--start',
     type=int,
@@ -82,15 +101,18 @@ parser.add_argument(
 
 args = parser.parse_args()
 
-if args.method == 'shorten':
-    from os import get_terminal_size
-
+if args.method == 'indent':
+    if args.prefix is None:
+        raise ValueError('The prefix (-x, --prefix) is required for the indent method')
+    print(indent(args.text, args.prefix))
+elif args.method == 'dedent':
+    print(dedent(args.text, args.prefix))
+elif args.method == 'shorten':
     if args.width is None:
         try:
             args.width = get_terminal_size().columns
         except:
             args.width = 70
-
     print(
         shorten(
             text=args.text,

{txtwrap-1.1.1 → txtwrap-1.2.0}/txtwrap/txtwrap.py

@@ -1,47 +1,46 @@
-from typing import Any, Callable, Dict, List, Literal, Optional, Tuple, Union
+from typing import Any, Callable, Dict, List, Literal, Optional, Sequence, Tuple, Union
 from os import get_terminal_size
 from re import compile
 
 hyphenated_regex = compile(r'(?<=-)(?=(?!-).)')
-version = '1.1.1'
-
-LOREM_IPSUM_W = 'Lorem ipsum odor amet, consectetuer adipiscing elit.'
-LOREM_IPSUM_S = ('Lorem ipsum odor amet, consectetuer adipiscing elit. In malesuada eros natoque '
-                 'urna felis diam aptent donec. Cubilia libero morbi fusce tempus, luctus aenean '
-                 'augue. Mus senectus rutrum phasellus fusce dictum platea. Eros a integer nec '
-                 'fusce erat urna.')
-LOREM_IPSUM_P = ('Lorem ipsum odor amet, consectetuer adipiscing elit. Nulla porta ex condimentum '
-                 'velit facilisi; consequat congue. Tristique duis sociosqu aliquam semper sit id. '
-                 'Nisi morbi purus, nascetur elit pellentesque venenatis. Velit commodo molestie '
-                 'potenti placerat faucibus convallis. Himenaeos dapibus ipsum natoque nam dapibus '
-                 'habitasse diam. Viverra ac porttitor cras tempor cras. Pharetra habitant nibh '
-                 'dui ipsum scelerisque cras? Efficitur phasellus etiam congue taciti tortor quam. '
-                 'Volutpat quam vulputate condimentum hendrerit justo congue iaculis nisl nullam.'
-                 '\n\nInceptos tempus nostra fringilla arcu; tellus blandit facilisi risus. Platea '
-                 'bibendum tristique lectus nunc placerat id aliquam. Eu arcu nisl mattis potenti '
-                 'elementum. Dignissim vivamus montes volutpat litora felis fusce ultrices. '
-                 'Vulputate magna nascetur bibendum inceptos scelerisque morbi posuere. Consequat '
-                 'dolor netus augue augue tristique curabitur habitasse bibendum. Consectetur est '
-                 'per eros semper, magnis interdum libero. Arcu adipiscing litora metus fringilla '
-                 'varius gravida congue tellus adipiscing. Blandit nulla mauris nullam ante metus '
-                 'curae scelerisque.\n\nSem varius sodales ut volutpat imperdiet turpis primis '
-                 'nullam. At gravida tincidunt phasellus lacus duis integer eros penatibus. '
-                 'Interdum mauris molestie posuere nascetur dignissim himenaeos; magna et quisque. '
-                 'Dignissim malesuada etiam donec vehicula aliquet bibendum. Magna dapibus sapien '
-                 'semper parturient id dis? Pretium orci ante leo, porta tincidunt molestie. '
-                 'Malesuada dictumst commodo consequat interdum nisi fusce cras rhoncus feugiat.'
-                 '\n\nHimenaeos mattis commodo suspendisse maecenas cras arcu. Habitasse id '
-                 'facilisi praesent justo molestie felis luctus suspendisse. Imperdiet ipsum '
-                 'praesent nunc mauris mattis curabitur. Et consectetur morbi auctor feugiat enim '
-                 'ridiculus arcu. Ultricies magna blandit eget; vivamus sollicitudin nisl proin. '
-                 'Sollicitudin sociosqu et finibus elit vestibulum sapien nec odio euismod. Turpis '
-                 'eleifend amet quis auctor cursus. Vehicula pharetra sapien praesent amet purus '
-                 'ante. Risus blandit cubilia lorem hendrerit penatibus in magnis.\n\nAmet posuere '
-                 'nunc; maecenas consequat risus potenti. Volutpat leo lacinia sapien nulla '
-                 'sagittis dignissim mauris ultrices aliquet. Nisi pretium interdum luctus donec '
-                 'magna suscipit. Dapibus tristique felis natoque malesuada augue? Justo faucibus '
-                 'tincidunt congue arcu sem; fusce aliquet proin. Commodo neque nibh; tempus ad '
-                 'tortor netus. Mattis ultricies nec maximus porttitor non mauris?')
+version = '1.2.0'
+
+LOREM_IPSUM_WORDS = 'Lorem ipsum odor amet, consectetuer adipiscing elit.'
+LOREM_IPSUM_SENTENCES = (
+    'Lorem ipsum odor amet, consectetuer adipiscing elit. In malesuada eros natoque urna felis '
+    'diam aptent donec. Cubilia libero morbi fusce tempus, luctus aenean augue. Mus senectus '
+    'rutrum phasellus fusce dictum platea. Eros a integer nec fusce erat urna.'
+)
+LOREM_IPSUM_PARAGRAPHS = (
+    'Lorem ipsum odor amet, consectetuer adipiscing elit. Nulla porta ex condimentum velit '
+    'facilisi; consequat congue. Tristique duis sociosqu aliquam semper sit id. Nisi morbi purus, '
+    'nascetur elit pellentesque venenatis. Velit commodo molestie potenti placerat faucibus '
+    'convallis. Himenaeos dapibus ipsum natoque nam dapibus habitasse diam. Viverra ac porttitor '
+    'cras tempor cras. Pharetra habitant nibh dui ipsum scelerisque cras? Efficitur phasellus '
+    'etiam congue taciti tortor quam. Volutpat quam vulputate condimentum hendrerit justo congue '
+    'iaculis nisl nullam.\n\nInceptos tempus nostra fringilla arcu; tellus blandit facilisi risus. '
+    'Platea bibendum tristique lectus nunc placerat id aliquam. Eu arcu nisl mattis potenti '
+    'elementum. Dignissim vivamus montes volutpat litora felis fusce ultrices. Vulputate magna '
+    'nascetur bibendum inceptos scelerisque morbi posuere. Consequat dolor netus augue augue '
+    'tristique curabitur habitasse bibendum. Consectetur est per eros semper, magnis interdum '
+    'libero. Arcu adipiscing litora metus fringilla varius gravida congue tellus adipiscing. '
+    'Blandit nulla mauris nullam ante metus curae scelerisque.\n\nSem varius sodales ut volutpat '
+    'imperdiet turpis primis nullam. At gravida tincidunt phasellus lacus duis integer eros '
+    'penatibus. Interdum mauris molestie posuere nascetur dignissim himenaeos; magna et quisque. '
+    'Dignissim malesuada etiam donec vehicula aliquet bibendum. Magna dapibus sapien semper '
+    'parturient id dis? Pretium orci ante leo, porta tincidunt molestie. Malesuada dictumst '
+    'commodo consequat interdum nisi fusce cras rhoncus feugiat.\n\nHimenaeos mattis commodo '
+    'suspendisse maecenas cras arcu. Habitasse id facilisi praesent justo molestie felis luctus '
+    'suspendisse. Imperdiet ipsum praesent nunc mauris mattis curabitur. Et consectetur morbi '
+    'auctor feugiat enim ridiculus arcu. Ultricies magna blandit eget; vivamus sollicitudin nisl '
+    'proin. Sollicitudin sociosqu et finibus elit vestibulum sapien nec odio euismod. Turpis '
+    'eleifend amet quis auctor cursus. Vehicula pharetra sapien praesent amet purus ante. Risus '
+    'blandit cubilia lorem hendrerit penatibus in magnis.\n\nAmet posuere nunc; maecenas consequat '
+    'risus potenti. Volutpat leo lacinia sapien nulla sagittis dignissim mauris ultrices aliquet. '
+    'Nisi pretium interdum luctus donec magna suscipit. Dapibus tristique felis natoque malesuada '
+    'augue? Justo faucibus tincidunt congue arcu sem; fusce aliquet proin. Commodo neque nibh; '
+    'tempus ad tortor netus. Mattis ultricies nec maximus porttitor non mauris?'
+)
 
 def mono(
 
@@ -64,11 +63,14 @@ def mono(
         list[str]: A list of strings, where each string is a line of the wrapped text.
     """
 
-    assert isinstance(text, str), "text must be a string"
-    assert isinstance(width, (int, float)), "width must be an integer or float"
-    assert callable(lenfunc), "lenfunc must be a callable function"
-
-    assert width > 0, "width must be greater than 0"
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+    if not isinstance(width, (int, float)):
+        raise TypeError("width must be an integer or float")
+    if not callable(lenfunc):
+        raise TypeError("lenfunc must be a callable function")
+    if width <= 0:
+        raise ValueError("width must be greater than 0")
 
     parts = []
     current_char = ''
@@ -106,11 +108,14 @@ def word(
         list[str]: A list of strings, where each string is a line of wrapped text.
     """
 
-    assert isinstance(text, str), "text must be a string"
-    assert isinstance(width, (int, float)), "width must be an integer or float"
-    assert callable(lenfunc), "lenfunc must be a callable function"
-
-    assert width > 0, "width must be greater than 0"
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+    if not isinstance(width, (int, float)):
+        raise TypeError("width must be an integer or float")
+    if not callable(lenfunc):
+        raise TypeError("lenfunc must be a callable function")
+    if width <= 0:
+        raise ValueError("width must be greater than 0")
 
     lines = []
     current_line = ''
@@ -167,11 +172,14 @@ def wrap(
         list[str]: A list of wrapped lines.
     """
 
-    assert isinstance(text, str), "text must be a string"
-    assert isinstance(width, (int, float)), "width must be an integer or float"
-    assert callable(lenfunc), "lenfunc must be a callable function"
-
-    assert width > 0, "width must be greater than 0"
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+    if not isinstance(width, (int, float)):
+        raise TypeError("width must be an integer or float")
+    if not callable(lenfunc):
+        raise TypeError("lenfunc must be a callable function")
+    if width <= 0:
+        raise ValueError("width must be greater than 0")
 
     wrapped_lines = []
 
@@ -193,7 +201,7 @@ def wrap(
 
 def align(
 
-    text: str,
+    text_or_wrapped: Union[str, Sequence[str]],
     width: Union[int, float] = 70,
     linegap: Union[int, float] = 0,
     sizefunc: Callable[[str], Tuple[Union[int, float], Union[int, float]]] = lambda s : (len(s), 1),
@@ -210,7 +218,8 @@ def align(
     Wraps and aligns text within a specified width and yields the position and content of each line.
 
     Parameters:
-        text (str): The text to be wrapped and aligned.
+        text_or_wrapped (str | Sequence[str]): The text to be wrapped and aligned, or a sequence of
+                                               wrapped lines.
         width (int | float, optional): The maximum width of each line. Defaults to 70.
         linegap (int | float, optional): The vertical gap between lines. Defaults to 0.
         sizefunc (Callable[[str], tuple[int | float, int | float]], optional): A function that
@@ -235,20 +244,28 @@ def align(
                                          Defaults to False.
 
     Returns:
-        list[tuple[int | float, int | float, str] |
-             dict[Literal['aligned', 'wrapped', 'size'], Any]]: A list of tuples containing the
-                                                                position and content of each line.
-                                                                If return_details, a dictionary
-                                                                containing the wrapped text, and
-                                                                the size is returned.
+        list[tuple[int | float, int | float, str]] |
+        dict[Literal['aligned', 'wrapped', 'size'], Any]: A list of tuples containing the position
+                                                          and content of each line.
+                                                          If return_details, a dictionary containing
+                                                          the wrapped text, and the size is
+                                                          returned.
     """
 
-    assert isinstance(linegap, (int, float)), "linegap must be an integer or float"
-    assert callable(sizefunc), "sizefunc must be a callable function"
-
-    assert linegap >= 0, "linegap must be equal to or greater than 0"
+    if not isinstance(linegap, (int, float)):
+        raise TypeError("linegap must be an integer or a float")
+    if not callable(sizefunc):
+        raise TypeError("sizefunc must be a callable function")
+    if linegap < 0:
+        raise ValueError("linegap must be equal to or greater than 0")
+
+    if isinstance(text_or_wrapped, str):
+        wrapped = wrap(text_or_wrapped, width, lambda s : sizefunc(s)[0], method, preserve_empty)
+    elif isinstance(text_or_wrapped, Sequence):
+        wrapped = text_or_wrapped
+    else:
+        raise TypeError("text_or_wrapped must be a string or a sequence of strings")
 
-    wrapped = wrap(text, width, lambda s : sizefunc(s)[0], method, preserve_empty)
     size_wrapped = {i: sizefunc(line) for i, line in enumerate(wrapped)}
     aligned_positions = []
     offset_y = 0
@@ -306,7 +323,7 @@ def align(
         if use_min_width and alignment == 'fill':
             if no_spaces:
                 size_width = max_width
-            elif text:
+            elif text_or_wrapped:
                 size_width = width
             else:
                 size_width = 0
@@ -323,10 +340,10 @@ def align(
 
 def fillstr(
 
-    text: str,
-    width: Union[int, float] = 70,
+    text_or_wrapped: Union[str, Sequence[str]],
+    width: int = 70,
     fill: str = ' ',
-    lenfunc: Callable[[str], Union[int, float]] = len,
+    lenfunc: Callable[[str], int] = len,
     method: Literal['mono', 'word'] = 'word',
     alignment: Union[Callable[[str], str], Literal['left', 'center', 'right', 'fill']] = 'left',
     preserve_empty: bool = True
@@ -337,30 +354,39 @@ def fillstr(
     String formats a given text to fit within a specified width, using various alignment methods.
 
     Parameters:
-        text (str): The text to be formatted.
-        width (Union[int, float], optional): The width of the formatted text. Defaults to 70.
+        text_or_wrapped (str | Sequence[str]): The text to be formatted, or a sequence of wrapped
+                                               lines.
+        width (int, optional): The width of the formatted text. Defaults to 70.
         fill (str, optional): The character used to fill the space. Must be a single character.
                               Defaults to ' '.
-        lenfunc (Callable[[str], Union[int, float]], optional): A function to calculate the
-                                                                length of a string. Defaults to len.
+        lenfunc (Callable[[str], int], optional): A function to calculate the length of a string.
+                                                  Defaults to len.
         method (Literal['mono', 'word'], optional): The method to use for wrapping.
                                                     'mono' for character-based wrapping, 'word'
                                                     for word-based wrapping. Defaults to 'word'.
-        alignment (Union[Callable[[str], str],
-                   Literal['left', 'center', 'right', 'fill']], optional): The alignment of the
-                                                                           text. 'left', 'center',
-                                                                           'right', or 'fill'.
-                                                                           Defaults to 'left'.
+        alignment (Callable[[str], str] |
+                   Literal['left', 'center', 'right', 'fill'], optional): The alignment of the
+                                                                          text. 'left', 'center',
+                                                                          'right', or 'fill'.
+                                                                          Defaults to 'left'.
         preserve_empty (bool, optional): Whether to preserve empty lines. Defaults to True.
 
     Returns:
         str: The formatted text.
     """
 
-    assert isinstance(fill, str), "fill must be a string"
-    assert len(fill) == 1, "fill must be a single character"
+    if not isinstance(fill, str):
+        raise TypeError("fill must be a string")
+    if lenfunc(fill) != 1:
+        raise ValueError("fill must be a single character")
+
+    if isinstance(text_or_wrapped, str):
+        wrapped = wrap(text_or_wrapped, width, lenfunc, method, preserve_empty)
+    elif isinstance(text_or_wrapped, Sequence):
+        wrapped = text_or_wrapped
+    else:
+        raise TypeError("text_or_wrapped must be a string or a sequence of strings")
 
-    wrapped = wrap(text, width, lenfunc, method, preserve_empty)
     justified_lines = ''
 
     if callable(alignment):
@@ -417,12 +443,13 @@ def printwrap(
     end: Optional[str] = '\n',
     fill: str = ' ',
     width: Optional[int] = None,
-    lenfunc: Callable[[str], Union[int, float]] = len,
+    lenfunc: Callable[[str], int] = len,
     method: Literal['word', 'mono'] = 'word',
     alignment: Union[Callable[[str], str], Literal['left', 'center', 'right', 'fill']] = 'left',
     file: Optional[object] = None,
     flush: bool = False,
-    preserve_empty: bool = True
+    preserve_empty: bool = True,
+    is_wrapped: bool = False
 
 ) -> None:
 
@@ -436,18 +463,19 @@ def printwrap(
         fill (str): Fill character for padding. Default to ' '.
         width (Optional[int]): Width of the output. If None, it tries to use the terminal width or
                                defaults to 70.
-        lenfunc (Callable[[str], Union[int, float]]): Function to calculate the length of a string.
-                                                      Default is len.
+        lenfunc (Callable[[str], int]): Function to calculate the length of a string.
+                                        Default is len.
         method (Literal['word', 'mono']): The method to use for wrapping. 'mono' for character-based
                                           wrapping, 'word' for word-based wrapping.
                                           Defaults to 'word'.
-        alignment (Union[Callable[[str], str],
-                   Literal['left', 'center', 'right', 'fill']]): Alignment of the text.
-                                                                 Default is 'left'.
+        alignment (Callable[[str], str] |
+                   Literal['left', 'center', 'right', 'fill']): Alignment of the text.
+                                                                Default is 'left'.
         file (Optional[object]): A file-like object (stream) to write the output to.
                                  Default is None, which means sys.stdout.
         flush (bool): Whether to forcibly flush the stream. Default is False.
         preserve_empty (bool, optional): Whether to preserve empty lines. Defaults to True.
+        is_wrapped (bool, optional): Whether the values are already wrapped. Defaults to False.
     """
 
     if width is None:
@@ -456,9 +484,11 @@ def printwrap(
         except:
             width = 70
 
+    map_values = map(str, values)
+
     print(
         fillstr(
-            (' ' if sep is None else sep).join(map(str, values)),
+            map_values if is_wrapped else (' ' if sep is None else sep).join(map_values),
             width,
             fill,
             lenfunc,
@@ -471,6 +501,70 @@ def printwrap(
         flush=flush
     )
 
+def indent(
+
+    text: str,
+    prefix: str,
+    predicate: Callable[[str], bool] = lambda line: line.strip()
+
+) -> str:
+
+    """
+    Adds a specified prefix to each line of the given text that satisfies the predicate.
+
+    Parameters:
+        text (str): The input text to be processed.
+        prefix (str): The prefix to add to each line.
+        predicate (Callable[[str], bool], optional): A function that determines whether a line
+                                                     should be prefixed. Defaults to a lambda
+                                                     function that returns True for non-empty lines.
+
+    Returns:
+        str: The processed text with the prefix added to each line that satisfies the predicate.
+    """
+
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+    if not isinstance(prefix, str):
+        raise TypeError("prefix must be a string")
+    if not callable(predicate):
+        raise TypeError("predicate must be a callable function")
+
+    return '\n'.join(prefix + line for line in text.splitlines() if predicate(line))
+
+def dedent(
+
+    text: str,
+    prefix: Optional[str] = None,
+    predicate: Callable[[str], bool] = lambda line: line.strip()
+
+) -> str:
+
+    """
+    Remove any leading whitespace from each line in the given text.
+
+    Parameters:
+        text (str): The input text from which to remove leading whitespace.
+        prefix (Optional[str], optional): A prefix to remove from the start of each line.
+                                          Defaults to None (remove all leading whitespace).
+        predicate (Callable[[str], bool], optional): A function that determines whether a line
+                                                     should be processed. Defaults to a
+                                                     lambda function that returns True for
+                                                     non-empty lines.
+
+    Returns:
+        str: The text with leading whitespace removed from each line.
+    """
+
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+    if not isinstance(prefix, (str, type(None))):
+        raise TypeError("prefix must be a string")
+    if not callable(predicate):
+        raise TypeError("predicate must be a callable function")
+
+    return '\n'.join(line.lstrip(prefix) for line in text.splitlines() if predicate(line))
+
 def shorten(
 
     text: str,
@@ -499,14 +593,20 @@ def shorten(
         str: The shortened text with the placeholder appended if necessary.
     """
 
-    assert isinstance(text, str), "text must be a string"
-    assert isinstance(width, (int, float)), "width must be an integer or float"
-    assert isinstance(start, int), "start must be an integer"
-    assert callable(lenfunc), "lenfunc must be a callable function"
-    assert isinstance(placeholder, str), "placeholder must be a string"
-
-    assert width >= lenfunc(placeholder), "width must be greater than length of the placeholder"
-    assert start >= 0, "start must be equal to or greater than 0"
+    if not isinstance(text, str):
+        raise TypeError("text must be a string")
+    if not isinstance(width, (int, float)):
+        raise TypeError("width must be an integer or float")
+    if not isinstance(start, int):
+        raise TypeError("start must be an integer")
+    if not callable(lenfunc):
+        raise TypeError("lenfunc must be a callable function")
+    if not isinstance(placeholder, str):
+        raise TypeError("placeholder must be a string")
+    if width < lenfunc(placeholder):
+        raise ValueError("width must be greater than length of the placeholder")
+    if start < 0:
+        raise ValueError("start must be equal to or greater than 0")
 
     if strip_space:
         text = ' '.join(text.split())

{txtwrap-1.1.1 → txtwrap-1.2.0/txtwrap.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: txtwrap
-Version: 1.1.1
+Version: 1.2.0
 Summary: A simple text wrapping tool.
 Author: azzammuhyala
 License: MIT
@@ -18,16 +18,18 @@ A tool for wrapping a text.🔨
 > **⚠️All documents are in the each module.⚠️**
 
 All constants and functions❕:
-- `LOREM_IPSUM_W`
-- `LOREM_IPSUM_S`
-- `LOREM_IPSUM_P`
-- `mono`
-- `word`
-- `wrap`
-- `align` (Updated!)
-- `fillstr`
-- `printwrap`
-- `shorten`
+- `LOREM_IPSUM_WORDS` (same as `LOREM_IPSUM_W`)
+- `LOREM_IPSUM_SENTENCES` (same as `LOREM_IPSUM_S`)
+- `LOREM_IPSUM_PARAGRAPHS` (same as `LOREM_IPSUM_P`)
+- `mono` (Fixed)
+- `word` (Fixed)
+- `wrap` (Fixed)
+- `align` (Updated)
+- `fillstr` (Updated)
+- `printwrap` (Updated)
+- `indent` (New)
+- `dedent` (New)
+- `shorten` (Fixed)
 
 Mod `python -m txtwrap` Commands❗:
 ```shell
@@ -38,7 +40,7 @@ Examples❓:
 ## Render a wrap text in PyGame🎮
 ```py
 from typing import Literal, Optional
-from txtwrap import align, LOREM_IPSUM_P
+from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
 import pygame
 
 def render_wrap(
@@ -57,9 +59,8 @@ def render_wrap(
 
 ) -> pygame.Surface:
 
-    # Only supports in txtwrap 1.1.1+
     align_info = align(
-        text=text,
+        text_or_wrapped=str(text),
         width=width,
         linegap=linegap,
         sizefunc=font.size,
@@ -90,7 +91,7 @@ screen = pygame.display.set_mode((wscrn, hscrn))
 clock = pygame.time.Clock()
 surface = render_wrap(
     font=pygame.font.Font(None, 20),
-    text=LOREM_IPSUM_P,
+    text=LOREM_IPSUM_PARAGRAPHS,
     width=wscrn,
     antialias=True,
     color='#ffffff',
@@ -113,24 +114,22 @@ while running:
 
 ## Print a wrap text to terminal🔡
 ```py
-# Only supports in txtwrap 1.1.0+
-from txtwrap import printwrap, LOREM_IPSUM_W
+from txtwrap import printwrap, LOREM_IPSUM_WORDS
 
-printwrap(LOREM_IPSUM_W, width=20, alignment='left')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='left')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='center')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='center')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='right')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='right')
 print('=' * 20)
-printwrap(LOREM_IPSUM_W, width=20, alignment='fill')
+printwrap(LOREM_IPSUM_WORDS, width=20, alignment='fill')
 ```
 
 ## Short a long text🔤
 ```py
-from txtwrap import shorten, LOREM_IPSUM_S
+from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-short_lorem = shorten(LOREM_IPSUM_S, width=20, placeholder='…')
-# Only supports in txtwrap 1.1.0+
+short_lorem = shorten(LOREM_IPSUM_SENTENCES, width=20, placeholder='…')
 test = shorten('   Helllo,   \t\r\n World!!  \f', width=20, placeholder='…', strip_space=True)
 
 print(short_lorem)
@@ -143,18 +142,17 @@ print(test)
 
 from re import compile
 from random import randint
-from txtwrap import printwrap, LOREM_IPSUM_P
+from txtwrap import printwrap, LOREM_IPSUM_PARAGRAPHS
 
 # Set the text to be printed here
-text = LOREM_IPSUM_P
+text = LOREM_IPSUM_PARAGRAPHS
 
-remove_ansi_regex = compile(r'\x1b\[[0-9;]*[mK]').sub
+remove_ansi_regex = compile(r'\x1b\[(K|.*?m)').sub
 
 def ralen(s: str) -> int:
     return len(remove_ansi_regex('', s))
 
 while True:
-    # Only supports in txtwrap 1.1.0+
     printwrap(
         ''.join(f'\x1b[{randint(31, 36)}m{char}' for char in text) + '\x1b[0m',
         end='\x1b[H\x1b[J',