Rename EntryError.url to EntryError.feed_url.

For #183.

CHANGES.rst

@@ -61,9 +61,24 @@ Unreleased
         Use :exc:`FeedMetadataNotFoundError` instead.
 
     **This is a minor compatibility break**,
-    and affects only third-party code that instantiates
+    but only affects third-party code that instantiates
     these exceptions *directly*.
 
+* Rename the ``url`` argument of :exc:`EntryError` to ``feed_url``.
+  Rename :attr:`EntryError.url` to :attr:`~EntryError.feed_url`;
+  for backwards compatibility,
+  the old attribute will be available as a property **until version 2.0**,
+  when it **will be removed.** (:issue:`183`).
+
+  .. warning::
+
+    The signature of :exc:`EntryError` (and its subclasses)
+    changed from ``EntryError(url, id)`` to ``EntryError(feed_url, id)``.
+
+    **This is a minor compatibility break**,
+    but only affects third-party code that instantiates
+    these exceptions *directly* with ``url`` as a *keyword argument*.
+
 * Rename :meth:`~Reader.remove_feed` to :meth:`~Reader.delete_feed`.
   For backwards compatibility,
   the old method will continue to work **until version 2.0**,

src/reader/exceptions.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Any
 from typing import Tuple
 
@@ -100,22 +101,24 @@ class ParseError(FeedError):
 
 
 class EntryError(ReaderError):
-    """An entry error occured."""
+    """An entry error occurred.
 
-    def __init__(self, url: str, id: str, message: str = '') -> None:
-        super().__init__(message)
+    .. versionchanged:: 1.18
+        The ``url`` argument/attribute was renamed to ``feed_url``.
+    """
 
-        # TODO: .url should be .feed_url
+    def __init__(self, feed_url: str, id: str, message: str = '') -> None:
+        super().__init__(message)
 
         #: The feed URL.
-        self.url = url
+        self.feed_url = feed_url
 
         #: The entry id.
         self.id = id
 
     @property
     def _str(self) -> str:
-        return repr((self.url, self.id))
+        return repr((self.feed_url, self.id))
 
     @property
     def object_id(self) -> Tuple[str, str]:
@@ -124,7 +127,22 @@ def object_id(self) -> Tuple[str, str]:
         .. versionadded:: 1.12
 
         """
-        return self.url, self.id
+        return self.feed_url, self.id
+
+    @property
+    def url(self) -> str:
+        """Deprecated alias for :attr:`EntryError.feed_url`.
+
+        .. deprecated: 1.18
+
+        """
+        warnings.warn(
+            "EntryError.url is deprecated "
+            "and will be removed in reader 2.0. "
+            "Use EntryError.feed_url instead.",
+            DeprecationWarning,
+        )
+        return self.feed_url
 
 
 class EntryNotFoundError(EntryError):
@@ -185,8 +203,8 @@ class EntryMetadataNotFoundError(MetadataNotFoundError, EntryError):
 
     """
 
-    def __init__(self, url: str, id: str, key: str, message: str = '') -> None:
-        super().__init__(url, id, key=key, message=message)
+    def __init__(self, feed_url: str, id: str, key: str, message: str = '') -> None:
+        super().__init__(feed_url, id, key=key, message=message)
 
 
 class StorageError(ReaderError):

tests/test_reader.py

@@ -925,12 +925,12 @@ def test_mark_as_read_unread(reader, entry_arg):
 
     with pytest.raises(EntryNotFoundError) as excinfo:
         reader.mark_entry_as_read(entry_arg(entry_with_feed))
-    assert (excinfo.value.url, excinfo.value.id) == (entry.feed_url, entry.id)
+    assert (excinfo.value.feed_url, excinfo.value.id) == (entry.feed_url, entry.id)
     assert 'no such entry' in excinfo.value.message
 
     with pytest.raises(EntryNotFoundError) as excinfo:
         reader.mark_entry_as_unread(entry_arg(entry_with_feed))
-    assert (excinfo.value.url, excinfo.value.id) == (entry.feed_url, entry.id)
+    assert (excinfo.value.feed_url, excinfo.value.id) == (entry.feed_url, entry.id)
     assert 'no such entry' in excinfo.value.message
 
     reader.add_feed(feed.url)
@@ -1648,7 +1648,7 @@ def test_get_entry(reader, entry_arg):
 
     with pytest.raises(EntryNotFoundError) as excinfo:
         reader.get_entry(entry_arg(entry.as_entry(feed=feed)))
-    assert (excinfo.value.url, excinfo.value.id) == (entry.feed_url, entry.id)
+    assert (excinfo.value.feed_url, excinfo.value.id) == (entry.feed_url, entry.id)
     assert 'no such entry' in excinfo.value.message
     assert reader.get_entry(entry_arg(entry.as_entry(feed=feed)), None) == None
     assert reader.get_entry(entry_arg(entry.as_entry(feed=feed)), 1) == 1

tests/test_reader_deprecations.py

@@ -3,6 +3,8 @@
 import pytest
 from fakeparser import Parser
 
+from reader import EntryError
+from reader import EntryNotFoundError
 from reader import FeedMetadataNotFoundError
 from reader import FeedNotFoundError
 
@@ -69,3 +71,10 @@ def test_mark_as(reader):
     with pytest.deprecated_call():
         reader.mark_as_unimportant(entry)
     assert not reader.get_entry(entry).important
+
+
+@pytest.mark.parametrize('cls', [EntryError, EntryNotFoundError])
+def test_entry_error_url(cls):
+    exc = cls('feed', 'id')
+    with pytest.deprecated_call():
+        assert exc.url == 'feed'