txtwrap 3.0.0__tar.gz → 3.0.1__tar.gz

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

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: txtwrap
-Version: 3.0.0
+Version: 3.0.1
 Summary: A tool for wrapping and filling text.
 Home-page: https://github.com/azzammuhyala/txtwrap
 Author: azzammuhyala
 Author-email: azzammuhyala@gmail.com
 License: MIT
+Project-URL: Source, https://github.com/azzammuhyala/txtwrap
+Project-URL: Bug Tracker, https://github.com/azzammuhyala/txtwrap/issues
 Keywords: wrap,wrapper,wrapping,wrapped,text wrap,text wrapper,text wrapping,text wrapped
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -22,24 +24,25 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: project-url
 Dynamic: requires-python
 Dynamic: summary
 
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.0** <br>
+Package version: **3.0.1** <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) (➕ New)
-- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
-- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`SEPARATOR_WHITESPACE`](#separators)
+- [`SEPARATOR_ESCAPE`](#separators)
+- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
 - [`sanitize`](#sanitizetext) (🛠️ Fixed)
-- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
 - [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
 - [`fillstr`](#fillstrtext) (🛠️ Fixed)
 - [`shorten`](#shortentext) (🛠️ Fixed)
@@ -55,6 +58,7 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 <h1></h1>
 
 ## Constants
+_File: **txtwrap.constants**_
 
 ### Lorem ipsum
 ```py
@@ -83,6 +87,8 @@ To use this, assign this constant to the [`separator`](#separator) parameter.
 <h1></h1>
 
 ## `TextWrapper`
+_File: **txtwrap.wrapper**_
+
 ```py
 class TextWrapper:
 
@@ -191,7 +197,7 @@ enabling this attribute removes unnecessary empty space.
 <h1></h1>
 
 #### **`drop_separator`**
-(Default: `False`) Removes the separator between more than one word at a time.
+(Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
 
@@ -233,17 +239,17 @@ is equivalent to:
 <h1></h1>
 
 #### **`copy`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`sanitize(text)`**
 Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
+character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
 
 For example:
 ```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
+>>> txtwrap.sanitize("\tHello \nWorld!\r ")
 'Hello World!'
 ```
 
@@ -252,20 +258,22 @@ For example:
 #### **`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.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 
 For example:
 ```py
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
-['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
->>> info
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
-'Lorem ipsum'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
-'elit.'
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
@@ -278,21 +286,23 @@ with its coordinates.
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 - `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
->>> info
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3], 'size': (18, 3)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
 'Lorem ipsum odor'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+>>> aligned_info['wrapped'][end_lines[0] - 1]
 'adipiscing elit.'
 ```
 
@@ -305,7 +315,7 @@ Returns a string with wrapped text formatted for monospace fonts.
 
 For example:
 ```py
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -322,7 +332,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 

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

@@ -1,18 +1,18 @@
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.0** <br>
+Package version: **3.0.1** <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) (➕ New)
-- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
-- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`SEPARATOR_WHITESPACE`](#separators)
+- [`SEPARATOR_ESCAPE`](#separators)
+- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
 - [`sanitize`](#sanitizetext) (🛠️ Fixed)
-- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
 - [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
 - [`fillstr`](#fillstrtext) (🛠️ Fixed)
 - [`shorten`](#shortentext) (🛠️ Fixed)
@@ -28,6 +28,7 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 <h1></h1>
 
 ## Constants
+_File: **txtwrap.constants**_
 
 ### Lorem ipsum
 ```py
@@ -56,6 +57,8 @@ To use this, assign this constant to the [`separator`](#separator) parameter.
 <h1></h1>
 
 ## `TextWrapper`
+_File: **txtwrap.wrapper**_
+
 ```py
 class TextWrapper:
 
@@ -164,7 +167,7 @@ enabling this attribute removes unnecessary empty space.
 <h1></h1>
 
 #### **`drop_separator`**
-(Default: `False`) Removes the separator between more than one word at a time.
+(Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
 
@@ -206,17 +209,17 @@ is equivalent to:
 <h1></h1>
 
 #### **`copy`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`sanitize(text)`**
 Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
+character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
 
 For example:
 ```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
+>>> txtwrap.sanitize("\tHello \nWorld!\r ")
 'Hello World!'
 ```
 
@@ -225,20 +228,22 @@ For example:
 #### **`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.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 
 For example:
 ```py
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
-['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
->>> info
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
-'Lorem ipsum'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
-'elit.'
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
@@ -251,21 +256,23 @@ with its coordinates.
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 - `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
->>> info
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3], 'size': (18, 3)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
 'Lorem ipsum odor'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+>>> aligned_info['wrapped'][end_lines[0] - 1]
 'adipiscing elit.'
 ```
 
@@ -278,7 +285,7 @@ Returns a string with wrapped text formatted for monospace fonts.
 
 For example:
 ```py
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -295,7 +302,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 

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

@@ -1,17 +1,21 @@
 from setuptools import find_packages, setup
 
-with open('README.md', encoding='utf-8') as readme:
-    long_description = readme.read()
+with open('README.md', 'r', encoding='utf-8') as file:
+    long_description = file.read()
 
 setup(
     name='txtwrap',
-    version='3.0.0',
+    version='3.0.1',
     description='A tool for wrapping and filling text.',
     long_description=long_description,
     long_description_content_type='text/markdown',
     author='azzammuhyala',
     author_email='azzammuhyala@gmail.com',
     url='https://github.com/azzammuhyala/txtwrap',
+    project_urls={
+        'Source': 'https://github.com/azzammuhyala/txtwrap',
+        'Bug Tracker': 'https://github.com/azzammuhyala/txtwrap/issues'
+    },
     license='MIT',
     python_requires='>=3.0',
     packages=find_packages(),

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

@@ -1,5 +1,8 @@
 """
 A tool for wrapping and filling text.
+
+See txtwrap module documentation on [GitHub](https://github.com/azzammuhyala/txtwrap) or on
+[PyPi](https://pypi.org/project/txtwrap) for details.
 """
 
 # Supports only in Python>=3.0.0

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

@@ -1,10 +1,10 @@
-# Define the packages
+# define the packages
 
 from . import constants as constants
 from . import identities as identities
 from . import wrapper as wrapper
 
-# Define the main variables, functions, classes to be exported
+# define the main variables, functions, classes to be exported
 
 from .constants import (
     LOREM_IPSUM_WORDS as LOREM_IPSUM_WORDS,

{txtwrap-3.0.0 → txtwrap-3.0.1}/txtwrap/_utils.py

@@ -28,7 +28,7 @@ def fillstr_right(justified_lines, text, width, text_width, fillchar):
     justified_lines.append(fillchar * (width - text_width) + text)
 
 hyphenate_parrent = 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
+(?<=-)      # 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_parrent, re.VERBOSE).split

txtwrap-3.0.1/txtwrap/identities.py

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

{txtwrap-3.0.0 → txtwrap-3.0.1}/txtwrap/wrapper.py

@@ -1,3 +1,4 @@
+import copy
 import re
 
 from .constants import SEPARATOR_WHITESPACE
@@ -10,13 +11,8 @@ class TextWrapper:
     __slots__ = ('_d',)
 
     def __init__(self, width=70, line_padding=0, mode='word', alignment='left', placeholder='...', fillchar=' ',
-                 separator=None, max_lines=None, preserve_empty_lines=True, minimum_width=True, justify_last_line=False,
-                 break_on_hyphens=True, drop_separator=False, sizefunc=None):
-
-        """
-        See txtwrap module documentation on [GitHub](https://github.com/azzammuhyala/txtwrap) or on
-        [PyPi](https://pypi.org/project/txtwrap) for details.
-        """
+                 separator=None, max_lines=None, preserve_empty_lines=True, minimum_width=True, drop_separator=False,
+                 justify_last_line=False, break_on_hyphens=True, sizefunc=None):
 
         # dictionary to store a metadata and private variables
         self._d = _utils.pdict()
@@ -31,19 +27,16 @@ class TextWrapper:
         self.max_lines = max_lines
         self.preserve_empty_lines = preserve_empty_lines
         self.minimum_width = minimum_width
+        self.drop_separator = drop_separator
         self.justify_last_line = justify_last_line
         self.break_on_hyphens = break_on_hyphens
-        self.drop_separator = drop_separator
         self.sizefunc = sizefunc
 
     def __repr__(self):
         return '{}({})'.format(
             type(self).__name__,
             ', '.join(
-                '{}={!r}'.format(
-                    name,
-                    getattr(self, name, None)  # if did't find the attribute, use the default None
-                )
+                '{}={!r}'.format(name, getattr(self, name, None))
                 for i, name in enumerate(self.__init__.__code__.co_varnames)
                 if i != 0  # skip self
             )
@@ -57,10 +50,18 @@ class TextWrapper:
         )
 
     def __copy__(self):
-        return self.copy()
+        return TextWrapper(**{
+            name: getattr(self, name)
+            for i, name in enumerate(self.__init__.__code__.co_varnames)
+            if i != 0  # skip self
+        })
 
-    def __deepcopy__(self, memo):
-        return self.copy()
+    def __deepcopy__(self, memo=None):
+        return TextWrapper(**{
+            name: copy.deepcopy(getattr(self, name), memo)
+            for i, name in enumerate(self.__init__.__code__.co_varnames)
+            if i != 0  # skip self
+        })
 
     @property
     def width(self):
@@ -351,11 +352,7 @@ class TextWrapper:
         return wrapped
 
     def copy(self):
-        return TextWrapper(**{
-            name: getattr(self, name)
-            for i, name in enumerate(self.__init__.__code__.co_varnames)
-            if i != 0  # skip self
-        })
+        return self.__copy__()
 
     def sanitize(self, text):
         if not isinstance(text, str):
@@ -385,32 +382,32 @@ class TextWrapper:
             raise ValueError("width must be greater than length of the placeholder")
 
         wrapped = []
-        start_lines = set()
-        end_lines = set()
+        start_lines = []
+        end_lines = []
 
         for line in text.splitlines():
             wrapped_line = wrapfunc(line)
 
             if wrapped_line:
-                start_lines.add(len(wrapped) + 1)  # add 1 line for next wrapped_line were added
+                start_lines.append(len(wrapped) + 1)  # add 1 line for next wrapped_line were added
                 wrapped.extend(wrapped_line)
 
                 nline = len(wrapped)
 
                 if has_max_lines and nline <= max_lines:
                     # only added if it has the max_lines attribute and the current line is no more than max_lines
-                    end_lines.add(nline)
+                    end_lines.append(nline)
                 elif not has_max_lines:
                     # if not set
-                    end_lines.add(nline)
+                    end_lines.append(nline)
 
             elif preserve_empty_lines:
                 wrapped.append('')  # adding an empty string (usually occurs when encountering an empty line)
 
                 nline = len(wrapped)
 
-                start_lines.add(nline)
-                end_lines.add(nline)
+                start_lines.append(nline)
+                end_lines.append(nline)
 
             if has_max_lines and len(wrapped) > max_lines:
                 # cut off the excess part of the wrapper and also add a placeholder to indicate that the wrapper has
@@ -425,7 +422,7 @@ class TextWrapper:
                 wrapped[max_lines - 1] = current_part + placeholder
                 wrapped = wrapped[:max_lines]
 
-                end_lines.add(max_lines)
+                end_lines.append(max_lines)
                 break
 
         if return_details:
@@ -454,7 +451,7 @@ class TextWrapper:
         wrapped_info = self.wrap(text, True)
 
         wrapped = wrapped_info['wrapped']
-        end_lines = wrapped_info['end_lines']
+        end_lines = set(wrapped_info['end_lines'])
 
         aligned = []
         offset_y = 0
@@ -510,7 +507,7 @@ class TextWrapper:
                 'aligned': aligned,
                 'wrapped': wrapped,
                 'start_lines': wrapped_info['start_lines'],
-                'end_lines': end_lines,
+                'end_lines': wrapped_info['end_lines'],
                 'size': (use_width, offset_y - line_padding)
             }
 
@@ -531,7 +528,7 @@ class TextWrapper:
         wrapped_info = self.wrap(text, True)
 
         wrapped = wrapped_info['wrapped']
-        end_lines = wrapped_info['end_lines']
+        end_lines = set(wrapped_info['end_lines'])
 
         justified_lines = []
 
@@ -634,7 +631,8 @@ def fillstr(text, width=70, line_padding=0, mode='word', alignment='left', place
                        drop_separator=drop_separator, justify_last_line=justify_last_line,
                        break_on_hyphens=break_on_hyphens, sizefunc=sizefunc).fillstr(text)
 
-def shorten(text, width=70, mode='word', fillchar=' ', placeholder='...', separator=None, drop_separator=True,
-            sizefunc=None):
-    return TextWrapper(width=width, mode=mode, fillchar=fillchar, placeholder=placeholder, separator=separator,
-                       drop_separator=drop_separator, sizefunc=sizefunc).shorten(text)
+def shorten(text, width=70, mode='word', placeholder='...', fillchar=' ', separator=None, drop_separator=True,
+            break_on_hyphens=True, sizefunc=None):
+    return TextWrapper(width=width, mode=mode, placeholder=placeholder, fillchar=fillchar, separator=separator,
+                       drop_separator=drop_separator, break_on_hyphens=break_on_hyphens,
+                       sizefunc=sizefunc).shorten(text)

{txtwrap-3.0.0 → txtwrap-3.0.1}/txtwrap/wrapper.pyi

@@ -1,4 +1,4 @@
-from typing import overload, Callable, Dict, Iterable, List, Optional, Set, Tuple, Union
+from typing import overload, Callable, Dict, Iterable, List, Optional, Tuple, Union
 try:
     from typing import Literal
 except ImportError:
@@ -28,7 +28,7 @@ class TextWrapper:
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
     def __copy__(self) -> 'TextWrapper': ...
-    def __deepcopy__(self, memo: Dict) -> 'TextWrapper': ...
+    def __deepcopy__(self, memo: Optional[Dict] = None) -> 'TextWrapper': ...
 
     # Properties -------------------------------------------------------------------------------------------------------
 
@@ -110,7 +110,7 @@ class TextWrapper:
         self,
         text: str,
         return_details: Literal[True] = True
-    ) -> Dict[Literal['wrapped', 'start_lines', 'end_lines'], Union[List[str], Set[int]]]: ...
+    ) -> Dict[Literal['wrapped', 'start_lines', 'end_lines'], Union[List[str], List[int]]]: ...
     @overload
     def align(
         self,
@@ -123,10 +123,10 @@ class TextWrapper:
         text: str,
         return_details: Literal[True] = True
     ) -> Dict[Literal['aligned', 'wrapped', 'start_lines', 'end_lines', 'size'],
-            Union[List[Tuple[Union[int, float], Union[int, float], str]],
-                  List[str],
-                  Set[int],
-                  Tuple[Union[int, float], Union[int, float]]]]: ...
+              Union[List[Tuple[Union[int, float], Union[int, float], str]],
+                    List[str],
+                    List[int],
+                    Tuple[Union[int, float], Union[int, float]]]]: ...
     def fillstr(self, text: str) -> str: ...
     def shorten(self, text: str) -> str: ...
 
@@ -168,7 +168,7 @@ def wrap(
     break_on_hyphens: bool = True,
     return_details: Literal[True] = True,
     sizefunc: Optional[Callable[[str], Union[int, float]]] = None,
-) -> Dict[Literal['wrapped', 'start_lines', 'end_lines'], Union[List[str], Set[int]]]: ...
+) -> Dict[Literal['wrapped', 'start_lines', 'end_lines'], Union[List[str], List[int]]]: ...
 
 @overload
 def align(
@@ -209,10 +209,10 @@ def align(
     return_details: Literal[True] = True,
     sizefunc: Optional[Callable[[str], Tuple[Union[int, float], Union[int, float]]]] = None
 ) -> Dict[Literal['aligned', 'wrapped', 'start_lines', 'end_lines', 'size'],
-        Union[List[Tuple[Union[int, float], Union[int, float], str]],
-              List[str],
-              Set[int],
-              Tuple[Union[int, float], Union[int, float]]]]: ...
+          Union[List[Tuple[Union[int, float], Union[int, float], str]],
+                List[str],
+                List[int],
+                Tuple[Union[int, float], Union[int, float]]]]: ...
 
 def fillstr(
     text: str,
@@ -240,5 +240,6 @@ def shorten(
     fillchar: str = ' ',
     separator: Optional[Union[str, Iterable[str]]] = None,
     drop_separator: bool = True,
+    break_on_hyphens: bool = True,
     sizefunc: Optional[Callable[[str], Union[int, float]]] = None
 ) -> str: ...

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

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: txtwrap
-Version: 3.0.0
+Version: 3.0.1
 Summary: A tool for wrapping and filling text.
 Home-page: https://github.com/azzammuhyala/txtwrap
 Author: azzammuhyala
 Author-email: azzammuhyala@gmail.com
 License: MIT
+Project-URL: Source, https://github.com/azzammuhyala/txtwrap
+Project-URL: Bug Tracker, https://github.com/azzammuhyala/txtwrap/issues
 Keywords: wrap,wrapper,wrapping,wrapped,text wrap,text wrapper,text wrapping,text wrapped
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -22,24 +24,25 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: project-url
 Dynamic: requires-python
 Dynamic: summary
 
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.0** <br>
+Package version: **3.0.1** <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) (➕ New)
-- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
-- [`TextWrapper`](#textwrapper) (✅ Updated)
+- [`SEPARATOR_WHITESPACE`](#separators)
+- [`SEPARATOR_ESCAPE`](#separators)
+- [`TextWrapper`](#textwrapper) (🛠️ Fixed)
 - [`sanitize`](#sanitizetext) (🛠️ Fixed)
-- [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
+- [`wrap`](#wraptext-return_detailsfalse) (🛠️ Fixed)
 - [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
 - [`fillstr`](#fillstrtext) (🛠️ Fixed)
 - [`shorten`](#shortentext) (🛠️ Fixed)
@@ -55,6 +58,7 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 <h1></h1>
 
 ## Constants
+_File: **txtwrap.constants**_
 
 ### Lorem ipsum
 ```py
@@ -83,6 +87,8 @@ To use this, assign this constant to the [`separator`](#separator) parameter.
 <h1></h1>
 
 ## `TextWrapper`
+_File: **txtwrap.wrapper**_
+
 ```py
 class TextWrapper:
 
@@ -191,7 +197,7 @@ enabling this attribute removes unnecessary empty space.
 <h1></h1>
 
 #### **`drop_separator`**
-(Default: `False`) Removes the separator between more than one word at a time.
+(Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
 
@@ -233,17 +239,17 @@ is equivalent to:
 <h1></h1>
 
 #### **`copy`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`sanitize(text)`**
 Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
+character. (It doesn't matter whether [`drop_separator`](#drop_separator) is `False` or `True`)
 
 For example:
 ```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
+>>> txtwrap.sanitize("\tHello \nWorld!\r ")
 'Hello World!'
 ```
 
@@ -252,20 +258,22 @@ For example:
 #### **`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.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 
 For example:
 ```py
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
-['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
->>> info
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
-'Lorem ipsum'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
-'elit.'
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
@@ -278,21 +286,23 @@ with its coordinates.
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 - `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
->>> info
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3], 'size': (18, 3)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
 'Lorem ipsum odor'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+>>> aligned_info['wrapped'][end_lines[0] - 1]
 'adipiscing elit.'
 ```
 
@@ -305,7 +315,7 @@ Returns a string with wrapped text formatted for monospace fonts.
 
 For example:
 ```py
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -322,7 +332,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 

txtwrap-3.0.0/txtwrap/identities.py

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