plain 0.14.1__py3-none-any.whl → 0.16.0__py3-none-any.whl

plain/internal/middleware/headers.py

@@ -9,6 +9,12 @@ class DefaultHeadersMiddleware:
         response = self.get_response(request)
 
         for header, value in settings.DEFAULT_RESPONSE_HEADERS.items():
+            # Since we don't have a good way to *remote* default response headers,
+            # use allow users to set them to an empty string to indicate they should be removed.
+            if header in response.headers and response.headers[header] == "":
+                del response.headers[header]
+                continue
+
             response.headers.setdefault(header, value)
 
         # Add the Content-Length header to non-streaming responses if not

plain/utils/timesince.py

@@ -4,59 +4,93 @@ from plain.utils.html import avoid_wrapping
 from plain.utils.text import pluralize_lazy
 from plain.utils.timezone import is_aware
 
-TIME_STRINGS = {
-    "year": pluralize_lazy("%(num)d year", "%(num)d years", "num"),
-    "month": pluralize_lazy("%(num)d month", "%(num)d months", "num"),
-    "week": pluralize_lazy("%(num)d week", "%(num)d weeks", "num"),
-    "day": pluralize_lazy("%(num)d day", "%(num)d days", "num"),
-    "hour": pluralize_lazy("%(num)d hour", "%(num)d hours", "num"),
-    "minute": pluralize_lazy("%(num)d minute", "%(num)d minutes", "num"),
-}
 
-TIME_STRINGS_KEYS = list(TIME_STRINGS.keys())
-
-TIME_CHUNKS = [
-    60 * 60 * 24 * 7,  # week
-    60 * 60 * 24,  # day
-    60 * 60,  # hour
-    60,  # minute
-]
-
-MONTHS_DAYS = (31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31)
-
-
-def timesince(d, now=None, reversed=False, time_strings=None, depth=2):
+def timesince(
+    d: datetime.datetime,
+    *,
+    now: datetime.datetime | None = None,
+    reversed: bool = False,
+    format: str | dict[str, str] = "verbose",
+    depth: int = 2,
+) -> str:
     """
     Take two datetime objects and return the time between d and now as a nicely
-    formatted string, e.g. "10 minutes". If d occurs after now, return
-    "0 minutes".
+    formatted string, e.g., "10 minutes" or "10m" (depending on the format).
+
+    `format` can be:
+        - "verbose": e.g., "1 year, 2 months"
+        - "short": e.g., "1y 2m"
+        - A custom dictionary defining time unit formats.
 
     Units used are years, months, weeks, days, hours, and minutes.
     Seconds and microseconds are ignored.
 
     The algorithm takes into account the varying duration of years and months.
-    There is exactly "1 year, 1 month" between 2013/02/10 and 2014/03/10,
-    but also between 2007/08/10 and 2008/09/10 despite the delta being 393 days
-    in the former case and 397 in the latter.
+    For example, there is exactly "1 year, 1 month" between 2013/02/10 and
+    2014/03/10, but also between 2007/08/10 and 2008/09/10 despite the delta
+    being 393 days in the former case and 397 in the latter.
 
-    Up to `depth` adjacent units will be displayed.  For example,
+    Up to `depth` adjacent units will be displayed. For example,
     "2 weeks, 3 days" and "1 year, 3 months" are possible outputs, but
     "2 weeks, 3 hours" and "1 year, 5 days" are not.
 
-    `time_strings` is an optional dict of strings to replace the default
-    TIME_STRINGS dict.
-
-    `depth` is an optional integer to control the number of adjacent time
-    units returned.
-
-    Originally adapted from
-    https://web.archive.org/web/20060617175230/http://blog.natbat.co.uk/archive/2003/Jun/14/time_since
-    Modified to improve results for years and months.
+    Arguments:
+        d: A datetime object representing the starting time.
+        now: A datetime object representing the current time. Defaults to the
+             current time if not provided.
+        reversed: If True, calculates time until `d` rather than since `d`.
+        format: The output format, either "verbose", "short", or a custom
+                dictionary of time unit formats.
+        depth: An integer specifying the number of adjacent time units to display.
+
+    Returns:
+        A string representing the time difference, formatted according to the
+        specified format.
+
+    Raises:
+        ValueError: If depth is less than 1 or if format is invalid.
     """
-    if time_strings is None:
-        time_strings = TIME_STRINGS
+    TIME_CHUNKS = [
+        60 * 60 * 24 * 7,  # week
+        60 * 60 * 24,  # day
+        60 * 60,  # hour
+        60,  # minute
+    ]
+    MONTHS_DAYS = (31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31)
+    TIME_STRINGS_KEYS = ["year", "month", "week", "day", "hour", "minute"]
+
+    VERBOSE_TIME_STRINGS = {
+        "year": pluralize_lazy("%(num)d year", "%(num)d years", "num"),
+        "month": pluralize_lazy("%(num)d month", "%(num)d months", "num"),
+        "week": pluralize_lazy("%(num)d week", "%(num)d weeks", "num"),
+        "day": pluralize_lazy("%(num)d day", "%(num)d days", "num"),
+        "hour": pluralize_lazy("%(num)d hour", "%(num)d hours", "num"),
+        "minute": pluralize_lazy("%(num)d minute", "%(num)d minutes", "num"),
+    }
+    SHORT_TIME_STRINGS = {
+        "year": "%(num)dy",
+        "month": "%(num)dmo",
+        "week": "%(num)dw",
+        "day": "%(num)dd",
+        "hour": "%(num)dh",
+        "minute": "%(num)dm",
+    }
+
+    # Determine time_strings based on format
+    if format == "verbose":
+        time_strings = VERBOSE_TIME_STRINGS
+    elif format == "short":
+        time_strings = SHORT_TIME_STRINGS
+    elif isinstance(format, dict):
+        time_strings = format
+    else:
+        raise ValueError(
+            "format must be 'verbose', 'short', or a custom dictionary of formats."
+        )
+
     if depth <= 0:
         raise ValueError("depth must be greater than 0.")
+
     # Convert datetime.date to datetime.datetime for comparison.
     if not isinstance(d, datetime.datetime):
         d = datetime.datetime(d.year, d.month, d.day)
@@ -82,8 +116,6 @@ def timesince(d, now=None, reversed=False, time_strings=None, depth=2):
     years, months = divmod(total_months, 12)
 
     # Calculate the remaining time.
-    # Create a "pivot" datetime shifted from d by years and months, then use
-    # that to determine the other parts.
     if years or months:
         pivot_year = d.year + years
         pivot_month = d.month + months
@@ -131,8 +163,13 @@ def timesince(d, now=None, reversed=False, time_strings=None, depth=2):
     return ", ".join(result)
 
 
-def timeuntil(d, now=None, time_strings=None, depth=2):
+def timeuntil(
+    d: datetime.datetime,
+    now: datetime.datetime | None = None,
+    format: str | dict[str, str] = "verbose",
+    depth: int = 2,
+) -> str:
     """
     Like timesince, but return a string measuring the time until the given time.
     """
-    return timesince(d, now, reversed=True, time_strings=time_strings, depth=depth)
+    return timesince(d, now=now, reversed=True, format=format, depth=depth)

{plain-0.14.1.dist-info → plain-0.16.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.14.1
+Version: 0.16.0
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE

{plain-0.14.1.dist-info → plain-0.16.0.dist-info}/RECORD

@@ -51,7 +51,7 @@ plain/internal/handlers/base.py,sha256=I6549DBZUb-anqox7arzL9wpypH4bUCxZkitO76hl
 plain/internal/handlers/exception.py,sha256=DH9gh1FyqgetFpMaB8yLIVE6phBTVPKQLA1GIn9MOeI,4555
 plain/internal/handlers/wsgi.py,sha256=EWoH9EeetfgiL0BtoAe2Aof0VWaBrxl74Y9EP4xx0wc,7553
 plain/internal/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plain/internal/middleware/headers.py,sha256=UnJWnlVVLD-10h7PB_QSYeREBzLo-TS3C-_ahmZ6w0I,636
+plain/internal/middleware/headers.py,sha256=naYsFK0phMGFf1DlRj5fAYz78R5cXToCJfuqm0cR0nI,965
 plain/internal/middleware/https.py,sha256=XpuQK8HicYX1jNanQHqNgyQ9rqe4NLUOZO3ZzKdsP8k,1203
 plain/internal/middleware/slash.py,sha256=1rZsSSzXAA-vBb-dc2RlZaKW9gTT8YM8fJzwYGL4swA,2575
 plain/logs/README.md,sha256=H6uVXdInYlasq0Z1WnhWnPmNwYQoZ1MSLPDQ4ZE7u4A,492
@@ -125,7 +125,7 @@ plain/utils/module_loading.py,sha256=CWl7Shoax9Zkevf1pM9PpS_0V69J5Cukjyj078UPCAw
 plain/utils/regex_helper.py,sha256=pAdh_xG52BOyXLsiuIMPFgduUAoWOEje1ZpjhcefxiA,12769
 plain/utils/safestring.py,sha256=SHGhpbX6FFDKSYOY9zYAgAQX0g0exzRba7dM2bJalWs,1873
 plain/utils/text.py,sha256=qX7vECGH4Xk96qZRH9A1IyZA-mrJ-j62j3kDcLTdWK0,16586
-plain/utils/timesince.py,sha256=d-9w_fqKS24IrHsh9-UX6SPNwrQvDp6QhZ_aJzM6AKY,4749
+plain/utils/timesince.py,sha256=a_-ZoPK_s3Pt998CW4rWp0clZ1XyK2x04hCqak2giII,5928
 plain/utils/timezone.py,sha256=6u0sE-9RVp0_OCe0Y1KiYYQoq5THWLokZFQYY8jf78g,6221
 plain/utils/tree.py,sha256=wdWzmfsgc26YDF2wxhAY3yVxXTixQYqYDKE9mL3L3ZY,4383
 plain/views/README.md,sha256=qndsXKyNMnipPlLaAvgQeGxqXknNQwlFh31Yxk8rHp8,5994
@@ -138,8 +138,8 @@ plain/views/forms.py,sha256=RhlaUcZCkeqokY_fvv-NOS-kgZAG4XhDLOPbf9K_Zlc,2691
 plain/views/objects.py,sha256=fRfS6KNehIGqkbPw4nSafj8HStxYExHmbggolBbzcxs,7921
 plain/views/redirect.py,sha256=KLnlktzK6ZNMTlaEiZpMKQMEP5zeTgGLJ9BIkIJfwBo,1733
 plain/views/templates.py,sha256=nF9CcdhhjAyp3LB0RrSYnBaHpHzMfPSw719RCdcXk7o,2007
-plain-0.14.1.dist-info/METADATA,sha256=TcNf9s_L6irqxS7NOX_4RRSASEuzIBW9kshjZ_DaUg8,2518
-plain-0.14.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain-0.14.1.dist-info/entry_points.txt,sha256=DHHprvufgd7xypiBiqMANYRnpJ9xPPYhYbnPGwOkWqE,40
-plain-0.14.1.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain-0.14.1.dist-info/RECORD,,
+plain-0.16.0.dist-info/METADATA,sha256=QYjt6bNbKLzOHA2ER7Mch3hy9f0nrZm03kXJM56hQXs,2518
+plain-0.16.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain-0.16.0.dist-info/entry_points.txt,sha256=DHHprvufgd7xypiBiqMANYRnpJ9xPPYhYbnPGwOkWqE,40
+plain-0.16.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain-0.16.0.dist-info/RECORD,,