Change and remove FunctionsEngine functions (#129)

* Update delete_statement BREAKING CHANGES Change parameters order revision is now optional Add summary parameter * Update delete_item BREAKING CHANGE Change parameter order reason is now optional * Update wbi_core.py Move format force to json to mediawiki_api_call() Add Exception if format is not json * Update wbi_core.py Remove FunctionsEngine.get_linked_by() and FunctionsEngine.delete_item() WikibaseIntegrator will only support wikibase-oriented functions. * Update wbi_core.py Move _sparql_query_result_to_df() to the end of FunctionsEngine * Rename functions * Rename delete_statements to remove_claims * Rename get_search_results to search_entities * Update wbi_core.py * Remove dataframe support Use sparqldataframe instead * Corretly remove dataframe support * Bump to v0.11.0.dev0 Support python 3.10 * Split wbi_core into exceptions and functions * Update wbi_functions.py Sync with master branch * Add 3.10 to Code Compatibility Inspection * For to Python 3.10.0-alpha.7 Because beta1 from Github actions is bogus * Add MediaWiki API Call example in README.md * Bogus version has been removed * I tried * Typo in comments * Update README.md
LeMyst · May 9, 2021 · c2c77ad · c2c77ad
1 parent 434856e
commit c2c77ad
Show file tree

Hide file tree

Showing 12 changed files with 547 additions and 597 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -4,16 +4,14 @@ on:
   push:
     branches: [ master ]
   pull_request:
-    branches: '**'
+    branches: [ '**' ]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.7', '3.8', '3.9' ]
-        # Add this when Numpy add support to Python 3.10
-        # python-version: [ '3.7', '3.8', '3.9', '3.10-dev' ]
+        python-version: [ '3.7', '3.8', '3.9', '3.10-dev' ]
 
     steps:
       - uses: actions/checkout@v2

diff --git a/.idea/inspectionProfiles/WikibaseIntegrator.xml b/.idea/inspectionProfiles/WikibaseIntegrator.xml
diff --git a/README.md b/README.md
@@ -12,7 +12,8 @@
 - [Using a Wikibase instance](#using-a-wikibase-instance)
 - [The Core Parts](#the-core-parts)
     - [wbi_core.ItemEngine](#wbi_coreitemengine)
-    - [wbi_core.FunctionsEngine](#wbi_corefunctionsengine)
+    - [wbi_functions](#wbi_functions)
+        - [Use MediaWiki API](#use-mediawiki-api)
     - [wbi_login.Login](#wbi_loginlogin)
         - [Login using OAuth1 or OAuth2](#login-using-oauth1-or-oauth2)
         - [Login with a username and a password](#login-with-a-username-and-a-password)
@@ -119,18 +120,37 @@ There are two ways of working with Wikibase items:
 * A user can work with a selected QID to specifically modify the data on the item. This requires that the user knows
   what he/she is doing and should only be used with great care, as this does not perform consistency checks.
 
-Examples below illustrate the usage of ItemEngine.
+## wbi_functions ##
 
-## wbi_core.FunctionsEngine ##
-
-wbi_core.FunctionsEngine provides a set of static functions to request or manipulate data from MediaWiki API or SPARQL
-Service.
+wbi_functions provides a set of static functions to request or manipulate data from MediaWiki API or SPARQL Service.
 
 Features:
 
 * Minimize the number of HTTP requests for reads and writes to improve performance
 * Method to easily execute [SPARQL](https://query.wikidata.org) queries on the Wikibase SPARQL endpoint.
 
+### Use MediaWiki API ###
+
+WikibaseIntegrator don't have functions to make API call to non-wikibase actions. You can
+use `wbi_functions.mediawiki_api_call_helper()` to make a custom call.
+
+Example to get the last two revisions of entity Q42 :
+
+```python
+from wikibaseintegrator import wbi_functions
+
+data = {
+    'action': 'query',
+    'prop': 'revisions',
+    'titles': 'Q42',
+    'rvlimit': 2,
+    'rvprop': 'ids|timestamp|comment|user',
+    'rvslots': 'main'
+}
+
+print(wbi_functions.mediawiki_api_call_helper(data, allow_anonymous=True))
+```
+
 ## wbi_login.Login ##
 
 ### Login using OAuth1 or OAuth2 ###
@@ -242,8 +262,8 @@ address, or the URL to your bot code repository.)
 
 ## Use Mediawiki API ##
 
-The method `wbi_core.FunctionsEngine.mediawiki_api_call_helper()` allows you to execute MediaWiki API POST call. It
-takes a mandatory data array (data) and multiple optionals parameters like a login object of type wbi_login.Login, a
+The method `wbi_functions.mediawiki_api_call_helper()` allows you to execute MediaWiki API POST call. It takes a
+mandatory data array (data) and multiple optionals parameters like a login object of type wbi_login.Login, a
 mediawiki_api_url string if the Mediawiki is not Wikidata, a user_agent string to set a custom HTTP User Agent header,
 and an allow_anonymous boolean to force authentication.
 
@@ -252,7 +272,7 @@ Example:
 Retrieve last 10 revisions from Wikidata element Q2 (Earth):
 
 ```python
-from wikibaseintegrator import wbi_core
+from wikibaseintegrator import wbi_functions
 
 query = {
     'action': 'query',
@@ -261,12 +281,12 @@ query = {
     'rvlimit': 10
 }
 
-print(wbi_core.FunctionsEngine.mediawiki_api_call_helper(query, allow_anonymous=True))
+print(wbi_functions.mediawiki_api_call_helper(query, allow_anonymous=True))
 ```
 
 ## Wikibase search entities ##
 
-The method `wbi_core.ItemEngine.get_search_results()` allows for string search in a Wikibase instance. This means that
+The method `wbi_core.ItemEngine.search_entities()` allows for string search in a Wikibase instance. This means that
 labels, descriptions and aliases can be searched for a string of interest. The method takes five arguments: The actual
 search string (search_string), an optional server (mediawiki_api_url, in case the Wikibase instance used is not
 Wikidata), an optional user_agent, an optional max_results (default 500), an optional language (default 'en'), and an
@@ -275,7 +295,7 @@ option dict_id_label to return a dict of item id and label as a result.
 ## Merge Wikibase items ##
 
 Sometimes, Wikibase items need to be merged. An API call exists for that, and wbi_core implements a method accordingly.
-`wbi_core.FunctionsEngine.merge_items()` takes five arguments:
+`wbi_functions.merge_items()` takes five arguments:
 the QID of the item which should be merged into another item (from_id), the QID of the item the first item should be
 merged into (to_id), a login object of type wbi_login.Login to provide the API call with the required authentication
 information, a server (mediawiki_api_url) if the Wikibase instance is not Wikidata and a flag for ignoring merge

diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,5 @@
 simplejson~=3.17.2
 requests~=2.25.1
-pandas~=1.2.4
 mwoauth~=0.3.7
 backoff~=1.10.0
 pytest~=6.2.4

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = wikibaseintegrator
-version = 0.10.2.dev0
+version = 0.11.0.dev0
 author = Myst and WikidataIntegrator authors
 license = MIT
 license_files = LICENSE.txt
@@ -17,6 +17,7 @@ classifiers =
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
     Development Status :: 4 - Beta
     Operating System :: POSIX
     Operating System :: MacOS :: MacOS X
@@ -32,7 +33,6 @@ packages = wikibaseintegrator
 install_requires =
     simplejson
     requests
-    pandas
     mwoauth
     backoff
     oauthlib

diff --git a/test/test_all.py b/test/test_all.py
@@ -4,7 +4,7 @@
 
 import requests
 
-from wikibaseintegrator import wbi_core, wbi_fastrun
+from wikibaseintegrator import wbi_core, wbi_fastrun, wbi_functions
 from wikibaseintegrator.wbi_core import MWApiError
 
 __author__ = 'Sebastian Burgstaller-Muehlbacher'
@@ -14,13 +14,13 @@
 class TestMediawikiApiCall(unittest.TestCase):
     def test_all(self):
         with self.assertRaises(MWApiError):
-            wbi_core.FunctionsEngine.mediawiki_api_call_helper(data={'format': 'json', 'action': 'wbgetentities', 'ids': 'Q42'}, mediawiki_api_url="https://www.wikidataaaaaaa.org",
-                                                               max_retries=3, retry_after=1, allow_anonymous=True)
+            wbi_functions.mediawiki_api_call_helper(data={'format': 'json', 'action': 'wbgetentities', 'ids': 'Q42'}, mediawiki_api_url="https://www.wikidataaaaaaa.org",
+                                                    max_retries=3, retry_after=1, allow_anonymous=True)
         with self.assertRaises(requests.HTTPError):
-            wbi_core.FunctionsEngine.mediawiki_api_call_helper(data=None, mediawiki_api_url="https://httpbin.org/status/400", max_retries=3, retry_after=1, allow_anonymous=True)
+            wbi_functions.mediawiki_api_call_helper(data=None, mediawiki_api_url="https://httpbin.org/status/400", max_retries=3, retry_after=1, allow_anonymous=True)
 
-        test = wbi_core.FunctionsEngine.mediawiki_api_call_helper(data={'format': 'json', 'action': 'wbgetentities', 'ids': 'Q42'}, max_retries=3, retry_after=1,
-                                                                  allow_anonymous=True)
+        test = wbi_functions.mediawiki_api_call_helper(data={'format': 'json', 'action': 'wbgetentities', 'ids': 'Q42'}, max_retries=3, retry_after=1,
+                                                       allow_anonymous=True)
         print(test)
 
 

diff --git a/test/test_wbi_core.py b/test/test_wbi_core.py
@@ -1,6 +1,6 @@
 import unittest
 
-from wikibaseintegrator import wbi_core
+from wikibaseintegrator import wbi_core, wbi_functions
 
 
 class TestWbiCore(unittest.TestCase):
@@ -105,14 +105,14 @@ def test_label(self):
         assert item.get_aliases('ak') == ['c']
 
     def test_wd_search(self):
-        t = wbi_core.FunctionsEngine.get_search_results('rivaroxaban')
+        t = wbi_functions.search_entities('rivaroxaban')
         print('Number of results: ', len(t))
         self.assertIsNot(len(t), 0)
 
     def test_item_generator(self):
         items = ['Q408883', 'P715', 'Q18046452']
 
-        item_instances = wbi_core.FunctionsEngine.generate_item_instances(items=items)
+        item_instances = wbi_functions.generate_item_instances(items=items)
 
         for qid, item in item_instances:
             self.assertIn(qid, items)
@@ -181,6 +181,3 @@ def test_get_reference_properties(self):
     def test_get_qualifier_properties(self):
         print(self.common_item.get_qualifier_properties(prop_id='P170'))
         self.assertTrue(len(self.common_item.get_qualifier_properties(prop_id='P2067')))
-
-    def test_get_linked_by(self):
-        self.assertTrue(len(wbi_core.FunctionsEngine.get_linked_by('Q2')))
diff --git a/test/test_wbi_login.py b/test/test_wbi_login.py
@@ -5,7 +5,7 @@
 
 import pytest
 
-from wikibaseintegrator import wbi_login, wbi_core
+from wikibaseintegrator import wbi_login, wbi_functions
 
 # look for environment variables. if none set, don't do anything
 WDUSER = os.getenv("WDUSER")
@@ -23,4 +23,4 @@ def test_write():
     if WDUSER and WDPASS:
         login = wbi_login.Login(WDUSER, WDPASS)
         with pytest.raises(ValueError):
-            wbi_core.FunctionsEngine.mediawiki_api_call_helper(data=None, login=login, mediawiki_api_url='https://unsdfdskfjljzkerezr.org/w/api.php')
+            wbi_functions.mediawiki_api_call_helper(data=None, login=login, mediawiki_api_url='https://unsdfdskfjljzkerezr.org/w/api.php')