add tag searching

Author: Evidlo

pykeepass/pykeepass.py

@@ -216,6 +216,10 @@ def _find(self, prefix, keys_xp, path=None, tree=None, first=False,
             if 'uuid' in kwargs.keys():
                 kwargs['uuid'] = base64.b64encode(kwargs['uuid'].bytes).decode('utf-8')
 
+            # convert tags to semicolon separated string before building xpath
+            if 'tags' in kwargs.keys():
+                kwargs['tags'] = ';'.join(kwargs['tags'])
+
             # build xpath to filter results with specified attributes
             for key, value in kwargs.items():
                 if key not in keys_xp[regex].keys():

pykeepass/xpath.py

@@ -31,6 +31,7 @@
         'url': '/String/Key[text()="URL"]/../Value[text()="{}"]/../..',
         'notes': '/String/Key[text()="Notes"]/../Value[text()="{}"]/../..',
         'uuid': '/UUID[text()="{}"]/..',
+        'tags': '/Tags[text()="{}"]/..',
         'string': '/String/Key[text()="{}"]/../Value[text()="{}"]/../..',
         'autotype_sequence': '/AutoType/DefaultSequence[text()="{}"]/../..',
         'autotype_enabled': '/AutoType/Enabled[text()="{}"]/../..',
@@ -42,6 +43,7 @@
         'url': '/String/Key[text()="URL"]/../Value[re:test(text(), "{}", "{flags}")]/../..',
         'notes': '/String/Key[text()="Notes"]/../Value[re:test(text(), "{}", "{flags}")]/../..',
         'uuid': '/UUID[re:test(text(), "{}", "{flags}")]/..',
+        'tags': '/Tags[re:test(text(), "{}", "{flags}")]/..',
         'string': '/String/Key[text()="{}"]/../Value[re:test(text(), "{}", "{flags}")]/../..',
         'autotype_sequence': '/AutoType/DefaultSequence[re:test(text(), "{}", "{flags}")]/../..',
         'autotype_enabled': '/AutoType/Enabled[re:test(text(), "{}", "{flags}")]/../..',

tests/test3.kdbx

@@ -110,6 +110,11 @@ def test_find_entries_by_uuid(self):
         self.assertEqual(uu, results.uuid)
         self.assertEqual('foobar_user', results.username)
 
+    def test_find_entries_by_tags(self):
+        results = self.kp.find_entries(tags=['tag1', 'tag2'], first=True)
+        self.assertIsInstance(results, Entry)
+        self.assertEqual('foobar_entry', results.title)
+
     def test_find_entries_by_string(self):
         results = self.kp.find_entries_by_string({'custom_field': 'custom field value'})[0]
         self.assertIsInstance(results, Entry)
@@ -797,7 +802,7 @@ def test_open_save(self):
             None,
             None,
             None,
-            b'5\x99y\xb6\x1e\x9e\x16\xfe`V\xd4\xe8\x12De\xd9[\xdd\xe2\x98\x1a\xa9\xfc-\xc4>\xd2\xc0\xc6(\xec\x0c',
+            b'\xfb\xb1!\x0e0\x94\xd4\x868\xa5\x04\xe6T\x9b<\xf9+\xb8\x82EN\xbc\xbe\xbc\xc8\xd3\xbbf\xfb\xde\xff.',
             b'M\xb7\x08\xf6\xa7\xd1v\xb1{&\x06\x8f\xae\xe9\r\xeb\x9a\x1b\x02b\xce\xf2\x8aR\xaea)7\x1fs\xe9\xc0',
         ]
         keyfiles = [
@@ -850,7 +855,6 @@ def test_open_save(self):
                  databases, passwords, transformed_keys,
                  keyfiles, encryption_algorithms, kdf_algorithms, versions
         ):
-
             kp = PyKeePass(
                 os.path.join(base_dir, database),
                 password,