Add get_entity_url()

Close #516
LeMyst · Apr 24, 2023 · 3ebf4ac · 3ebf4ac
1 parent ba1f206
commit 3ebf4ac
Show file tree

Hide file tree

Showing 9 changed files with 104 additions and 0 deletions.
diff --git a/test/test_entity_item.py b/test/test_entity_item.py
@@ -63,3 +63,8 @@ def test_write_required_ref(self):
 
     def test_long_item_id(self):
         assert wbi.item.get('Item:Q582').id == 'Q582'
+
+    def test_entity_url(self):
+        assert wbi.item.new(id='Q582').get_entity_url() == 'http://www.wikidata.org/entity/Q582'
+        assert wbi.item.new(id='582').get_entity_url() == 'http://www.wikidata.org/entity/Q582'
+        assert wbi.item.new(id=582).get_entity_url() == 'http://www.wikidata.org/entity/Q582'
diff --git a/test/test_entity_lexeme.py b/test/test_entity_lexeme.py
@@ -35,3 +35,8 @@ def test_get_json(self):
 
     def test_long_item_id(self):
         assert wbi.lexeme.get('Lexeme:L582').id == 'L582'
+
+    def test_entity_url(self):
+        assert wbi.lexeme.new(id='L582').get_entity_url() == 'http://www.wikidata.org/entity/L582'
+        assert wbi.lexeme.new(id='582').get_entity_url() == 'http://www.wikidata.org/entity/L582'
+        assert wbi.lexeme.new(id=582).get_entity_url() == 'http://www.wikidata.org/entity/L582'
diff --git a/test/test_entity_mediainfo.py b/test/test_entity_mediainfo.py
@@ -32,3 +32,8 @@ def test_get(self):
 
     def test_get_json(self):
         assert wbi.mediainfo.get('M75908279', mediawiki_api_url='https://commons.wikimedia.org/w/api.php').get_json()
+
+    def test_entity_url(self):
+        assert wbi.mediainfo.new(id='M582').get_entity_url() == 'http://www.wikidata.org/entity/M582'
+        assert wbi.mediainfo.new(id='582').get_entity_url() == 'http://www.wikidata.org/entity/M582'
+        assert wbi.mediainfo.new(id=582).get_entity_url() == 'http://www.wikidata.org/entity/M582'
diff --git a/test/test_entity_property.py b/test/test_entity_property.py
@@ -38,3 +38,8 @@ def test_create_property(self):
 
     def test_long_item_id(self):
         assert wbi.property.get('Property:P582').id == 'P582'
+
+    def test_entity_url(self):
+        assert wbi.property.new(id='P582').get_entity_url() == 'http://www.wikidata.org/entity/P582'
+        assert wbi.property.new(id='582').get_entity_url() == 'http://www.wikidata.org/entity/P582'
+        assert wbi.property.new(id=582).get_entity_url() == 'http://www.wikidata.org/entity/P582'
diff --git a/wikibaseintegrator/entities/baseentity.py b/wikibaseintegrator/entities/baseentity.py
@@ -291,6 +291,14 @@ def write_required(self, base_filter: Optional[List[BaseDataType | List[BaseData
 
         return fastrun_container.write_required(data=claims_to_check, cqid=self.id, action_if_exists=action_if_exists)
 
+    def get_entity_url(self, wikibase_url: Optional[str] = None) -> str:
+        from wikibaseintegrator.wbi_config import config
+        wikibase_url = wikibase_url or str(config['WIKIBASE_URL'])
+        if wikibase_url and self.id:
+            return wikibase_url + '/entity/' + self.id
+
+        raise ValueError('wikibase_url or entity ID is null.')
+
     def __repr__(self):
         """A mixin implementing a simple __repr__."""
         return "<{klass} @{id:x} {attrs}>".format(  # pylint: disable=consider-using-f-string

diff --git a/wikibaseintegrator/entities/item.py b/wikibaseintegrator/entities/item.py
@@ -34,6 +34,25 @@ def __init__(self, labels: Optional[Labels] = None, descriptions: Optional[Descr
         # Item specific
         self.sitelinks = sitelinks or Sitelinks()
 
+    @BaseEntity.id.setter
+    def id(self, value: Union[None, str, int]):
+        if isinstance(value, str):
+            pattern = re.compile(r'^(?:[a-zA-Z]+:)?Q?([0-9]+)$')
+            matches = pattern.match(value)
+
+            if not matches:
+                raise ValueError(f"Invalid item ID ({value}), format must be 'Q[0-9]+'")
+
+            value = f'Q{matches.group(1)}'
+        elif isinstance(value, int):
+            value = f'Q{value}'
+        elif value is None:
+            pass
+        else:
+            raise ValueError(f"Invalid item ID ({value}), format must be 'Q[0-9]+'")
+
+        BaseEntity.id.fset(self, value)
+
     @property
     def labels(self) -> Labels:
         return self.__labels

diff --git a/wikibaseintegrator/entities/lexeme.py b/wikibaseintegrator/entities/lexeme.py
@@ -22,6 +22,25 @@ def __init__(self, lemmas: Optional[Lemmas] = None, lexical_category: Optional[s
         self.forms: Forms = forms or Forms()
         self.senses: Senses = senses or Senses()
 
+    @BaseEntity.id.setter
+    def id(self, value: Union[None, str, int]):
+        if isinstance(value, str):
+            pattern = re.compile(r'^(?:[a-zA-Z]+:)?L?([0-9]+)$')
+            matches = pattern.match(value)
+
+            if not matches:
+                raise ValueError(f"Invalid lexeme ID ({value}), format must be 'L[0-9]+'")
+
+            value = f'L{matches.group(1)}'
+        elif isinstance(value, int):
+            value = f'L{value}'
+        elif value is None:
+            pass
+        else:
+            raise ValueError(f"Invalid lexeme ID ({value}), format must be 'L[0-9]+'")
+
+        BaseEntity.id.fset(self, value)
+
     @property
     def lemmas(self) -> Lemmas:
         return self.__lemmas

diff --git a/wikibaseintegrator/entities/mediainfo.py b/wikibaseintegrator/entities/mediainfo.py
@@ -31,6 +31,25 @@ def __init__(self, labels: Optional[Labels] = None, descriptions: Optional[Descr
         self.descriptions: LanguageValues = descriptions or Descriptions()
         self.aliases = aliases or Aliases()
 
+    @BaseEntity.id.setter
+    def id(self, value: Union[None, str, int]):
+        if isinstance(value, str):
+            pattern = re.compile(r'^M?([0-9]+)$')
+            matches = pattern.match(value)
+
+            if not matches:
+                raise ValueError(f"Invalid MediaInfo ID ({value}), format must be 'M[0-9]+'")
+
+            value = f'M{matches.group(1)}'
+        elif isinstance(value, int):
+            value = f'M{value}'
+        elif value is None:
+            pass
+        else:
+            raise ValueError(f"Invalid MediaInfo ID ({value}), format must be 'M[0-9]+'")
+
+        BaseEntity.id.fset(self, value)
+
     @property
     def labels(self) -> Labels:
         return self.__labels

diff --git a/wikibaseintegrator/entities/property.py b/wikibaseintegrator/entities/property.py
@@ -24,6 +24,25 @@ def __init__(self, datatype: Union[str, WikibaseDatatype, None] = None, labels:
         self.descriptions: Descriptions = descriptions or Descriptions()
         self.aliases = aliases or Aliases()
 
+    @BaseEntity.id.setter
+    def id(self, value: Union[None, str, int]):
+        if isinstance(value, str):
+            pattern = re.compile(r'^(?:[a-zA-Z]+:)?P?([0-9]+)$')
+            matches = pattern.match(value)
+
+            if not matches:
+                raise ValueError(f"Invalid property ID ({value}), format must be 'P[0-9]+'")
+
+            value = f'P{matches.group(1)}'
+        elif isinstance(value, int):
+            value = f'P{value}'
+        elif value is None:
+            pass
+        else:
+            raise ValueError(f"Invalid property ID ({value}), format must be 'P[0-9]+'")
+
+        BaseEntity.id.fset(self, value)
+
     @property
     def datatype(self) -> Union[str, WikibaseDatatype, None]:
         return self.__datatype