Merge pull request #59 from artshumrc/30_improve_exceptions

Improve exceptions

Author: aweakley

edtf/appsettings.py

@@ -98,3 +98,5 @@
 MULTIPLIER_IF_APPROXIMATE = EDTF.get("MULTIPLIER_IF_APPROXIMATE", 1.0)
 MULTIPLIER_IF_BOTH = EDTF.get("MULTIPLIER_IF_BOTH", 2.0)
 DELTA_IF_UNKNOWN = EDTF.get("DELTA_IF_UNKNOWN", relativedelta(years=10))
+
+DEBUG_PYPARSING = False

edtf/fields.py

@@ -4,10 +4,12 @@
 from django.db import models
 from django.db.models import signals
 from django.db.models.query_utils import DeferredAttribute
+from pyparsing import ParseException
 
 from edtf import EDTFObject, parse_edtf
 from edtf.convert import struct_time_to_date, struct_time_to_jd
 from edtf.natlang import text_to_edtf
+from edtf.parser.edtf_exceptions import EDTFParseException
 
 DATE_ATTRS = (
     "lower_strict",
@@ -132,10 +134,12 @@ def update_values(self, instance, *args, **kwargs):
         if direct_input and (
             existing_value is None or str(existing_value) != direct_input
         ):
-            edtf = parse_edtf(
-                direct_input, fail_silently=True
-            )  # ParseException if invalid; should this be raised?
-            # TODO pyparsing.ParseExceptions are very noisy and dumps the whole grammar (see https://github.com/ixc/python-edtf/issues/46)
+            try:
+                edtf = parse_edtf(
+                    direct_input, fail_silently=True
+                )  # ParseException if invalid; should this be raised?
+            except ParseException as err:
+                raise EDTFParseException(direct_input, err) from None
 
             # set the natural_text (display) field to the direct_input if it is not provided
             if natural_text == "":

edtf/parser/edtf_exceptions.py

@@ -2,4 +2,28 @@
 
 
 class EDTFParseException(ParseException):
-    pass
+    """Raised when an input cannot be parsed as an EDTF string.
+
+    Attributes:
+    input_string - the input string that could not be parsed
+    err -- the original ParseException that caused this one
+    """
+
+    def __init__(self, input_string, err=None):
+        if input_string is None:
+            input_string = ""
+        self.input_string = input_string
+        if err is None:
+            err = ParseException(input_string, 0, "Invalid input or format.")
+        self.err = err
+        super().__init__(str(err), err.loc if err.loc else 0, self.input_string)
+
+    def __str__(self):
+        if not self.input_string:
+            return "You must supply some input text"
+        near_text = (
+            self.input_string[max(self.err.loc - 10, 0) : self.err.loc + 10]
+            if hasattr(self.err, "loc")
+            else ""
+        )
+        return f"Error at position {self.err.loc}: Invalid input or format near '{near_text}'. Please provide a valid EDTF string."

edtf/parser/grammar.py

@@ -4,6 +4,7 @@
 # https://github.com/pyparsing/pyparsing/wiki/Performance-Tips
 
 import pyparsing
+from edtf.appsettings import DEBUG_PYPARSING
 
 pyparsing.ParserElement.enablePackrat()
 
@@ -342,14 +343,18 @@ def f(toks):
 )
 
 
-def parse_edtf(str, parseAll=True, fail_silently=False):
+def parse_edtf(input_string, parseAll=True, fail_silently=False, debug=None):
+    if debug is None:
+        debug = DEBUG_PYPARSING
+    if not input_string:
+        raise EDTFParseException(input_string)
     try:
-        if not str:
-            raise ParseException("You must supply some input text")
-        p = edtfParser.parseString(str.strip(), parseAll)
+        p = edtfParser.parseString(input_string.strip(), parseAll)
         if p:
             return p[0]
     except ParseException as err:
         if fail_silently:
             return None
-        raise EDTFParseException(err) from err
+        if debug:
+            raise
+        raise EDTFParseException(input_string, err) from None

edtf/parser/tests.py

@@ -347,6 +347,14 @@ def test_non_parsing(bad_input):
         parse(bad_input)
 
 
+@pytest.mark.parametrize("bad_input", [None, ""])
+def test_empty_input(bad_input):
+    """Test that empty input raises a specific exception."""
+    with pytest.raises(EDTFParseException) as exc_info:
+        parse(bad_input)
+    assert "You must supply some input text" in str(exc_info.value)
+
+
 def test_comparisons():
     """Test comparisons between parsed EDTF objects and standard dates."""
     d1 = parse("1979-08~")

edtf_django_tests/edtf_integration/admin.py

@@ -1 +1,43 @@
-# Register your models here.
+from django.contrib import admin
+
+from .models import TestEvent
+
+
+class TestEventAdmin(admin.ModelAdmin):
+    list_display = (
+        "date_display",
+        "date_edtf_direct",
+        "date_earliest",
+        "date_latest",
+        "date_sort_ascending",
+        "date_sort_descending",
+        "date_edtf",
+    )
+    search_fields = ("date_display", "date_edtf_direct")
+    list_filter = ("date_earliest", "date_latest")
+    readonly_fields = (
+        "date_earliest",
+        "date_latest",
+        "date_sort_ascending",
+        "date_sort_descending",
+        "date_edtf",
+    )
+
+    fieldsets = (
+        (None, {"fields": ("date_display", "date_edtf_direct", "date_edtf")}),
+        (
+            "Computed Dates",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "date_earliest",
+                    "date_latest",
+                    "date_sort_ascending",
+                    "date_sort_descending",
+                ),
+            },
+        ),
+    )
+
+
+admin.site.register(TestEvent, TestEventAdmin)

edtf_django_tests/edtf_integration/models.py

@@ -49,9 +49,5 @@ def __str__(self) -> str:
         return (
             f"Test Event: {self.date_display=}, "
             f"{self.date_edtf_direct=}, "
-            f"{self.date_earliest=}, "
-            f"{self.date_latest=}, "
-            f"{self.date_sort_ascending=}, "
-            f"{self.date_sort_descending=}, "
             f"{self.date_edtf=}"
         )