paragraphs 1.0__0-py3-none-any.whl

paragraphs/__init__.py

@@ -0,0 +1,9 @@
+"""Import par into top-level namespace.
+
+:author: Shay Hill
+:created: 2023-01-02
+"""
+
+from paragraphs.main import par
+
+__all__ = ["par"]

paragraphs/main.py

@@ -0,0 +1,48 @@
+"""Html-like formatting of multi-line strings.
+
+:author: Shay Hill
+:created: 7/8/2019
+"""
+
+import re
+
+# match a newline followed by any number of blank lines
+_RE_PARBREAK = re.compile(r"\n\s*\n")
+
+
+def par(text: str) -> str:
+    r"""Html-like paragraph formatting.
+
+    :param text: any block of text indented to any level
+    :return:
+
+    * whitespace substrings converted to single spaces
+    * leading whitespace removed
+    * double newlines ('\n\n') split paragraphs
+    * one trailing newline retained (if present)
+
+    >>> two_paragraphs = '''
+    ...     Lorem ipsum dolor
+    ...     sit amet,
+    ...
+    ...     consectetur
+    ...     adipiscing
+    ...     elit'''
+
+    >>> par(two_paragraphs)
+    Lorem ipsum dolor sit amet,"
+    <blankline>
+    consectetur adipiscing elit"
+
+    >>> par('''retains one trailing newline
+    ... ''')
+    retains one trailing newline
+    <blankline>
+
+    >>> par('''no trailing newline''')
+    no trailing newline
+    """
+    trail = "\n" if text.rstrip(" \t").endswith("\n") else ""
+    paragraphs = _RE_PARBREAK.split(text.strip())
+    paragraphs = [" ".join(x.split()) for x in paragraphs]
+    return "\n\n".join(paragraphs) + trail

paragraphs-1.0.0.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shay Hill
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

paragraphs-1.0.0.dist-info/METADATA

@@ -0,0 +1,195 @@
+Metadata-Version: 2.1
+Name: paragraphs
+Version: 1.0.0
+Summary: Incorporate long strings painlessly, beautifully into Python code.
+Author-email: Shay Hill <shay_public@hotmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Provides-Extra: dev
+Requires-Dist: commitizen ; extra == 'dev'
+Requires-Dist: pre-commit ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: tox ; extra == 'dev'
+
+# paragraphs
+
+Incorporate long strings painlessly, beautifully into Python code.
+
+## Examples
+
+**Easily edited, `gq`-able, `fill-paragraph`-able, comprehensive error messages.**
+```python
+from paragraphs import par
+
+class SuddenDeathError(Exception):
+    def __init__(self, cause: str) -> None:
+        self.cause = cause
+
+    def __str__(self) -> str:
+        return par(
+            f"""
+            Y - e - e - e - es, Lord love you! Why should she die of
+            {self.cause}? She come through diphtheria right enough the year
+            before. I saw her with my own eyes. Fairly blue with it, she was.
+            They all thought she was dead; but my father, he kept ladling gin
+            down her throat till she came to so sudden that she bit the bowl
+            off the spoon.
+
+            What call would a woman with that strength in her have to die of
+            {self.cause}? What become of her new straw hat that should have
+            come to me? Somebody pinched it; and what I say is, them as pinched
+            it done her in."""
+        )
+
+raise SuddenDeathError("influenza")
+```
+
+**Nicely-formatted long string data. Spoilers for some old novels here,
+but these *are* the original titles.**
+
+```python
+author2titles = {
+    "Samuel Penhallow": [
+        par(
+            """
+            The history of the wars of New-England with the Eastern Indians;
+            or, a narrative of their continued perfidy and cruelty, from the
+            10th of August, 1703, to the peace renewed 13th of July, 1713. And
+            from the 25th of July, 1722, to their submission 15th December,
+            1725, which was ratified August 5th, 1726"""
+        )
+    ],
+    "Daniel Defoe": [
+        par(
+            """
+            The Life and Strange Surprizing Adventures of Robinson Crusoe, Of
+            York, Mariner: Who lived Eight and Twenty Years, all alone in an
+            un-inhabited Island on the Coast of America, near the Mouth of the
+            Great River of Oroonoque; Having been cast on Shore by Shipwreck,
+            wherein all the Men perished but himself. With An Account how he
+            was at last as strangely deliver'd by Pyrates"""
+        ),
+        par(
+            """The Fortunes and Misfortunes of the Famous Moll Flanders Who was
+            born in Newgate, and during a life of continu’d Variety for
+            Threescore Years, besides her Childhood, was Twelve Years a Whore,
+            five times a Wife (whereof once to her brother) Twelve Years a
+            Thief, Eight Years a Transported Felon in Virginia, at last grew
+            Rich, liv’d Honest and died a Penitent"""
+        ),
+    ],
+}
+```
+
+## Installation
+```bash
+pip install paragraphs
+```
+
+## Use
+
+```python
+from paragraphs import par
+
+PARAGRAPH = par(
+    """Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+    commodo consequat.  Duis aute irure dolor in reprehenderit in voluptate
+    velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+    cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+    est laborum."""
+)
+
+# the above is equivalent to
+
+PARAGRAPH = (
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod"
+    + " tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim"
+    + " veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea"
+    + " commodo consequat. Duis aute irure dolor in reprehenderit in voluptate"
+    + " velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint"
+    + " occaecat cupidatat non proident, sunt in culpa qui officia deserunt"
+    + " mollit anim id est laborum."
+)
+
+```
+
+## Features
+
+Joins lines. Removes indentation and leading whitespace.
+
+```python
+>>> par(
+    """Lorem ipsum dolor
+    sit amet,"""
+)
+
+Lorem ipsum dolor sit amet,
+```
+
+Ignores one leading newline.
+
+```python
+>>> par(
+    """
+    Lorem ipsum dolor
+    sit amet,"""
+)
+
+Lorem ipsum dolor sit amet,
+```
+
+Separates paragraphs with double newline (`"\n\n"`).
+
+```python
+>>> par (
+    """
+    Lorem ipsum dolor
+    sit amet,
+
+    consectetur
+    adipiscing
+    elit"""
+)
+
+Lorem ipsum dolor sit amet,
+<blankline>
+consectetur adipiscing elit
+```
+
+Retains one trailing newline (if present).
+
+```python
+>>> par(
+    """retains one trailing newline
+    """
+)
+
+retains one trailing newline
+<blankline>
+
+>>> par("""no trailing newline""")
+
+no trailing newline
+```
+
+## Notes
+
+converts all whitespace to " "
+
+```python
+>>> par("""converts\tall\twhitespace\tto\<space>""")
+
+converts all whitespace to <space>
+```
+
+compresses consecutive whitespace to " "
+
+```python
+>>> par("""compresses       consecutive    whitespace""")
+
+compresses consecutive whitespace
+```

paragraphs-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+paragraphs/__init__.py,sha256=jaLhlyJqHzlBxW62xuzdHSFHh4J2UiynMmICOyEPQWQ,146
+paragraphs/main.py,sha256=I05mJCTeeIusZeuYgOWZdjEZaiF0xNx02IITXnpMAxA,1231
+paragraphs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+paragraphs-1.0.0.dist-info/LICENSE.txt,sha256=6azOzWPODyBgzuvezbefyPbicI5bimF1wP0NjVozTB4,1097
+paragraphs-1.0.0.dist-info/METADATA,sha256=WGPVAWO01B6fZ5Rh16BCimgwMxTlBupJyS28JKUQ6J4,5543
+paragraphs-1.0.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+paragraphs-1.0.0.dist-info/top_level.txt,sha256=ZQuQ1qloXPi4_965TXp8hTEmGc9Q75WJnacZB5UIWPA,11
+paragraphs-1.0.0.dist-info/RECORD,,

paragraphs-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (72.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

paragraphs-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+paragraphs