Add ability to mark lexicons as modified

Related to #17

CHANGELOG.md

@@ -25,6 +25,7 @@
 * Support for detecting and loading ILI tab-separated-value exports;
   not directly accessible through the public API at this time ([#23])
 * Support for adding ILI resources to the database ([#23])
+* `wn.Lexicon.modified()` ([#17])
 
 ### Fixed
 
@@ -67,6 +68,7 @@
 * All extendable tables are now linked to their lexicon ([#91])
 * Added rowid to tables with metadata
 * Added source-sense to definitions table ([#65])
+* Preemptively added a `modified` column to `lexicons` table ([#17])
 
 
 ## [v0.5.1]
@@ -259,6 +261,7 @@ abandoned, but this is an entirely new codebase.
 [unreleased]: ../../tree/main
 
 [#15]: https://github.com/goodmami/wn/issues/15
+[#17]: https://github.com/goodmami/wn/issues/17
 [#23]: https://github.com/goodmami/wn/issues/23
 [#47]: https://github.com/goodmami/wn/issues/47
 [#58]: https://github.com/goodmami/wn/issues/58

docs/api/wn.rst

@@ -231,6 +231,7 @@ The Lexicon Class
 
    .. automethod:: metadata
    .. automethod:: specifier
+   .. automethod:: modified
 
 The wn.config Object
 --------------------

wn/_add.py

@@ -112,7 +112,7 @@ def _add_lmf(
                 continue
 
             cur.execute(
-                'INSERT INTO lexicons VALUES (null,?,?,?,?,?,?,?,?,?)',
+                'INSERT INTO lexicons VALUES (null,?,?,?,?,?,?,?,?,?,?)',
                 (lexicon.id,
                  lexicon.label,
                  lexicon.language,
@@ -121,7 +121,8 @@ def _add_lmf(
                  lexicon.version,
                  lexicon.url,
                  lexicon.citation,
-                 lexicon.meta))
+                 lexicon.meta,
+                 False))
             lexid = cur.lastrowid
 
             counts = info['counts']

wn/_core.py

@@ -13,6 +13,7 @@
     find_senses,
     find_synsets,
     get_lexicon,
+    get_modified,
     get_form_tags,
     get_entry_senses,
     get_sense_relations,
@@ -115,16 +116,16 @@ class Lexicon(_DatabaseEntity):
     _ENTITY_TYPE = 'lexicons'
 
     def __init__(
-            self,
-            id: str,
-            label: str,
-            language: str,
-            email: str,
-            license: str,
-            version: str,
-            url: str = None,
-            citation: str = None,
-            _id: int = NON_ROWID,
+        self,
+        id: str,
+        label: str,
+        language: str,
+        email: str,
+        license: str,
+        version: str,
+        url: str = None,
+        citation: str = None,
+        _id: int = NON_ROWID,
     ):
         super().__init__(_id=_id)
         self.id = id
@@ -148,6 +149,10 @@ def specifier(self) -> str:
         """Return the *id:version* lexicon specifier."""
         return f'{self.id}:{self.version}'
 
+    def modified(self) -> bool:
+        """Return True if the lexicon has local modifications."""
+        return get_modified(self._id)
+
 
 class _LexiconElement(_DatabaseEntity):
     __slots__ = '_lexid', '_wordnet'

wn/_db.py

@@ -37,7 +37,7 @@
 # >>> wn._db.schema_hash(conn)
 #
 COMPATIBLE_SCHEMA_HASHES = {
-    'd2cc6989a7a13dc76a7e332841d5f51d9a54368a',
+    'c400433b9d05fcb235f361b5bafdf831a12ea994',
 }
 
 

wn/_queries.py

@@ -153,6 +153,11 @@ def _get_lexicon_rowids_for_lexicon(
     return lex_match
 
 
+def get_modified(rowid: int) -> bool:
+    query = 'SELECT modified FROM lexicons WHERE rowid = ?'
+    return connect().execute(query, (rowid,)).fetchone()[0]
+
+
 def find_ilis(
     id: str = None,
     status: str = None,

wn/schema.sql

@@ -10,6 +10,7 @@ CREATE TABLE lexicons (
     url TEXT,
     citation TEXT,
     metadata META,
+    modified BOOLEAN CHECK( modified IN (0, 1) ) DEFAULT 0 NOT NULL,
     UNIQUE (id, version)
 );