Merge pull request #107 from goodmami/v0.6.1

Fix #106: add wn.DatabaseError for schema changes

CHANGELOG.md

@@ -3,6 +3,16 @@
 ## [Unreleased]
 
 
+## [v0.6.1]
+
+**Release date: 2021-03-05**
+
+### Added
+
+* `wn.DatabaseError` as a more specific error type for schema changes
+  ([#106])
+
+
 ## [v0.6.0]
 
 **Release date: 2021-03-04**
@@ -292,6 +302,7 @@ the https://github.com/nltk/wordnet/ code which had been effectively
 abandoned, but this is an entirely new codebase.
 
 
+[v0.6.1]: ../../releases/tag/v0.6.1
 [v0.6.0]: ../../releases/tag/v0.6.0
 [v0.5.1]: ../../releases/tag/v0.5.1
 [v0.5.0]: ../../releases/tag/v0.5.0
@@ -339,3 +350,4 @@ abandoned, but this is an entirely new codebase.
 [#99]: https://github.com/goodmami/wn/issues/99
 [#104]: https://github.com/goodmami/wn/issues/104
 [#105]: https://github.com/goodmami/wn/issues/105
+[#106]: https://github.com/goodmami/wn/issues/106

README.md

@@ -19,6 +19,13 @@
 
 ---
 
+**Notice for users upgrading to v0.6:** Version v0.6.0 introduced
+changes to the database schema that require the user to rebuild their
+database. Please [raise an
+issue](https://github.com/goodmami/wn/issues/new) if you need help.
+
+---
+
 Wn is a Python library for exploring information in wordnets. Install
 it from PyPI:
 

docs/api/wn.rst

@@ -308,4 +308,5 @@ Exceptions
 ----------
 
 .. autoexception:: Error
+.. autoexception:: DatabaseError
 .. autoexception:: WnWarning

wn/__init__.py

@@ -30,11 +30,12 @@
     'ilis',
     'ILI',
     'Error',
+    'DatabaseError',
     'WnWarning',
 )
 
 from wn._meta import __version__
-from wn._exceptions import Error, WnWarning
+from wn._exceptions import Error, DatabaseError, WnWarning
 from wn._config import config  # noqa: F401
 from wn._add import add, remove
 from wn._export import export

wn/_db.py

@@ -113,14 +113,14 @@ def _check_schema_compatibility(conn: sqlite3.Connection, dbpath: Path) -> None:
     try:
         specs = conn.execute('SELECT id, version FROM lexicons').fetchall()
     except sqlite3.OperationalError as exc:
-        raise wn.Error(msg) from exc
+        raise wn.DatabaseError(msg) from exc
     else:
         if specs:
             installed = '\n  '.join(f'{id}:{ver}' for id, ver in specs)
             msg += f" Lexicons currently installed:\n  {installed}"
         else:
             msg += ' No lexicons are currently installed.'
-        raise wn.Error(msg)
+        raise wn.DatabaseError(msg)
 
 
 def schema_hash(conn: sqlite3.Connection) -> str:

wn/_exceptions.py

@@ -6,6 +6,12 @@ class Error(Exception):
     __module__ = 'wn'
 
 
+class DatabaseError(Error):
+    """Error class for issues with the database."""
+
+    __module__ = 'wn'
+
+
 class WnWarning(Warning):
     """Generic warning class for dubious worndet operations."""
 

wn/_meta.py

@@ -1,2 +1,2 @@
 
-__version__ = '0.6.0'
+__version__ = '0.6.1'