Skip to main content

paragraphs

Incorporate long strings painlessly, beautifully into Python code.

Examples

Easily edited, gq-able, fill-paragraph-able, comprehensive error messages.

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.

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

pip install paragraphs

Use

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.

>>> par(
    """Lorem ipsum dolor
    sit amet,"""
)

Lorem ipsum dolor sit amet,

Ignores one leading newline.

>>> par(
    """
    Lorem ipsum dolor
    sit amet,"""
)

Lorem ipsum dolor sit amet,

Separates paragraphs with double newline ("\n\n").

>>> par (
    """
    Lorem ipsum dolor
    sit amet,

    consectetur
    adipiscing
    elit"""
)

Lorem ipsum dolor sit amet,
<blankline>
consectetur adipiscing elit

Retains one trailing newline (if present).

>>> par(
    """retains one trailing newline
    """
)

retains one trailing newline
<blankline>

>>> par("""no trailing newline""")

no trailing newline

Notes

converts all whitespace to " "

>>> par("""converts\tall\twhitespace\tto\<space>""")

converts all whitespace to <space>

compresses consecutive whitespace to " "

>>> par("""compresses       consecutive    whitespace""")

compresses consecutive whitespace

Metadata

Release files for paragraphs 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for paragraphs 1.1.0
File Size Uploaded Provenance Actions
paragraphs-1.1.0.tar.gz 5.0 kB Without provenance Details for paragraphs-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for paragraphs 1.1.0
File Interpreter ABI Platform Actions
paragraphs-1.1.0-py3-none-any.whl Python 3 none any Details for paragraphs-1.1.0-py3-none-any.whl

Total release size: 10.4 kB

Release files / paragraphs-1.1.0.tar.gz

Download URL paragraphs-1.1.0.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3229c1d82002e9645a9101c2e40331f0b15f0b71f3e2f4257b2f7c492296e9c8
BLAKE2b-256 checksum
How to use checksums
e08d0818ad87bf13233484f74dbca951863a4881cd24eb3f28ecc78b58154554
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / paragraphs-1.1.0-py3-none-any.whl

Download URL paragraphs-1.1.0-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
969d431827d8173810a14dffced6b353b7da0c908841aab4bac5f70a15d79b43
BLAKE2b-256 checksum
How to use checksums
191bffce16b155da5be5492329ed9f323fe67cd80bd449a993c7b1ec9c70b64f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for paragraphs 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page