├── __init__.py ├── requirements.txt ├── credentials.py.example ├── .gitignore ├── test_submit.py ├── test_entity.py ├── README.md ├── test_api.py ├── entity.py ├── api.py └── LICENSE /__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | jsonpatch 3 | -------------------------------------------------------------------------------- /credentials.py.example: -------------------------------------------------------------------------------- 1 | access_token="YOUR ACCESS TOKEN HERE" 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | credentials.py 3 | __pycache__/ 4 | venv/ 5 | -------------------------------------------------------------------------------- /test_submit.py: -------------------------------------------------------------------------------- 1 | from entity import * 2 | from test_api import make_up_string 3 | import requests 4 | import credentials 5 | import random 6 | 7 | connection = Connection(endpoint="https://test.wikidata.org/w/rest.php/wikibase/v0", access_token=credentials.access_token) 8 | 9 | def make_up_badge(): 10 | badges = ["Q609", "Q608", "Q226102", "Q226103"] 11 | n = random.randint(0, 2**32 - 1) % 3 12 | return badges[n] 13 | 14 | def make_up_item(): 15 | url = "https://test.wikidata.org/w/api.php" 16 | params = { 17 | "action": "query", 18 | "list": "random", 19 | "rnnamespace": 0, 20 | "rnlimit": 1, 21 | "rnfilterredir": "nonredirects", 22 | "format": "json" 23 | } 24 | response = requests.get(url, params=params) 25 | data = response.json() 26 | qitem = data["query"]["random"][0]["title"] 27 | return str(qitem) 28 | 29 | def make_up_sitelink(domain="en.wikipedia.org", namespace=0): 30 | url = "https://" + domain + "/w/api.php" 31 | params = { 32 | "action": "query", 33 | "list": "random", 34 | "rnnamespace": namespace, 35 | "rnlimit": 1, 36 | "format": "json" 37 | } 38 | response = requests.get(url, params=params) 39 | data = response.json() 40 | article_title = data['query']['random'][0]['title'] 41 | article_link = f"https://{domain}/wiki/{article_title.replace(' ', '_')}" 42 | return article_title, article_link 43 | 44 | def make_up_commons_file(): 45 | article_title, _ = make_up_sitelink(domain="commons.wikimedia.org", namespace=6) 46 | article_title = article_title.replace("File:", "") 47 | return article_title 48 | 49 | def make_up_time(): 50 | year = str(random.randint(1800, 2020)) 51 | month = str(random.randint(1, 13)).zfill(2) 52 | day = str(random.randint(1, 29)).zfill(2) 53 | return f"+{year}-{month}-{day}" 54 | 55 | def generate_random_test_entity(entity_id=None): 56 | entity = Entity(connection=connection, entity_id=entity_id) 57 | entity.set_label("en", make_up_string("l")) 58 | entity.set_description("en", make_up_string("d")) 59 | entity.add_alias("en", make_up_string("a")) 60 | 61 | article_title, article_link = make_up_sitelink() 62 | if entity_id is None: 63 | # Apparently the REST API can't be used to modify existing sitelinks 64 | # So I am dropping that as a test case for the existing item. 65 | sitelink = Sitelink(site_code="enwiki", title=article_title, url=article_link) 66 | sitelink.add_badge(make_up_badge()) 67 | entity.add_sitelink(sitelink) 68 | 69 | statement = Statement( 70 | property_id="P95201", 71 | data_type="wikibase-item", 72 | value_content=make_up_item() 73 | ) 74 | 75 | qualifier = Snak(property_id="P664", data_type="string", value_content=make_up_string("q")) 76 | statement.add_qualifier(qualifier) 77 | 78 | reference = Reference() 79 | ref_part = Snak(property_id="P43659", data_type="url", value_content=f"https://{make_up_string('X')}.com") 80 | reference.add_part(ref_part) 81 | statement.add_reference(reference) 82 | 83 | entity.add_statement(statement) 84 | 85 | # Testing other data types 86 | st = Statement() 87 | st.set_string_value("P664", make_up_string("s")) 88 | entity.add_statement(st) 89 | 90 | st = Statement() 91 | st.set_monolingual_text_value("P98445", "en", make_up_string("m")) 92 | entity.add_statement(st) 93 | 94 | st = Statement() 95 | st.set_external_id_value("P98444", make_up_string("i")) 96 | entity.add_statement(st) 97 | 98 | st = Statement() 99 | st.set_url_value("P7711", f"https://{make_up_string('R')}.org") 100 | entity.add_statement(st) 101 | 102 | st = Statement() 103 | st.set_quantity_value("P543", random.randint(0, 1000), "http://test.wikidata.org/entity/" + make_up_item()) 104 | entity.add_statement(st) 105 | 106 | st = Statement() 107 | st.set_commons_media_value("P98443", make_up_commons_file()) 108 | entity.add_statement(st) 109 | 110 | st = Statement() 111 | st.set_time_value("P66", make_up_time(), 11) 112 | entity.add_statement(st) 113 | 114 | return entity 115 | 116 | 117 | if __name__ == "__main__": 118 | new_item = generate_random_test_entity() 119 | new_item.submit() 120 | 121 | existing_item = generate_random_test_entity(entity_id="Q235642") 122 | existing_item.submit() 123 | -------------------------------------------------------------------------------- /test_entity.py: -------------------------------------------------------------------------------- 1 | from entity import * 2 | import unittest 3 | 4 | connection = Connection() 5 | 6 | class TestSnak(unittest.TestCase): 7 | def test_set_and_get_property(self): 8 | snak = Snak() 9 | snak.set_property("P123", "string") 10 | self.assertEqual(snak.get_property_id(), "P123") 11 | self.assertEqual(snak.get_property_type(), "string") 12 | 13 | def test_set_value(self): 14 | snak = Snak() 15 | snak.set_value("some_value") 16 | self.assertEqual(snak.get_value(), {"type": "value", "content": "some_value"}) 17 | 18 | def test_set_no_value(self): 19 | snak = Snak() 20 | snak.set_no_value() 21 | self.assertEqual(snak.get_value(), {"type": "novalue"}) 22 | 23 | def test_set_unknown_value(self): 24 | snak = Snak() 25 | snak.set_unknown_value() 26 | self.assertEqual(snak.get_value(), {"type": "somevalue"}) 27 | 28 | def test_set_wikibase_item_value(self): 29 | snak = Snak() 30 | snak.set_wikibase_item_value("P456", "Q789") 31 | self.assertEqual(snak.get_property_id(), "P456") 32 | self.assertEqual(snak.get_property_type(), "wikibase-item") 33 | self.assertEqual(snak.get_value(), {"type": "value", "content": "Q789"}) 34 | 35 | class TestSitelink(unittest.TestCase): 36 | def test_set_and_get_title(self): 37 | sitelink = Sitelink() 38 | sitelink.set_title("Example Title") 39 | self.assertEqual(sitelink.get_title(), "Example Title") 40 | 41 | def test_set_and_get_url(self): 42 | sitelink = Sitelink() 43 | sitelink.set_url("https://example.com") 44 | self.assertEqual(sitelink.get_url(), "https://example.com") 45 | 46 | def test_add_and_remove_badge(self): 47 | sitelink = Sitelink() 48 | sitelink.add_badge("Q123") 49 | self.assertIn("Q123", sitelink.get_badges()) 50 | sitelink.remove_badge("Q123") 51 | self.assertNotIn("Q123", sitelink.get_badges()) 52 | 53 | class TestReference(unittest.TestCase): 54 | def test_set_and_get_hash(self): 55 | reference = Reference() 56 | reference.set_hash("abc123") 57 | self.assertEqual(reference.get_hash(), "abc123") 58 | 59 | def test_add_and_remove_part(self): 60 | reference = Reference() 61 | snak = Snak(property_id="P123", data_type="string", value_type="value", value_content="some_value") 62 | reference.add_part(snak) 63 | self.assertIn(snak.data, reference.data["parts"]) 64 | reference.remove_part(snak) 65 | self.assertNotIn(snak.data, reference.data["parts"]) 66 | 67 | class TestStatement(unittest.TestCase): 68 | def test_set_and_get_id(self): 69 | statement = Statement(statement_id="S123") 70 | self.assertEqual(statement.get_id(), "S123") 71 | 72 | def test_set_and_get_rank(self): 73 | statement = Statement() 74 | statement.set_rank("preferred") 75 | self.assertEqual(statement.get_rank(), "preferred") 76 | 77 | def test_add_and_remove_qualifier(self): 78 | statement = Statement() 79 | snak = Snak(property_id="P123", data_type="string", value_type="value", value_content="some_value") 80 | statement.add_qualifier(snak) 81 | self.assertIn(snak.data, statement.get_qualifiers()) 82 | statement.remove_qualifier(snak) 83 | self.assertNotIn(snak.data, statement.get_qualifiers()) 84 | 85 | def test_add_and_remove_reference(self): 86 | statement = Statement() 87 | reference = Reference(ref_hash="abc123") 88 | statement.add_reference(reference) 89 | self.assertIn(reference.data, statement.get_references()) 90 | statement.remove_reference(reference) 91 | self.assertNotIn(reference.data, statement.get_references()) 92 | 93 | class TestEntity(unittest.TestCase): 94 | def test_set_and_get_id(self): 95 | entity = Entity(connection=connection, entity_id="Q123") 96 | self.assertEqual(entity.get_id(), "Q123") 97 | 98 | def test_set_and_get_label(self): 99 | entity = Entity(connection=connection) 100 | entity.set_label("en", "Example Label") 101 | self.assertEqual(entity.get_label("en"), "Example Label") 102 | 103 | def test_set_and_get_description(self): 104 | entity = Entity(connection=connection) 105 | entity.set_description("en", "Example Description") 106 | self.assertEqual(entity.get_description("en"), "Example Description") 107 | 108 | def test_add_and_remove_alias(self): 109 | entity = Entity(connection=connection) 110 | entity.data["aliases"]["en"] = [] 111 | entity.add_alias("en", "Alias 1") 112 | self.assertIn("Alias 1", entity.get_aliases("en")) 113 | entity.remove_alias("en", "Alias 1") 114 | self.assertNotIn("Alias 1", entity.get_aliases("en")) 115 | 116 | def test_get_statements(self): 117 | entity = Entity(connection=connection) 118 | self.assertEqual(entity.get_statements(), {}) 119 | 120 | def test_get_sitelinks(self): 121 | entity = Entity(connection=connection) 122 | self.assertEqual(entity.get_sitelinks(), {}) 123 | 124 | if __name__ == '__main__': 125 | unittest.main() 126 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # wikibase-patcher 2 | 3 | Python functions for interacting with a Wikibase REST API and corresponding Python object classes. 4 | 5 | Note that for whatever reason, tests when editing properties have failed, so for now this is useful only for editing items. 6 | 7 | ## Setup 8 | 9 | 1. `git clone https://github.com/internetarchive/wikibase-patcher wikibasepatcher` 10 | 11 | 2. `cd wikibasepatcher` 12 | 13 | 3. `python3 -m venv venv` 14 | 15 | 4. `pip3 install -r requirements.txt` 16 | 17 | 5. `cp credentials.py.example credentials.py` 18 | 19 | 5. Generate an OAuth2 token for your batch-editing account. 20 | 21 | 6. Update `credentials.py` with the access token generated above. 22 | 23 | ## Usage 24 | 25 | This example uses Test Wikidata, its REST API endpoint, and its properties and items. 26 | 27 | ### Connecting to a Wikibase 28 | 29 | To interact with a Wikibase instance, you first need to establish a connection using the `Connection` class. This connection will handle the API requests and manage authentication. 30 | 31 | ```python 32 | from entity import Connection 33 | from credentials import access_token 34 | 35 | connection = Connection( 36 | # Replace with your Wikibase REST API endpoint 37 | endpoint="https://test.wikidata.org/w/rest.php/wikibase/v0", 38 | # Required for authenticated (edit) operations 39 | access_token=access_token, 40 | # Set as True to edit with bot flag 41 | bot=True, 42 | # Optional: default edit summary 43 | edit_summary="Updating item data", 44 | # Optional: tags to categorize edits (must be valid edit tags) 45 | tags=["tag1", "tag2"] 46 | ) 47 | ``` 48 | 49 | ### Instantiating an Entity 50 | 51 | Once the connection is established, you can instantiate an `Entity` object using an existing entity ID. This allows you to retrieve and manipulate the entity's data. 52 | 53 | ```python 54 | from entity import Entity 55 | 56 | entity_id = "Q42" # Replace with your entity ID 57 | entity = Entity(connection=connection, entity_id=entity_id) 58 | 59 | # Retrieve data from the Entity 60 | entity.load() 61 | ``` 62 | 63 | ### Retrieving Data from an Entity 64 | 65 | After loading an entity, you can access its various properties such as labels, descriptions, aliases, statements, and sitelinks. 66 | 67 | ```python 68 | # Get the entity ID 69 | print(entity.get_id()) 70 | 71 | # Get labels 72 | print(entity.get_labels()) 73 | 74 | # Get descriptions 75 | print(entity.get_descriptions()) 76 | 77 | # Get aliases 78 | print(entity.get_aliases()) 79 | 80 | # Get statements 81 | print(entity.get_statements()) 82 | 83 | # Get sitelinks 84 | print(entity.get_sitelinks()) 85 | ``` 86 | 87 | ### Updating and Setting Values 88 | 89 | You can update the entity's properties by setting new labels, descriptions, aliases, statements, and sitelinks. 90 | 91 | ```python 92 | # Set a new label 93 | entity.set_label("en", "New Label") 94 | 95 | # Set a new description 96 | entity.set_description("en", "New Description") 97 | 98 | # Add an alias 99 | entity.add_alias("en", "New Alias") 100 | 101 | # Create new string statement 102 | from entity import Statement 103 | 104 | statement = Statement() 105 | statement.set_string_value("P664", "New string value") 106 | 107 | # Add qualifier to statement 108 | # Qualifiers are snaks (property-value pairings) attached to statements 109 | # to provide nuance. 110 | from entity import Snak 111 | 112 | qualifier = Snak() 113 | qualifier.set_string_value("P38952", "Qualifier string") 114 | statement.add_qualifier(qualifier) 115 | 116 | # Add reference to statement 117 | # An individual reference is an array of snaks. The references section 118 | # of a statement is thus an array of arrays. 119 | from entity import Reference 120 | 121 | reference = Reference() 122 | ref_part = Snak() 123 | ref_part.set_url_value("P43659", "https://en.wikipedia.org") 124 | reference.add_part(ref_part) 125 | statement.add_reference(reference) 126 | 127 | # Add the complete statement to the entity 128 | entity.add_statement(st) 129 | 130 | # Add a sitelink to the entity 131 | from entity import Sitelink 132 | 133 | sitelink = Sitelink( 134 | site_code="enwiki", 135 | title="Douglas Adams", 136 | url="https://en.wikipedia.org/wiki/Douglas_Adams") 137 | 138 | entity.add_sitelink(sitelink) 139 | ``` 140 | ### Other data types 141 | 142 | ```python 143 | # Monolingual text: property ID, language code, value 144 | st = Statement() 145 | st.set_monolingual_text_value("P98445", "en", "English-language word") 146 | entity.add_statement(st) 147 | 148 | # External identifier: property ID, value 149 | st = Statement() 150 | st.set_external_id_value("P98444", "External identifier value") 151 | entity.add_statement(st) 152 | 153 | # URL: property ID, value 154 | st = Statement() 155 | st.set_url_value("P7711", "https://archive.org") 156 | entity.add_statement(st) 157 | 158 | # Quantity: property ID, quantity, unit of measurement 159 | st = Statement() 160 | st.set_quantity_value("P543", 155, "http://test.wikidata.org/entity/Q71737") 161 | entity.add_statement(st) 162 | 163 | # Commons file: property ID, filename (no prefixes) 164 | st = Statement() 165 | st.set_commons_media_value("P98443", "45313-Sougy-Arron.png") 166 | entity.add_statement(st) 167 | 168 | # Time value: property ID, date (with positive sign for CE), precision level 169 | st = Statement() 170 | st.set_time_value("P66", "+2001-01-15", 11) 171 | entity.add_statement(st) 172 | ``` 173 | 174 | ### Submitting Changes 175 | 176 | After making changes to the entity, you can submit the updated data back to the Wikibase instance. 177 | 178 | ```python 179 | entity.submit() 180 | ``` 181 | 182 | If no entity ID is specified, a new entity will be created. Otherwise, the existing entity will be updated. 183 | 184 | ### Important Notes 185 | - Before submitting, the script checks if any changes have been made by comparing the current data with the original data. If no changes are detected, the submission is skipped. 186 | - Only "item" type entities are supported for creation; updates can be made to any entity type (at least in theory; for unknown reasons this does not work for properties at the moment). 187 | -------------------------------------------------------------------------------- /test_api.py: -------------------------------------------------------------------------------- 1 | from api import * 2 | import credentials 3 | import hashlib 4 | import time 5 | 6 | test_endpoint = "https://test.wikidata.org/w/rest.php/wikibase/v0" 7 | 8 | def make_up_string(tweak): 9 | current_time = time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime()) 10 | time_bytes = current_time.encode('utf-8') 11 | md5_hash = hashlib.md5() 12 | md5_hash.update(time_bytes + tweak.encode('utf-8')) 13 | md5_digest = md5_hash.hexdigest() 14 | return md5_digest 15 | 16 | def test_create_apisession(): 17 | testobj = WikibaseRestAPI() 18 | assert testobj.api_key is None 19 | assert testobj.api_secret is None 20 | assert testobj.endpoint == wikidata_endpoint 21 | assert testobj.access_token is None 22 | assert testobj.base_headers == {"Content-Type": "application/json"} 23 | assert WikibaseRestAPI(endpoint=test_endpoint).endpoint == test_endpoint 24 | assert WikibaseRestAPI(access_token="abcdefg").base_headers == { 25 | "Content-Type": "application/json", 26 | "Authorization": "Bearer abcdefg" 27 | } 28 | 29 | def test_getters(): 30 | # Corresponding to test.wikidata.org 31 | test_item = "Q41487" 32 | test_property = "P98435" 33 | language_code = "en" 34 | site_code = "commonswiki" 35 | other_language_code = "en-us" 36 | test_item_statement = "Q41487$afcef841-4ee6-4be6-3c62-eb4021c84eed" 37 | test_item_statement_property = "P286" 38 | test_property_statement = "P98435$f2550e05-42fa-3537-c0a9-16aa8038f3f5" 39 | test_property_statement_property = "P31" 40 | 41 | testobj = WikibaseRestAPI(endpoint=test_endpoint) 42 | request = requests.get(test_endpoint + f"/entities/items/{test_item}") 43 | benchmark = request.json() 44 | request_property = requests.get(test_endpoint + f"/entities/properties/{test_property}") 45 | benchmark_property = request_property.json() 46 | 47 | print("get_item") 48 | assert testobj.get_item(test_item) \ 49 | == benchmark 50 | 51 | print("get_item_labels") 52 | assert testobj.get_item_labels(test_item) \ 53 | == benchmark["labels"] 54 | 55 | print("get_item_descriptions") 56 | assert testobj.get_item_descriptions(test_item) \ 57 | == benchmark["descriptions"] 58 | 59 | print("get_item_aliases") 60 | assert testobj.get_item_aliases(test_item) \ 61 | == benchmark["aliases"] 62 | 63 | print("get_item_sitelinks") 64 | assert testobj.get_item_sitelinks(test_item) \ 65 | == benchmark["sitelinks"] 66 | 67 | print("get_item_statements") 68 | assert testobj.get_item_statements(test_item) \ 69 | == benchmark["statements"] 70 | 71 | print("get_item_label") 72 | assert testobj.get_item_label(test_item, language_code) \ 73 | == benchmark["labels"].get(language_code) 74 | 75 | print("get_item_description") 76 | assert testobj.get_item_description(test_item, language_code) \ 77 | == benchmark["descriptions"].get(language_code) 78 | 79 | print("get_item_aliases_in_language") 80 | assert testobj.get_item_aliases_in_language(test_item, other_language_code) \ 81 | == benchmark["aliases"].get(other_language_code) 82 | 83 | print("get_item_sitelink") 84 | assert testobj.get_item_sitelink(test_item, site_code) \ 85 | == benchmark["sitelinks"].get(site_code) 86 | 87 | print("get_item_statement") 88 | assert testobj.get_item_statement(test_item, test_item_statement) \ 89 | == benchmark["statements"].get(test_item_statement_property)[0] 90 | 91 | print("get_property") 92 | assert testobj.get_property(test_property) \ 93 | == benchmark_property 94 | 95 | print("get_property_labels") 96 | assert testobj.get_property_labels(test_property) \ 97 | == benchmark_property["labels"] 98 | 99 | print("get_property_descriptions") 100 | assert testobj.get_property_descriptions(test_property) \ 101 | == benchmark_property["descriptions"] 102 | 103 | print("get_property_aliases") 104 | assert testobj.get_property_aliases(test_property) \ 105 | == benchmark_property["aliases"] 106 | 107 | print("get_property_statements") 108 | assert testobj.get_property_statements(test_property) \ 109 | == benchmark_property["statements"] 110 | 111 | print("get_property_label") 112 | assert testobj.get_property_label(test_property, language_code) \ 113 | == benchmark_property["labels"].get(language_code) 114 | 115 | print("get_property_description") 116 | assert testobj.get_property_description(test_property, language_code) \ 117 | == benchmark_property["descriptions"].get(language_code) 118 | 119 | print("get_property_aliases_in_language") 120 | assert testobj.get_property_aliases_in_language(test_property, other_language_code) \ 121 | == benchmark_property["aliases"].get(other_language_code) 122 | 123 | print("get_property_statement") 124 | assert testobj.get_property_statement(test_property, test_property_statement) \ 125 | == benchmark_property["statements"].get(test_property_statement_property)[0] 126 | 127 | 128 | def test_editing(): 129 | testobj = WikibaseRestAPI(endpoint=test_endpoint, access_token=credentials.access_token) 130 | 131 | print("add_item") 132 | item_data = { 133 | "labels": {"en": make_up_string("l")}, 134 | "descriptions": {"en": make_up_string("d")}, 135 | "aliases": {"en": [make_up_string("a")]} 136 | } 137 | item_response = testobj.add_item(item_data) 138 | item_id = item_response["id"] 139 | 140 | print("add_item_statement") 141 | statement_data = { 142 | "rank": "normal", 143 | "property": { "id": "P95201" }, 144 | "value": { 145 | "content": "Q41487", 146 | "type": "value" 147 | }, 148 | "qualifiers": [], 149 | "references": [] 150 | } 151 | statement_response = testobj.add_item_statement(item_id, statement_data) 152 | statement_id = statement_response["id"] 153 | 154 | print("update_item_labels") 155 | new_labels = {"en": make_up_string("l")} 156 | old_labels = item_data["labels"] 157 | testobj.update_item_labels(item_id, new_labels, old_labels) 158 | 159 | print("replace_item_statement") 160 | updated_statement_data = { 161 | "rank": "normal", 162 | "property": { 163 | "id": "P95201" 164 | }, 165 | "value": { 166 | "content": "Q225467", 167 | "type": "value" 168 | }, 169 | "qualifiers": [], 170 | "references": [] 171 | } 172 | testobj.replace_item_statement(item_id, statement_id, updated_statement_data) 173 | 174 | print("update_statement") 175 | testobj.update_statement(statement_id, statement_data, updated_statement_data) 176 | 177 | print("update_item") 178 | updated_item_data = item_data 179 | updated_item_data["statements"] = [statement_data] 180 | testobj.update_item(item_id, updated_item_data, item_data) 181 | 182 | print("update_item_descriptions") 183 | new_description = {"en": make_up_string("d")} 184 | old_description = updated_item_data["descriptions"] 185 | testobj.update_item_descriptions(item_id, new_description, old_description) 186 | 187 | print("update_item_aliases") 188 | new_aliases = {"en": [make_up_string("a")]} 189 | old_aliases = updated_item_data["aliases"] 190 | testobj.update_item_aliases(item_id, new_aliases, old_aliases) 191 | 192 | #print("delete_statement") 193 | #testobj.delete_item_statement(item_id, statement_id) 194 | 195 | # delete_item 196 | #testobj.delete_item(item_id) 197 | 198 | property_id = "P98435" 199 | property_data = requests.get(test_endpoint + f"/entities/properties/{property_id}").json() 200 | 201 | #print("add_property_statement") 202 | #property_statement_response = testobj.add_property_statement(property_id, statement_data) 203 | #property_statement_id = property_statement_response["id"] 204 | 205 | #print("update_property_labels") 206 | #new_property_labels = {"en": make_up_string("l")} 207 | #old_property_labels = property_data["labels"] 208 | #testobj.update_property_labels(property_id, new_property_labels, old_property_labels) 209 | 210 | #print("replace_property_statement") 211 | #testobj.replace_property_statement(property_id, property_statement_id, updated_statement_data) 212 | 213 | #print("delete_property_statement") 214 | #testobj.delete_property_statement(property_id, property_statement_id) 215 | 216 | # delete_property 217 | #testobj.delete_property(property_id) 218 | 219 | def run_tests(): 220 | test_create_apisession() 221 | test_getters() 222 | test_editing() 223 | print("Tests complete.") 224 | 225 | if __name__ == "__main__": 226 | run_tests() 227 | -------------------------------------------------------------------------------- /entity.py: -------------------------------------------------------------------------------- 1 | import json 2 | import copy 3 | from api import WikibaseRestAPI, wikidata_endpoint 4 | 5 | class Base: 6 | def __init__(self): 7 | self.data = {} 8 | 9 | def to_dict(self): 10 | return self.data 11 | 12 | class Connection: 13 | def __init__(self, endpoint=wikidata_endpoint, access_token=None, bot=False, edit_summary="Updating item data", tags=[]): 14 | self.endpoint = endpoint 15 | self.bot = bot 16 | self.edit_summary = edit_summary 17 | self.tags = [] 18 | self.api = WikibaseRestAPI(access_token=access_token, endpoint=self.endpoint) 19 | 20 | def add_edit_tag(self, content): 21 | self.tags.append(content) 22 | 23 | def remove_edit_tag(self, content): 24 | if content in self.tags: 25 | self.tags.remove(content) 26 | 27 | def set_edit_summary(self, content): 28 | self.edit_summary = content 29 | 30 | def append_to_edit_summary(self, content): 31 | self.edit_summary = f"{self.edit_summary} {content}" 32 | 33 | class Snak(Base): 34 | def __init__(self, property_id=None, data_type=None, value_type="value", value_content=None): 35 | self.data = { 36 | "property": { 37 | "id": property_id, 38 | "data_type": data_type}, 39 | "value": { 40 | "type": value_type} 41 | } 42 | 43 | if value_type not in ["somevalue", "novalue"]: 44 | self.data["value"]["content"] = value_content 45 | 46 | def get_property_id(self): 47 | return self.data["property"]["id"] 48 | 49 | def get_property_type(self): 50 | return self.data["property"]["data_type"] 51 | 52 | def get_value(self): 53 | return self.data["value"] 54 | 55 | def set_property(self, property_id, data_type): 56 | self.data["property"] = { 57 | "id": property_id, 58 | "data_type": data_type 59 | } 60 | 61 | def set_value(self, content): 62 | self.data["value"]["type"] = "value" 63 | self.data["value"]["content"] = content 64 | 65 | def set_no_value(self): 66 | self.data["value"] = {"type": "novalue"} 67 | 68 | def set_unknown_value(self): 69 | self.data["value"] = {"type": "somevalue"} 70 | 71 | def set_property_and_value(self, property_id, data_type, content): 72 | self.data = { 73 | "property": { 74 | "id": property_id, 75 | "data_type": data_type 76 | }, 77 | "value": { 78 | "type": "value", 79 | "content": content 80 | } 81 | } 82 | 83 | def set_wikibase_item_value(self, property_id, content): 84 | self.set_property_and_value(property_id, "wikibase-item", content) 85 | 86 | def set_string_value(self, property_id, content): 87 | self.set_property_and_value(property_id, "string", content) 88 | 89 | def set_monolingual_text_value(self, property_id, language, text): 90 | self.set_property_and_value(property_id, "monolingualtext", 91 | {"text": text, "language": language}) 92 | 93 | def set_external_id_value(self, property_id, content): 94 | self.set_property_and_value(property_id, "external-id", content) 95 | 96 | def set_url_value(self, property_id, content): 97 | self.set_property_and_value(property_id, "url", content) 98 | 99 | def set_quantity_value(self, property_id, amount, unit): 100 | if amount > 0: 101 | amount = "+" + str(amount) 102 | else: 103 | amount = str(amount) 104 | self.set_property_and_value(property_id, "quantity", 105 | {"amount": amount, "unit": unit}) 106 | 107 | def set_commons_media_value(self, property_id, content): 108 | self.set_property_and_value(property_id, "commonsMedia", content) 109 | 110 | def set_time_value(self, property_id, time, precision, calendarmodel="Q1985727"): 111 | self.set_property_and_value(property_id, "time", 112 | {"time": time + "T00:00:00Z", 113 | "precision": precision, 114 | "calendarmodel": f"http://www.wikidata.org/entity/{calendarmodel}"}) 115 | 116 | class Sitelink(Base): 117 | def __init__(self, site_code=None, title=None, url=None, badges=[]): 118 | self.site_code = site_code 119 | self.data = { 120 | "title": title, 121 | "url": url, 122 | "badges": badges 123 | } 124 | 125 | def get_site_code(self): 126 | return self.site_code 127 | 128 | def get_title(self): 129 | return self.data["title"] 130 | 131 | def get_url(self): 132 | return self.data["url"] 133 | 134 | def get_badges(self): 135 | return self.data["badges"] 136 | 137 | def set_site_code(self, content): 138 | self.site_code = content 139 | 140 | def set_title(self, content): 141 | self.data["title"] = content 142 | 143 | def set_url(self, content): 144 | self.data["url"] = content 145 | 146 | def add_badge(self, content): 147 | self.data["badges"].append(content) 148 | 149 | def remove_badge(self, content): 150 | if content in self.data["badges"]: 151 | self.data["badges"].remove(content) 152 | 153 | class Reference(Base): 154 | def __init__(self, ref_hash=None): 155 | self.data = { 156 | "hash": ref_hash, 157 | "parts": [] 158 | } 159 | 160 | def to_dict(self): 161 | return { 162 | "hash": self.data["hash"], 163 | "parts": [part.to_dict() for part in self.data["parts"]] 164 | } 165 | 166 | def get_hash(self): 167 | return self.data["hash"] 168 | 169 | def set_hash(self, ref_hash): 170 | self.data["hash"] = ref_hash 171 | 172 | def add_part(self, part): 173 | if isinstance(part, Snak): 174 | self.data["parts"].append(part.data) 175 | else: 176 | raise ValueError("Reference part must be a Snak") 177 | 178 | def remove_part(self, part): 179 | if part.data in self.data["parts"]: 180 | self.data["parts"].remove(part.data) 181 | 182 | class Statement(Snak): 183 | def __init__(self, statement_id=None, rank="normal", property_id=None, 184 | data_type=None, value_type="value", value_content=None): 185 | super().__init__( 186 | property_id=property_id, 187 | data_type=data_type, 188 | value_type=value_type, 189 | value_content=value_content) 190 | self.data["id"] = statement_id 191 | self.data["rank"] = rank 192 | self.data["qualifiers"] = [] 193 | self.data["references"] = [] 194 | 195 | def to_dict(self): 196 | r = { 197 | "id": self.data["id"], 198 | "rank": self.data["rank"], 199 | "property": self.data["property"], 200 | "value": self.data["value"], 201 | } 202 | if "qualifiers" in self.data: 203 | r["qualifiers"] = [qualifier.to_dict() for qualifier in self.data["qualifiers"]] 204 | if "references" in self.data: 205 | r["references"] = [reference.to_dict() for reference in self.data["references"]] 206 | 207 | def get_id(self): 208 | return self.data["id"] 209 | 210 | def get_rank(self): 211 | return self.data["rank"] 212 | 213 | def get_qualifiers(self): 214 | return self.data["qualifiers"] 215 | 216 | def get_references(self): 217 | return self.data["references"] 218 | 219 | def set_id(self, content): 220 | self.data["id"] = content 221 | 222 | def set_rank(self, content): 223 | if content in ["deprecated", "normal", "preferred"]: 224 | self.data["rank"] = content 225 | else: 226 | raise ValueError("Rank must be deprecated, normal, or preferred") 227 | 228 | def add_qualifier(self, qualifier): 229 | if isinstance(qualifier, Snak): 230 | self.data["qualifiers"].append(qualifier.data) 231 | else: 232 | raise ValueError("Qualifier must be a Snak") 233 | 234 | def remove_qualifier(self, qualifier): 235 | if qualifier.data in self.data["qualifiers"]: 236 | self.data["qualifiers"].remove(qualifier.data) 237 | 238 | def add_reference(self, reference): 239 | if isinstance(reference, Reference): 240 | self.data["references"].append(reference.data) 241 | else: 242 | raise ValueError("Reference must be a Reference-type object") 243 | 244 | def remove_reference(self, reference): 245 | if reference.data in self.data["references"]: 246 | self.data["references"].remove(reference.data) 247 | 248 | 249 | class Entity(Base): 250 | def __init__(self, connection=None, entity_id=None, entity_type="items"): 251 | self.data = { 252 | "id": entity_id, 253 | "type": entity_type, 254 | "labels": {}, 255 | "descriptions": {}, 256 | "aliases": {}, 257 | "statements": {}, 258 | "sitelinks": {} 259 | } 260 | if isinstance(connection, Connection): 261 | self.connection = connection 262 | else: 263 | raise ValueError("connection must be a Connection-type object") 264 | self.original_data = None 265 | if entity_id is not None and connection is not None: 266 | self.load() 267 | 268 | def load(self): 269 | if self.connection is None: 270 | raise Exception("No Wikibase connection defined.") 271 | self.data = self.connection.api.get_entity(self.data["type"], self.data["id"]) 272 | self.original_data = copy.deepcopy(self.data) 273 | 274 | def to_dict(self): 275 | statements = {} 276 | for property_id, statements_list in self.data["statements"].items(): 277 | expanded_statements_list = [] 278 | for statement in statements_list: 279 | to_append = {} 280 | if "id" in statement: 281 | to_append["id"] = statement["id"] 282 | if "rank" in statement: 283 | to_append["rank"] = statement["rank"] 284 | if "property" in statement: 285 | to_append["property"] = statement["property"] 286 | if "value" in statement: 287 | to_append["value"] = statement["value"] 288 | if "qualifiers" in statement: 289 | to_append["qualifiers"] = [qualifier.to_dict() for qualifier in statement["qualifiers"]] 290 | if "references" in statement: 291 | to_append["references"] = [reference.to_dict() for reference in statement["references"]] 292 | expanded_statements_list.append(to_append) 293 | statements[property_id] = expanded_statements_list 294 | return { 295 | "id": self.data["id"], 296 | "type": self.data["type"], 297 | "labels": self.data["labels"], 298 | "descriptions": self.data["descriptions"], 299 | "aliases": self.data["aliases"], 300 | "statements": statements, 301 | "sitelinks": self.data["sitelinks"] 302 | } 303 | 304 | def submit(self): 305 | if self.connection is None: 306 | raise Exception("No Wikibase connection defined.") 307 | # Don't submit anything if no changes have been made 308 | if self.data == self.original_data: 309 | return 310 | print(json.dumps(self.data)) 311 | if self.original_data is None: 312 | if self.data["type"] != "items": 313 | raise RuntimeException("Creation of non-item entities not supported.") 314 | # Submit new item (only items supported) 315 | return self.connection.api.add_item( 316 | self.data, 317 | bot=self.connection.bot, 318 | edit_summary=self.connection.edit_summary, 319 | tags=self.connection.tags) 320 | else: 321 | plural = {"item": "items", "property": "properties"} 322 | # Update existing entities 323 | return self.connection.api.update_entity( 324 | plural[self.data["type"]], 325 | self.data["id"], 326 | self.data, 327 | self.original_data, 328 | bot=self.connection.bot, 329 | edit_summary=self.connection.edit_summary, 330 | tags=self.connection.tags) 331 | 332 | def get_id(self): 333 | return self.data["id"] 334 | 335 | def get_entity_type(self): 336 | return self.data["type"] 337 | 338 | def get_labels(self): 339 | return self.data["labels"] 340 | 341 | def get_label(self, language_code): 342 | return self.data["labels"].get(language_code) 343 | 344 | def get_descriptions(self): 345 | return self.data["descriptions"] 346 | 347 | def get_description(self, language_code): 348 | return self.data["descriptions"].get(language_code) 349 | 350 | def get_aliases(self, language_code=None): 351 | if language_code is None: 352 | return self.data["aliases"] 353 | return self.data["aliases"].get(language_code) 354 | 355 | def get_statements(self, property_id=None): 356 | if property_id is None: 357 | return self.data["statements"] 358 | return self.data["statements"].get(property_id) 359 | 360 | def get_sitelinks(self): 361 | return self.data["sitelinks"] 362 | 363 | def get_sitelink(self, site_code): 364 | return self.data["sitelinks"].get(site_code) 365 | 366 | def set_label(self, language_code, content): 367 | self.data["labels"][language_code] = content 368 | 369 | def set_description(self, language_code, content): 370 | self.data["descriptions"][language_code] = content 371 | 372 | def add_alias(self, language_code, content): 373 | if language_code not in self.data["aliases"]: 374 | self.data["aliases"][language_code] = [] 375 | self.data["aliases"][language_code].append(content) 376 | 377 | def remove_alias(self, language_code, content): 378 | if language_code in self.data["aliases"] and content in self.data["aliases"][language_code]: 379 | self.data["aliases"][language_code].remove(content) 380 | 381 | def add_statement(self, content): 382 | if isinstance(content, Statement): 383 | if content.data["property"]["id"] not in self.data["statements"]: 384 | self.data["statements"][content.data["property"]["id"]] = [] 385 | self.data["statements"][content.data["property"]["id"]].append(content.data) 386 | else: 387 | raise ValueError("Statement must be a Statement-type object") 388 | 389 | def remove_statement(self, content): 390 | if content in self.data["statements"]: 391 | self.data["statements"].remove(content) 392 | 393 | def add_sitelink(self, content): 394 | if isinstance(content, Sitelink): 395 | self.data["sitelinks"][content.site_code] = content.data 396 | else: 397 | raise ValueError("Sitelink must be a Sitelink-type object") 398 | 399 | def remove_sitelink(self, content): 400 | if content in self.data["sitelinks"]: 401 | self.data["sitelinks"].remove(content) 402 | -------------------------------------------------------------------------------- /api.py: -------------------------------------------------------------------------------- 1 | import json 2 | import jsonpatch 3 | import requests 4 | import time 5 | 6 | wikidata_endpoint = "https://www.wikidata.org/w/rest.php/wikibase/v0" 7 | 8 | singular = { 9 | # English can't do plural inflections consistently. That would be too nice. 10 | "items": "item", 11 | "properties": "property" 12 | } 13 | 14 | def _prepare_payload(verb, part, new_data, old_data, bot, edit_summary, tags=[]): 15 | payload = { 16 | "tags": ["wikibase-patcher-v1"], 17 | "bot": bot 18 | } 19 | for tag in tags: 20 | payload["tags"].append(tag) 21 | if edit_summary is not None: 22 | payload["comment"] = edit_summary 23 | if verb.lower() == "patch" and old_data is not None: 24 | payload["patch"] = list(jsonpatch.make_patch(old_data, new_data)) 25 | elif verb.lower() != "delete": 26 | payload[part] = new_data 27 | return payload 28 | 29 | class WikibaseRestAPI: 30 | def get_access_token(self): 31 | if self.access_token is not None: 32 | return self.access_token 33 | if self.api_key is None or self.api_secret is None: 34 | return None 35 | 36 | return Exception("get_access_token is not implemented. You will need to" 37 | "provide an access token directly in the meantime.") 38 | 39 | # Do the non-owner API rigamarole to get an access token from a key and 40 | # secret. 41 | 42 | 43 | def __init__(self, access_token=None, api_key=None, api_secret=None, 44 | endpoint=wikidata_endpoint): 45 | self.api_key = api_key 46 | self.api_secret = api_secret 47 | self.endpoint = endpoint 48 | self.access_token = access_token 49 | if self.access_token is None: 50 | if self.api_key is not None and self.api_secret is not None: 51 | self.access_token = self.get_access_token() 52 | self.base_headers = {"Content-Type": "application/json"} 53 | if self.access_token is not None: 54 | self.base_headers["Authorization"] = f"Bearer {self.access_token}" 55 | 56 | def _request(self, verb, path, params={}, headers={}, payload=None, 57 | max_retries=10, base_delay=1, max_delay=60): 58 | for retry in range(max_retries): 59 | try: 60 | for k, v in self.base_headers.items(): 61 | headers[k] = v 62 | 63 | if verb.lower() == "patch": 64 | headers["Content-Type"] = "application/json-patch+json" 65 | 66 | request = requests.request( 67 | verb, 68 | self.endpoint + path, 69 | params=params, 70 | headers=headers, 71 | data=json.dumps(payload)) 72 | #print(f"{verb.upper()} {path}") 73 | if request.status_code == 409: 74 | print(f"Conflict; skipping – {request.text}") 75 | return request.json() 76 | elif request.status_code > 299: 77 | print(request.text) 78 | raise Exception("HTTP Error with status code: {}"\ 79 | .format(request.status_code)) 80 | return request.json() 81 | except (Exception, requests.exceptions.RequestException, 82 | requests.exceptions.JSONDecodeError) as e: 83 | if retry < max_retries - 1: 84 | delay = min(base_delay * (2 ** retry), max_delay) 85 | print(f"Error encountered: {str(e)}. " 86 | f"Retrying {retry + 2}/{max_retries} in {delay} seconds...") 87 | time.sleep(delay) 88 | continue 89 | else: # if it's the last retry, raise the error 90 | print(f"Error encountered: {str(e)}. All retries exhausted!") 91 | raise Exception(f"All retries exhausted after {max_retries}" 92 | f" attempts. Last error encountered: {str(e)}") 93 | 94 | def _get(self, path, params={}): 95 | return self._request("get", path, params=params) 96 | 97 | def _post(self, path, part, data, bot, edit_summary, tags): 98 | return self._request("post", path, payload=_prepare_payload( 99 | "post", part, data, None, bot, edit_summary, tags)) 100 | 101 | def _put(self, path, part, data, bot, edit_summary, tags): 102 | return self._request("put", path, payload=_prepare_payload( 103 | "put", part, data, None, bot, edit_summary, tags)) 104 | 105 | def _patch(self, path, data, old_data, bot, edit_summary, tags): 106 | return self._request("patch", path, payload=_prepare_payload( 107 | "patch", None, data, old_data, bot, edit_summary, tags)) 108 | 109 | def _delete(self, path, bot, edit_summary, tags): 110 | return self._request("delete", path, payload=_prepare_payload( 111 | "delete", None, None, None, bot, edit_summary, tags)) 112 | 113 | 114 | # GET 115 | def get_entity(self, entity_type, entity_id): 116 | return self._get(f"/entities/{entity_type}/{entity_id}") 117 | 118 | def get_entity_labels(self, entity_type, entity_id): 119 | return self._get(f"/entities/{entity_type}/{entity_id}/labels") 120 | 121 | def get_entity_label(self, entity_type, entity_id, language_code): 122 | return self._get(f"/entities/{entity_type}/{entity_id}/labels/{language_code}") 123 | 124 | def get_entity_descriptions(self, entity_type, entity_id): 125 | return self._get(f"/entities/{entity_type}/{entity_id}/descriptions") 126 | 127 | def get_entity_description(self, entity_type, entity_id, language_code): 128 | return self._get(f"/entities/{entity_type}/{entity_id}/descriptions/{language_code}") 129 | 130 | def get_entity_aliases(self, entity_type, entity_id): 131 | return self._get(f"/entities/{entity_type}/{entity_id}/aliases") 132 | 133 | def get_entity_aliases_in_language(self, entity_type, entity_id, language_code): 134 | return self._get(f"/entities/{entity_type}/{entity_id}/aliases/{language_code}") 135 | 136 | def get_entity_statements(self, entity_type, entity_id): 137 | return self._get(f"/entities/{entity_type}/{entity_id}/statements") 138 | 139 | def get_entity_statement(self, entity_type, entity_id, statement_id): 140 | return self._get(f"/entities/{entity_type}/{entity_id}/statements/{statement_id}") 141 | 142 | def get_item_sitelinks(self, item_id): 143 | return self._get(f"/entities/items/{item_id}/sitelinks") 144 | 145 | def get_item_sitelink(self, item_id, site_id): 146 | return self._get(f"/entities/items/{item_id}/sitelinks/{site_id}") 147 | 148 | 149 | # PATCH 150 | def update_statement(self, statement_id, data, old_data, 151 | bot=False,edit_summary=None, tags=[]): 152 | return self._patch(f"/statements/{statement_id}", 153 | data, old_data, bot, edit_summary, tags) 154 | 155 | def update_entity(self, entity_type, entity_id, data, old_data, 156 | bot=False, edit_summary=None, tags=[]): 157 | return self._patch(f"/entities/{entity_type}/{entity_id}", 158 | data, old_data, bot, edit_summary, tags) 159 | 160 | def update_entity_labels(self, entity_type, entity_id, data, old_data, 161 | bot=False, edit_summary=None, tags=[]): 162 | return self._patch(f"/entities/{entity_type}/{entity_id}/labels", 163 | data, old_data, bot, edit_summary, tags) 164 | 165 | def update_entity_descriptions(self, entity_type, entity_id, data, old_data, 166 | bot=False, edit_summary=None, tags=[]): 167 | return self._patch(f"/entities/{entity_type}/{entity_id}/descriptions", 168 | data, old_data, bot, edit_summary, tags) 169 | 170 | def update_entity_aliases(self, entity_type, entity_id, data, old_data, 171 | bot=False, edit_summary=None, tags=[]): 172 | return self._patch(f"/entities/{entity_type}/{entity_id}/aliases", 173 | data, old_data, bot, edit_summary, tags) 174 | 175 | def update_entity_statement(self, entity_type, entity_id, statement_id, data, old_data, 176 | bot=False, edit_summary=None, tags=[]): 177 | return self._patch(f"/entities/{entity_type}/{entity_id}/statements/{statement_id}", 178 | data, old_data, bot, edit_summary, tags) 179 | 180 | 181 | # POST 182 | def add_item(self, data, bot=False, edit_summary=None, tags=[]): 183 | return self._post(f"/entities/items", 184 | "item", data, bot, edit_summary, tags) 185 | 186 | def add_entity_label(self, entity_type, entity_id, data, 187 | bot=False, edit_summary=None, tags=[]): 188 | return self._post(f"/entities/{entity_type}/{entity_id}/labels", 189 | "label", data, bot, edit_summary, tags) 190 | 191 | def add_entity_description(self, entity_type, entity_id, data, 192 | bot=False, edit_summary=None, tags=[]): 193 | return self._post(f"/entities/{entity_type}/{entity_id}/descriptions", 194 | "description", data, bot, edit_summary, tags) 195 | 196 | def add_entity_aliases(self, entity_type, entity_id, data, 197 | bot=False, edit_summary=None, tags=[]): 198 | return self._post(f"/entities/{entity_type}/{entity_id}/aliases", 199 | "aliases", data, bot, edit_summary, tags) 200 | 201 | def add_entity_statement(self, entity_type, entity_id, data, 202 | bot=False, edit_summary=None, tags=[]): 203 | return self._post(f"/entities/{entity_type}/{entity_id}/statements", 204 | "statement", data, bot, edit_summary, tags) 205 | 206 | 207 | # PUT 208 | def replace_statement(self, statement_id, data, 209 | bot=False, edit_summary=None, tags=[]): 210 | return self._put(f"/statements/{statement_id}", 211 | "statement", data, bot, edit_summary, tags) 212 | 213 | def replace_entity_label(self, entity_type, entity_id, language_code, data, 214 | bot=False, edit_summary=None, tags=[]): 215 | return self._put(f"/entities/{entity_type}/{entity_id}/labels/{language_code}", 216 | "label", data, bot, edit_summary, tags) 217 | 218 | def replace_entity_description(self, entity_type, entity_id, language_code, data, 219 | bot=False, edit_summary=None, tags=[]): 220 | return self._put(f"/entities/{entity_type}/{entity_id}/descriptions/{language_code}", 221 | "description", data, bot, edit_summary, tags) 222 | 223 | def replace_entity_aliases(self, entity_type, entity_id, language_code, data, 224 | bot=False, edit_summary=None, tags=[]): 225 | return self._put(f"/entities/{entity_type}/{entity_id}/aliases/{language_code}", 226 | "aliases", data, bot, edit_summary, tags) 227 | 228 | def replace_entity_statement(self, entity_type, entity_id, statement_id, data, 229 | bot=False, edit_summary=None, tags=[]): 230 | return self._put(f"/entities/{entity_type}/{entity_id}/statements/{statement_id}", 231 | "statement", data, bot, edit_summary, tags) 232 | 233 | 234 | # DELETE 235 | def delete_statement(self, statement_id, 236 | bot=False, edit_summary=None, tags=[]): 237 | return self._delete(f"/statements/{statement_id}", 238 | bot, edit_summary, tags) 239 | 240 | def delete_entity(self, entity_type, entity_id, 241 | bot=False, edit_summary=None, tags=[]): 242 | return self._delete(f"/entities/{entity_type}/{entity_id}", 243 | bot, edit_summary, tags) 244 | 245 | def delete_entity_label(self, entity_type, entity_id, language_code, 246 | bot=False, edit_summary=None, tags=[]): 247 | return self._delete(f"/entities/{entity_type}/{entity_id}/labels/{language_code}", 248 | bot, edit_summary, tags) 249 | 250 | def delete_entity_description(self, entity_type, entity_id, language_code, 251 | bot=False, edit_summary=None, tags=[]): 252 | return self._delete(f"/entities/{entity_type}/{entity_id}/descriptions/{language_code}", 253 | bot, edit_summary, tags) 254 | 255 | def delete_entity_aliases(self, entity_type, entity_id, language_code, 256 | bot=False, edit_summary=None, tags=[]): 257 | return self._delete(f"/entities/{entity_type}/{entity_id}/aliases/{language_code}", 258 | bot, edit_summary, tags) 259 | 260 | def delete_entity_statement(self, entity_type, entity_id, statement_id, 261 | bot=False, edit_summary=None, tags=[]): 262 | return self._delete(f"/entities/{entity_type}/{entity_id}/statements/{statement_id}", 263 | bot, edit_summary, tags) 264 | 265 | 266 | # Convenience functions 267 | def get_item(self, item_id): 268 | return self.get_entity("items", item_id) 269 | 270 | def get_property(self, property_id): 271 | return self.get_entity("properties", property_id) 272 | 273 | def get_item_labels(self, item_id): 274 | return self.get_entity_labels("items", item_id) 275 | 276 | def get_property_labels(self, property_id): 277 | return self.get_entity_labels("properties", property_id) 278 | 279 | def get_item_label(self, item_id, language_code): 280 | return self.get_entity_label("items", item_id, language_code) 281 | 282 | def get_property_label(self, property_id, language_code): 283 | return self.get_entity_label("properties", property_id, language_code) 284 | 285 | def get_item_descriptions(self, item_id): 286 | return self.get_entity_descriptions("items", item_id) 287 | 288 | def get_property_descriptions(self, property_id): 289 | return self.get_entity_descriptions("properties", property_id) 290 | 291 | def get_item_description(self, item_id, language_code): 292 | return self.get_entity_description("items", item_id, language_code) 293 | 294 | def get_property_description(self, property_id, language_code): 295 | return self.get_entity_description("properties", property_id, language_code) 296 | 297 | def get_item_aliases(self, item_id): 298 | return self.get_entity_aliases("items", item_id) 299 | 300 | def get_property_aliases(self, property_id): 301 | return self.get_entity_aliases("properties", property_id) 302 | 303 | def get_item_aliases_in_language(self, item_id, language_code): 304 | return self.get_entity_aliases_in_language("items", item_id, language_code) 305 | 306 | def get_property_aliases_in_language(self, property_id, language_code): 307 | return self.get_entity_aliases_in_language("properties", property_id, language_code) 308 | 309 | def get_item_statements(self, item_id): 310 | return self.get_entity_statements("items", item_id) 311 | 312 | def get_property_statements(self, property_id): 313 | return self.get_entity_statements("properties", property_id) 314 | 315 | def get_item_statement(self, item_id, statement_id): 316 | return self.get_entity_statement("items", item_id, statement_id) 317 | 318 | def get_property_statement(self, property_id, statement_id): 319 | return self.get_entity_statement("properties", property_id, statement_id) 320 | 321 | def update_item(self, item_id, data, old_data, bot=False, edit_summary=None, tags=[]): 322 | return self.update_entity("items", item_id, data, old_data, bot, edit_summary, tags) 323 | 324 | def update_property(self, property_id, data, old_data, bot=False, edit_summary=None, tags=[]): 325 | return self.update_entity("properties", property_id, data, old_data, bot, edit_summary, tags) 326 | 327 | def update_item_labels(self, item_id, data, old_data, bot=False, edit_summary=None, tags=[]): 328 | return self.update_entity_labels("items", item_id, data, old_data, bot, edit_summary, tags) 329 | 330 | def update_property_labels(self, property_id, data, old_data, bot=False, edit_summary=None, tags=[]): 331 | return self.update_entity_labels("properties", property_id, data, old_data, bot, edit_summary, tags) 332 | 333 | def update_item_descriptions(self, item_id, data, old_data, bot=False, edit_summary=None, tags=[]): 334 | return self.update_entity_descriptions("items", item_id, data, old_data, bot, edit_summary, tags) 335 | 336 | def update_property_descriptions(self, property_id, data, old_data, bot=False, edit_summary=None, tags=[]): 337 | return self.update_entity_descriptions("properties", item_id, data, old_data, bot, edit_summary, tags) 338 | 339 | def update_item_aliases(self, item_id, data, old_data, bot=False, edit_summary=None, tags=[]): 340 | return self.update_entity_aliases("items", item_id, data, old_data, bot, edit_summary, tags) 341 | 342 | def update_property_aliases(self, property_id, data, old_data, bot=False, edit_summary=None, tags=[]): 343 | return self.update_entity_aliases("properties", property_id, data, old_data, bot, edit_summary, tags) 344 | 345 | def update_item_statement(self, item_id, statement_id, data, old_data, bot=False, edit_summary=None, tags=[]): 346 | return self.update_entity_statement("items", item_id, statement_id, data, old_data, bot, edit_summary, tags) 347 | 348 | def update_property_statement(self, property_id, statement_id, data, old_data, bot=False, edit_summary=None, tags=[]): 349 | return self.update_entity_statement("properties", property_id, statement_id, data, old_data, bot, edit_summary, tags) 350 | 351 | def add_item_label(self, item_id, data, bot=False, edit_summary=None, tags=[]): 352 | return self.add_entity_label("items", item_id, data, bot, edit_summary, tags) 353 | 354 | def add_property_label(self, property_id, data, bot=False, edit_summary=None, tags=[]): 355 | return self.add_entity_label("properties", item_id, data, bot, edit_summary, tags) 356 | 357 | def add_item_description(self, item_id, data, bot=False, edit_summary=None, tags=[]): 358 | return self.add_entity_description("items", item_id, data, bot, edit_summary, tags) 359 | 360 | def add_property_description(self, property_id, data, bot=False, edit_summary=None, tags=[]): 361 | return self.add_entity_description("properties", property_id, data, bot, edit_summary, tags) 362 | 363 | def add_item_aliases(self, item_id, data, bot=False, edit_summary=None, tags=[]): 364 | return self.add_entity_aliases("items", item_id, data, bot, edit_summary, tags) 365 | 366 | def add_property_aliases(self, property_id, data, bot=False, edit_summary=None, tags=[]): 367 | return self.add_entity_aliases("properties", property_id, data, bot, edit_summary, tags) 368 | 369 | def add_item_statement(self, item_id, data, bot=False, edit_summary=None, tags=[]): 370 | return self.add_entity_statement("items", item_id, data, bot, edit_summary, tags) 371 | 372 | def add_property_statement(self, property_id, data, bot=False, edit_summary=None, tags=[]): 373 | return self.add_entity_statement("properties", property_id, data, bot, edit_summary, tags) 374 | 375 | def replace_item_label(self, item_id, language_code, data, bot=False, edit_summary=None, tags=[]): 376 | return self.replace_entity_label("items", item_id, language_code, data, bot, edit_summary, tags) 377 | 378 | def replace_property_label(self, property_id, language_code, data, bot=False, edit_summary=None, tags=[]): 379 | return self.replace_entity_label("properties", property_id, language_code, data, bot, edit_summary, tags) 380 | 381 | def replace_item_description(self, item_id, language_code, data, bot=False, edit_summary=None, tags=[]): 382 | return self.replace_entity_description("items", item_id, language_code, data, bot, edit_summary, tags) 383 | 384 | def replace_property_description(self, property_id, language_code, data, bot=False, edit_summary=None, tags=[]): 385 | return self.replace_entity_description("properties", property_id, language_code, data, bot, edit_summary, tags) 386 | 387 | def replace_item_aliases(self, item_id, language_code, data, bot=False, edit_summary=None, tags=[]): 388 | return self.replace_entity_aliases("items", item_id, language_code, data, bot, edit_summary, tags) 389 | 390 | def replace_property_aliases(self, property_id, language_code, data, bot=False, edit_summary=None, tags=[]): 391 | return self.replace_entity_aliases("properties", property_id, language_code, data, bot, edit_summary, tags) 392 | 393 | def replace_item_statement(self, item_id, statement_id, data, bot=False, edit_summary=None, tags=[]): 394 | return self.replace_entity_statement("items", item_id, statement_id, data, bot, edit_summary, tags) 395 | 396 | def replace_property_statement(self, property_id, statement_id, data, bot=False, edit_summary=None, tags=[]): 397 | return self.replace_entity_statement("properties", property_id, statement_id, data, bot, edit_summary, tags) 398 | 399 | def delete_item(self, item_id, bot=False, edit_summary=None, tags=[]): 400 | return self.delete_entity("items", item_id, bot, edit_summary, tags) 401 | 402 | def delete_property(self, property_id, bot=False, edit_summary=None, tags=[]): 403 | return self.delete_entity("properties", property_id, bot, edit_summary, tags) 404 | 405 | def delete_item_label(self, item_id, language_code, bot=False, edit_summary=None, tags=[]): 406 | return self.delete_entity_label("items", item_id, language_code, bot, edit_summary, tags) 407 | 408 | def delete_property_label(self, property_id, language_code, bot=False, edit_summary=None, tags=[]): 409 | return self.delete_entity_label("properties", property_id, language_code, bot, edit_summary, tags) 410 | 411 | def delete_item_description(self, item_id, language_code, bot=False, edit_summary=None, tags=[]): 412 | return self.delete_entity_description("items", item_id, language_code, bot, edit_summary, tags) 413 | 414 | def delete_property_description(self, property_id, language_code, bot=False, edit_summary=None, tags=[]): 415 | return self.delete_entity_description("properties", property_id, language_code, bot, edit_summary, tags) 416 | 417 | def delete_item_statement(self, item_id, statement_id, bot=False, edit_summary=None, tags=[]): 418 | return self.delete_entity_statement("items", item_id, statement_id, bot, edit_summary, tags) 419 | 420 | def delete_property_statement(self, property_id, statement_id, bot=False, edit_summary=None, tags=[]): 421 | return self.delete_entity_statement("properties", property_id, statement_id, bot, edit_summary, tags) 422 | 423 | def delete_item_aliases(self, item_id, language_code, bot=False, edit_summary=None, tags=[]): 424 | return self.delete_entity_aliases("items", item_id, language_code, bot, edit_summary, tags) 425 | 426 | def delete_property_aliases(self, property_id, language_code, bot=False, edit_summary=None, tags=[]): 427 | return self.delete_entity_aliases("properties", property_id, language_code, bot, edit_summary, tags) 428 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------