txtwrap 3.0.1__tar.gz → 3.1.0__tar.gz

{txtwrap-3.0.1/txtwrap.egg-info → txtwrap-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: txtwrap
-Version: 3.0.1
+Version: 3.1.0
 Summary: A tool for wrapping and filling text.
 Home-page: https://github.com/azzammuhyala/txtwrap
 Author: azzammuhyala
@@ -31,21 +31,22 @@ Dynamic: summary
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.1** <br>
+Package version: **3.1.0** <br>
 Python requires version: **>=3.0.0** <br>
 Python stub file requires version: **>=3.5.0** <br>
 
 - [`LOREM_IPSUM_WORDS`](#lorem-ipsum)
 - [`LOREM_IPSUM_SENTENCES`](#lorem-ipsum)
 - [`LOREM_IPSUM_PARAGRAPHS`](#lorem-ipsum)
-- [`SEPARATOR_WHITESPACE`](#separators)
-- [`SEPARATOR_ESCAPE`](#separators)
-- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
-- [`sanitize`](#sanitizetext) (🛠️ Fixed)
-- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
-- [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
-- [`fillstr`](#fillstrtext) (🛠️ Fixed)
-- [`shorten`](#shortentext) (🛠️ Fixed)
+- [`SEPARATOR_WHITESPACE`](#separators) (✅ Updated)
+- [`SEPARATOR_ESCAPE`](#separators) (✅ Updated)
+- [`SEPARATOR_NEWLINE`](#separators) (➕ New)
+- [`SEPARATOR_NEWLINE_AND_BREAK`](#separators) (➕ New)
+- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`align`](#aligntext-return_detailsfalse) (✅ Updated)
+- [`fillstr`](#fillstrtext) (✅ Updated)
+- [`shorten`](#shortentext) (✅ Updated)
 
 # Documents📄
 This module is inspired by the [`textwrap`](https://docs.python.org/3/library/textwrap.html) module, which provides
@@ -77,12 +78,14 @@ A _Lorem Ipsum_ collection of words, sentences, and paragraphs that can be used
 ```py
 SEPARATOR_WHITESPACE
 SEPARATOR_ESCAPE
+SEPARATOR_NEWLINE
+SEPARATOR_NEWLINE_AND_BREAK
 ```
 A collection of separators that can be used to separate text.
-- `SEPARATOR_WHITESPACE` contains whitespace characters.
-- `SEPARATOR_ESCAPE` contains whitespace characters including `'\0'`, `'\a'`, and `'\b'`.
-
-To use this, assign this constant to the [`separator`](#separator) parameter.
+- `SEPARATOR_WHITESPACE` (for [`word_separator`](#word_separator)) regex contains whitespace characters.
+- `SEPARATOR_ESCAPE` (for [`word_separator`](#word_separator)) regex contains whitespace characters including `'\a'`, `'\b'`, and `'\0'`.
+- `SEPARATOR_NEWLINE` (for [`newline_separator`](#newline_separator)) regex contains newline characters.
+- `SEPARATOR_NEWLINE_AND_BREAK` (for [`newline_separator`](#newline_separator)) regex contains newline characters including breaks tag `<br>`.
 
 <h1></h1>
 
@@ -99,15 +102,17 @@ class TextWrapper:
         mode: Literal['mono', 'word'] = 'word',
         alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
         placeholder: str = '...',
-        fillchar: str = ' ',
-        separator: Optional[Union[str, Iterable[str]]] = None,
+        space_character: str = ' ',
+        newline_character: str = '\n',
+        word_separator: Optional[Union[str, Tuple[str, int]]] = None,
+        newline_separator: Optional[Union[str, Tuple[str, int]]] = None,
         max_lines: Optional[int] = None,
-        preserve_empty_lines: bool = True,
+        empty_lines: bool = True,
         minimum_width: bool = True,
-        drop_separator: bool = False,
+        excess_word_separator: bool = False,
         justify_last_line: bool = False,
         break_on_hyphens: bool = True,
-        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
+        size_function: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
     ) -> None
 ```
 A class that handles all functions available in this module. Each keyword argument corresponds to its attribute.
@@ -120,9 +125,6 @@ is equivalent to:
 wrapper = TextWrapper()
 wrapper.width = 100
 ```
-You can reuse [`TextWrapper`](#textwrapper) multiple times or modify its options by assigning new values to its
-attributes. However, it is recommended not to reuse [`TextWrapper`](#textwrapper) too frequently inside a specific loop,
-as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
@@ -164,16 +166,29 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`fillchar`**
-(Default: `' '`) The character used for padding.
+#### **`space_character`**
+(Default: `' '`) The character used for padding and for the word separator character.
+
+<h1></h1>
+
+#### **`newline_character`**
+(Default: `'\n'`) The character used for line separator.
 
 <h1></h1>
 
-#### **`separator`**
+#### **`word_separator`**
 (Default: `None`) The character used to separate words.
 - `None`: Uses whitespace as the separator.
-- `str`: Uses the specified character.
-- `Iterable[str]`: Uses multiple specified characters.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
+
+<h1></h1>
+
+#### **`newline_separator`**
+(Default: `None`) The character used to separate lines.
+- `None`: Uses standard newline as the separator.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
 
 <h1></h1>
 
@@ -185,7 +200,7 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`preserve_empty_lines`**
+#### **`empty_lines`**
 (Default: `True`) Retains empty lines in the wrapped text.
 
 <h1></h1>
@@ -196,7 +211,7 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`drop_separator`**
+#### **`excess_word_separator`**
 (Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
@@ -212,7 +227,7 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`sizefunc`**
+#### **`size_function`**
 (Default: `None`) A function used to calculate the width and height or only the width of each string.
 
 If the function calculates both width and height, it must return a tuple containing two values:
@@ -243,18 +258,6 @@ Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (Externa
 
 <h1></h1>
 
-#### **`sanitize(text)`**
-Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
-
-For example:
-```py
->>> txtwrap.sanitize("\tHello \nWorld!\r ")
-'Hello World!'
-```
-
-<h1></h1>
-
 #### **`wrap(text, return_details=False)`**
 Returns a list of wrapped text strings. If `return_details=True`, returns a dictionary containing:
 - `'wrapped'`: A list of wrapped text fragments.
@@ -281,7 +284,7 @@ For example:
 #### **`align(text, return_details=False)`**
 Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along
 with its coordinates.
-> Note: [`sizefunc`](#sizefunc) must return both width and height.
+> Note: [`size_function`](#size_function) must return both width and height.
 
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
@@ -310,7 +313,7 @@ For example:
 
 #### **`fillstr(text)`**
 Returns a string with wrapped text formatted for monospace fonts.
-> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc)
+> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`size_function`](#size_function)
 (size or just length) must return `int`, not `float`!
 
 For example:
@@ -344,6 +347,7 @@ For example:
 ```py
 from typing import Literal, Optional
 from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
+
 import pygame
 
 def render_wrap(
@@ -359,9 +363,9 @@ def render_wrap(
     alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
     placeholder: str = '...',
     max_lines: Optional[int] = None,
-    preserve_empty_lines: bool = True,
+    empty_lines: bool = True,
     minimum_width: bool = True,
-    drop_separator: bool = False,
+    excess_word_separator: bool = False,
     justify_last_line: bool = False,
     break_on_hyphens: bool = True
 
@@ -375,13 +379,13 @@ def render_wrap(
         alignment=alignment,
         placeholder=placeholder,
         max_lines=max_lines,
-        preserve_empty_lines=preserve_empty_lines,
+        empty_lines=empty_lines,
         minimum_width=minimum_width,
-        drop_separator=drop_separator,
+        excess_word_separator=excess_word_separator,
         justify_last_line=justify_last_line,
         break_on_hyphens=break_on_hyphens,
         return_details=True,
-        sizefunc=font.size
+        size_function=font.size
     )
 
     surface = pygame.Surface(align_info['size'], pygame.SRCALPHA)
@@ -430,5 +434,5 @@ while running:
 ```py
 from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='…'))
+print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='\u2026'))
 ```

{txtwrap-3.0.1 → txtwrap-3.1.0}/README.md

@@ -1,21 +1,22 @@
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.1** <br>
+Package version: **3.1.0** <br>
 Python requires version: **>=3.0.0** <br>
 Python stub file requires version: **>=3.5.0** <br>
 
 - [`LOREM_IPSUM_WORDS`](#lorem-ipsum)
 - [`LOREM_IPSUM_SENTENCES`](#lorem-ipsum)
 - [`LOREM_IPSUM_PARAGRAPHS`](#lorem-ipsum)
-- [`SEPARATOR_WHITESPACE`](#separators)
-- [`SEPARATOR_ESCAPE`](#separators)
-- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
-- [`sanitize`](#sanitizetext) (🛠️ Fixed)
-- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
-- [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
-- [`fillstr`](#fillstrtext) (🛠️ Fixed)
-- [`shorten`](#shortentext) (🛠️ Fixed)
+- [`SEPARATOR_WHITESPACE`](#separators) (✅ Updated)
+- [`SEPARATOR_ESCAPE`](#separators) (✅ Updated)
+- [`SEPARATOR_NEWLINE`](#separators) (➕ New)
+- [`SEPARATOR_NEWLINE_AND_BREAK`](#separators) (➕ New)
+- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`align`](#aligntext-return_detailsfalse) (✅ Updated)
+- [`fillstr`](#fillstrtext) (✅ Updated)
+- [`shorten`](#shortentext) (✅ Updated)
 
 # Documents📄
 This module is inspired by the [`textwrap`](https://docs.python.org/3/library/textwrap.html) module, which provides
@@ -47,12 +48,14 @@ A _Lorem Ipsum_ collection of words, sentences, and paragraphs that can be used
 ```py
 SEPARATOR_WHITESPACE
 SEPARATOR_ESCAPE
+SEPARATOR_NEWLINE
+SEPARATOR_NEWLINE_AND_BREAK
 ```
 A collection of separators that can be used to separate text.
-- `SEPARATOR_WHITESPACE` contains whitespace characters.
-- `SEPARATOR_ESCAPE` contains whitespace characters including `'\0'`, `'\a'`, and `'\b'`.
-
-To use this, assign this constant to the [`separator`](#separator) parameter.
+- `SEPARATOR_WHITESPACE` (for [`word_separator`](#word_separator)) regex contains whitespace characters.
+- `SEPARATOR_ESCAPE` (for [`word_separator`](#word_separator)) regex contains whitespace characters including `'\a'`, `'\b'`, and `'\0'`.
+- `SEPARATOR_NEWLINE` (for [`newline_separator`](#newline_separator)) regex contains newline characters.
+- `SEPARATOR_NEWLINE_AND_BREAK` (for [`newline_separator`](#newline_separator)) regex contains newline characters including breaks tag `<br>`.
 
 <h1></h1>
 
@@ -69,15 +72,17 @@ class TextWrapper:
         mode: Literal['mono', 'word'] = 'word',
         alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
         placeholder: str = '...',
-        fillchar: str = ' ',
-        separator: Optional[Union[str, Iterable[str]]] = None,
+        space_character: str = ' ',
+        newline_character: str = '\n',
+        word_separator: Optional[Union[str, Tuple[str, int]]] = None,
+        newline_separator: Optional[Union[str, Tuple[str, int]]] = None,
         max_lines: Optional[int] = None,
-        preserve_empty_lines: bool = True,
+        empty_lines: bool = True,
         minimum_width: bool = True,
-        drop_separator: bool = False,
+        excess_word_separator: bool = False,
         justify_last_line: bool = False,
         break_on_hyphens: bool = True,
-        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
+        size_function: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
     ) -> None
 ```
 A class that handles all functions available in this module. Each keyword argument corresponds to its attribute.
@@ -90,9 +95,6 @@ is equivalent to:
 wrapper = TextWrapper()
 wrapper.width = 100
 ```
-You can reuse [`TextWrapper`](#textwrapper) multiple times or modify its options by assigning new values to its
-attributes. However, it is recommended not to reuse [`TextWrapper`](#textwrapper) too frequently inside a specific loop,
-as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
@@ -134,16 +136,29 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`fillchar`**
-(Default: `' '`) The character used for padding.
+#### **`space_character`**
+(Default: `' '`) The character used for padding and for the word separator character.
+
+<h1></h1>
+
+#### **`newline_character`**
+(Default: `'\n'`) The character used for line separator.
 
 <h1></h1>
 
-#### **`separator`**
+#### **`word_separator`**
 (Default: `None`) The character used to separate words.
 - `None`: Uses whitespace as the separator.
-- `str`: Uses the specified character.
-- `Iterable[str]`: Uses multiple specified characters.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
+
+<h1></h1>
+
+#### **`newline_separator`**
+(Default: `None`) The character used to separate lines.
+- `None`: Uses standard newline as the separator.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
 
 <h1></h1>
 
@@ -155,7 +170,7 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`preserve_empty_lines`**
+#### **`empty_lines`**
 (Default: `True`) Retains empty lines in the wrapped text.
 
 <h1></h1>
@@ -166,7 +181,7 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`drop_separator`**
+#### **`excess_word_separator`**
 (Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
@@ -182,7 +197,7 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`sizefunc`**
+#### **`size_function`**
 (Default: `None`) A function used to calculate the width and height or only the width of each string.
 
 If the function calculates both width and height, it must return a tuple containing two values:
@@ -213,18 +228,6 @@ Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (Externa
 
 <h1></h1>
 
-#### **`sanitize(text)`**
-Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
-
-For example:
-```py
->>> txtwrap.sanitize("\tHello \nWorld!\r ")
-'Hello World!'
-```
-
-<h1></h1>
-
 #### **`wrap(text, return_details=False)`**
 Returns a list of wrapped text strings. If `return_details=True`, returns a dictionary containing:
 - `'wrapped'`: A list of wrapped text fragments.
@@ -251,7 +254,7 @@ For example:
 #### **`align(text, return_details=False)`**
 Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along
 with its coordinates.
-> Note: [`sizefunc`](#sizefunc) must return both width and height.
+> Note: [`size_function`](#size_function) must return both width and height.
 
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
@@ -280,7 +283,7 @@ For example:
 
 #### **`fillstr(text)`**
 Returns a string with wrapped text formatted for monospace fonts.
-> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc)
+> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`size_function`](#size_function)
 (size or just length) must return `int`, not `float`!
 
 For example:
@@ -314,6 +317,7 @@ For example:
 ```py
 from typing import Literal, Optional
 from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
+
 import pygame
 
 def render_wrap(
@@ -329,9 +333,9 @@ def render_wrap(
     alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
     placeholder: str = '...',
     max_lines: Optional[int] = None,
-    preserve_empty_lines: bool = True,
+    empty_lines: bool = True,
     minimum_width: bool = True,
-    drop_separator: bool = False,
+    excess_word_separator: bool = False,
     justify_last_line: bool = False,
     break_on_hyphens: bool = True
 
@@ -345,13 +349,13 @@ def render_wrap(
         alignment=alignment,
         placeholder=placeholder,
         max_lines=max_lines,
-        preserve_empty_lines=preserve_empty_lines,
+        empty_lines=empty_lines,
         minimum_width=minimum_width,
-        drop_separator=drop_separator,
+        excess_word_separator=excess_word_separator,
         justify_last_line=justify_last_line,
         break_on_hyphens=break_on_hyphens,
         return_details=True,
-        sizefunc=font.size
+        size_function=font.size
     )
 
     surface = pygame.Surface(align_info['size'], pygame.SRCALPHA)
@@ -400,5 +404,5 @@ while running:
 ```py
 from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='…'))
+print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='\u2026'))
 ```

{txtwrap-3.0.1 → txtwrap-3.1.0}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', 'r', encoding='utf-8') as file:
 
 setup(
     name='txtwrap',
-    version='3.0.1',
+    version='3.1.0',
     description='A tool for wrapping and filling text.',
     long_description=long_description,
     long_description_content_type='text/markdown',

{txtwrap-3.0.1 → txtwrap-3.1.0}/txtwrap/__init__.py

@@ -15,12 +15,13 @@ from .identities import __version__, __author__, __license__
 
 from .constants import (
     LOREM_IPSUM_WORDS, LOREM_IPSUM_SENTENCES, LOREM_IPSUM_PARAGRAPHS,
-    SEPARATOR_WHITESPACE, SEPARATOR_ESCAPE
+    SEPARATOR_WHITESPACE, SEPARATOR_ESCAPE,
+    SEPARATOR_NEWLINE, SEPARATOR_NEWLINE_AND_BREAK
 )
 
 from .wrapper import (
     TextWrapper,
-    sanitize, wrap, align, fillstr, shorten
+    wrap, align, fillstr, shorten
 )
 
 __all__ = [
@@ -29,8 +30,9 @@ __all__ = [
     'LOREM_IPSUM_PARAGRAPHS',
     'SEPARATOR_WHITESPACE',
     'SEPARATOR_ESCAPE',
+    'SEPARATOR_NEWLINE',
+    'SEPARATOR_NEWLINE_AND_BREAK',
     'TextWrapper',
-    'sanitize',
     'wrap',
     'align',
     'fillstr',

{txtwrap-3.0.1 → txtwrap-3.1.0}/txtwrap/__init__.pyi

@@ -11,7 +11,9 @@ from .constants import (
     LOREM_IPSUM_SENTENCES as LOREM_IPSUM_SENTENCES,
     LOREM_IPSUM_PARAGRAPHS as LOREM_IPSUM_PARAGRAPHS,
     SEPARATOR_WHITESPACE as SEPARATOR_WHITESPACE,
-    SEPARATOR_ESCAPE as SEPARATOR_ESCAPE
+    SEPARATOR_ESCAPE as SEPARATOR_ESCAPE,
+    SEPARATOR_NEWLINE as SEPARATOR_NEWLINE,
+    SEPARATOR_NEWLINE_AND_BREAK as SEPARATOR_NEWLINE_AND_BREAK
 )
 
 from .identities import (
@@ -22,7 +24,6 @@ from .identities import (
 
 from .wrapper import (
     TextWrapper as TextWrapper,
-    sanitize as sanitize,
     wrap as wrap,
     align as align,
     fillstr as fillstr,

txtwrap-3.1.0/txtwrap/_utils.py

@@ -0,0 +1,78 @@
+import re
+
+pdict = type('pdict', (dict,), {
+    '__repr__': lambda self : '{0}({1})'.format(type(self).__name__, dict.__repr__(self)),
+    '__getattr__': lambda self, key: self.get(key, None),
+    '__setattr__': dict.__setitem__,
+    '__delattr__': dict.__delitem__
+})
+
+unknown = type('unknown', (), {
+    '__repr__': lambda self : '<unknown>',
+    '__str__': lambda self : '<unknown>',
+    '__bool__': lambda self : False
+})()
+
+def align_left(aligned, text, width, text_width, offset_y):
+    aligned.append((0, offset_y, text))
+
+def align_center(aligned, text, width, text_width, offset_y):
+    aligned.append(((width - text_width) / 2, offset_y, text))
+
+def align_right(aligned, text, width, text_width, offset_y):
+    aligned.append((width - text_width, offset_y, text))
+
+def fillstr_left(justified, text, width, text_width, fillchar):
+    justified.append(text + fillchar * (width - text_width))
+
+def fillstr_center(justified, text, width, text_width, fillchar):
+    extra_space = width - text_width
+    left_space = extra_space // 2
+    justified.append(fillchar * left_space + text + fillchar * (extra_space - left_space))
+
+def fillstr_right(justified, text, width, text_width, fillchar):
+    justified.append(fillchar * (width - text_width) + text)
+
+def validate_size_function(func, test):
+    result = func(test)
+
+    if isinstance(result, tuple):
+
+        def wrapper(string):
+            result = func(string)
+            if not isinstance(result, tuple): 
+                raise TypeError("size_function must be returned a tuple for size")
+            if len(result) != 2:
+                raise ValueError("size_function must be returned a tuple of length 2")
+            width, height = result
+            if not isinstance(width, (int, float)):
+                raise TypeError("size_function returned width must be a tuple of two integers or floats")
+            if not isinstance(height, (int, float)):
+                raise TypeError("size_function returned height must be a tuple of two integers or floats")
+            if width < 0:
+                raise ValueError("size_function returned width must be equal to or greater than 0")
+            if height < 0:
+                raise ValueError("size_function returned height must be equal to or greater than 0")
+            return result
+
+        return wrapper, lambda string : wrapper(string)[0]
+
+    elif isinstance(result, (int, float)):
+
+        def wrapper(string):
+            result = func(string)
+            if not isinstance(result, (int, float)):
+                raise TypeError("size_function (length) must be returned a integers or floats for width")
+            if result < 0:
+                raise ValueError("size_function (length) must be equal to or greater than 0")
+            return result    
+
+        return None, wrapper
+
+    raise TypeError("size_function must be returned a tuple for size or a single value for width (length)")
+
+hyphenate_pattern = r'''
+(?<=-)      # positive lookbehind: make sure there is a '-' before the current position
+(?=(?!-).)  # positive lookahead: make sure the character after is NOT '-' (avoid '--'), but still have one character
+'''
+split_hyphenated = re.compile(hyphenate_pattern, re.VERBOSE).split

{txtwrap-3.0.1 → txtwrap-3.1.0}/txtwrap/constants.py

@@ -1,3 +1,5 @@
+import re
+
 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. Cubil'
@@ -29,5 +31,7 @@ LOREM_IPSUM_PARAGRAPHS = (
     'aliquet proin. Commodo neque nibh; tempus ad tortor netus. Mattis ultricies nec maximus porttitor non mauris?'
 )
 
-SEPARATOR_WHITESPACE = (' ', '\t', '\n', '\r', '\v', '\f')
-SEPARATOR_ESCAPE = SEPARATOR_WHITESPACE + ('\a', '\b', '\0')
+SEPARATOR_WHITESPACE = r' |\t|\n|\r|\v|\f'
+SEPARATOR_ESCAPE = SEPARATOR_WHITESPACE + r'|\a|\x08|\0'  # \x08 -> \b
+SEPARATOR_NEWLINE = r'\r\n|\n|\r'
+SEPARATOR_NEWLINE_AND_BREAK = (r'</?br\s*/?>|' + SEPARATOR_NEWLINE, re.IGNORECASE)

txtwrap-3.1.0/txtwrap/constants.pyi

@@ -0,0 +1,10 @@
+from typing import Tuple
+
+LOREM_IPSUM_WORDS: str
+LOREM_IPSUM_SENTENCES: str
+LOREM_IPSUM_PARAGRAPHS: str
+
+SEPARATOR_WHITESPACE: str
+SEPARATOR_ESCAPE: str
+SEPARATOR_NEWLINE: str
+SEPARATOR_NEWLINE_AND_BREAK: Tuple[str, int]

txtwrap-3.1.0/txtwrap/identities.py

@@ -0,0 +1,3 @@
+__version__ = '3.1.0'
+__author__ = 'azzammuhyala'
+__license__ = 'MIT'