Added support for alternate API endpoint #127

Author: siznax

tests/test_basic.py

@@ -637,6 +637,19 @@ def test_query_init_wiki(self):
         self.assertEqual(qobj.domain, 'example.com')
         self.assertEqual(qobj.uri, 'http://example.com')
 
+    def test_query_init_endpoint(self):
+        qobj = wptools.query.WPToolsQuery(endpoint='ENDPOINT')
+        self.assertEqual(qobj.endpoint, 'ENDPOINT')
+        self.assertEqual(qobj.uri, 'https://en.wikipedia.org')
+        self.assertTrue('.orgENDPOINT?' in qobj.category('CAT'))
+        self.assertTrue('.orgENDPOINT?' in qobj.labels(['QID']))
+        self.assertTrue('.orgENDPOINT?' in qobj.imageinfo(['FILE']))
+        self.assertTrue('.orgENDPOINT?' in qobj.parse('TITLE'))
+        self.assertTrue('.orgENDPOINT?' in qobj.query('TITLE'))
+        self.assertTrue('.orgENDPOINT?' in qobj.querymore('TITLE'))
+        self.assertTrue('.orgENDPOINT?' in qobj.site('siteinfo'))
+        self.assertTrue('.orgENDPOINT?' in qobj.wikidata('TITLE'))
+
     def test_query_init_lang(self):
         qobj = wptools.query.WPToolsQuery(lang='zz')
         self.assertEqual(qobj.lang, 'zz')

wptools/category.py

@@ -25,6 +25,7 @@ def __init__(self, *args, **kwargs):
         - [title]: <str> category title
 
         Optional keyword {params}:
+        - [endpoint]: <str> alternative API endpoint (default=/w/api.php)
         - [lang]: <str> Mediawiki language code (default=en)
         - [namespace]: <int> filter members (0=article, 14=category)
         - [pageid]: <int> category pageid
@@ -41,6 +42,7 @@ def __init__(self, *args, **kwargs):
         """
         super(WPToolsCategory, self).__init__(**kwargs)
 
+        endpoint = kwargs.get('endpoint')
         pageid = kwargs.get('pageid')
         namespace = kwargs.get('namespace')
 
@@ -49,6 +51,9 @@ def __init__(self, *args, **kwargs):
             title = args[0]
             self.params.update({'title': title})
 
+        if endpoint:
+            self.params.update({'endpoint': endpoint})
+
         if pageid:
             try:
                 self.params.update({'pageid': int(pageid)})

wptools/core.py

@@ -168,7 +168,8 @@ def _get(self, action, show, proxy, timeout):
         # make the request
         qobj = WPToolsQuery(lang=self.params['lang'],
                             variant=self.params.get('variant'),
-                            wiki=self.params.get('wiki'))
+                            wiki=self.params.get('wiki'),
+                            endpoint=self.params.get('endpoint'))
         qstr = self._query(action, qobj)
         req = self._request(proxy, timeout)
         response = req.get(qstr, qobj.status)

wptools/page.py

@@ -44,6 +44,7 @@ def __init__(self, *args, **kwargs):
 
         Optional keyword {params}:
         - [boxterm]: <str> Infobox title name or substring
+        - [endpoint]: <str> alternative API endpoint (default=/w/api.php)
         - [lang]: <str> Mediawiki language code (default=en)
         - [pageid]: <int> Mediawiki pageid
         - [variant]: <str> Mediawiki language variant
@@ -63,6 +64,10 @@ def __init__(self, *args, **kwargs):
         if boxterm:
             self.params.update({'boxterm': boxterm})
 
+        endpoint = kwargs.get('endpoint')
+        if endpoint:
+            self.params.update({'endpoint': endpoint})
+
         pageid = kwargs.get('pageid')
         if pageid:
             self.params.update({'pageid': pageid})

wptools/query.py

@@ -30,25 +30,26 @@ class WPToolsQuery(object):
     WPToolsQuery class
     """
 
+    DEFAULT_ENDPOINT = '/w/api.php'
     MAXWIDTH = 72
     RPAD = 4
 
     IMAGEINFO = Template((
-        "${WIKI}/w/api.php?action=query"
+        "${WIKI}${ENDPOINT}?action=query"
         "&format=json"
         "&formatversion=2"
         "&iiprop=size|url|timestamp|extmetadata"
         "&prop=imageinfo"
         "&titles=${FILES}"))
 
     LIST = Template((
-        "${WIKI}/w/api.php?action=query"
+        "${WIKI}${ENDPOINT}?action=query"
         "&format=json"
         "&formatversion=2"
         "&list=${LIST}"))
 
     PARSE = Template((
-        "${WIKI}/w/api.php?action=parse"
+        "${WIKI}${ENDPOINT}?action=parse"
         "&format=json"
         "&formatversion=2"
         "&contentmodel=text"
@@ -60,7 +61,7 @@ class WPToolsQuery(object):
         "&page=${PAGE}"))
 
     QUERY = Template((
-        "${WIKI}/w/api.php?action=query"
+        "${WIKI}${ENDPOINT}?action=query"
         "&exintro"
         "&format=json"
         "&formatversion=2"
@@ -78,7 +79,7 @@ class WPToolsQuery(object):
         "&titles=${TITLES}"))
 
     QUERYMORE = Template((
-        "${WIKI}/w/api.php?action=query"
+        "${WIKI}${ENDPOINT}?action=query"
         "&bllimit=500"
         "&bltitle=${TITLES}"
         "&cllimit=500"
@@ -94,39 +95,45 @@ class WPToolsQuery(object):
         "&titles=${TITLES}"))
 
     WIKIDATA = Template((
-        "${WIKI}/w/api.php?action=wbgetentities"
+        "${WIKI}${ENDPOINT}?action=wbgetentities"
         "&format=json"
         "&formatversion=2"
         "&languages=${LANG}"
         "&props=${PROPS}"
         "&redirects=yes"))
 
+    endpoint = None
     lang = None
     status = None
     variant = None
     wiki = None
 
-    def __init__(self, lang='en', variant=None, wiki=None):
+    def __init__(self, lang='en', variant=None, wiki=None, endpoint=None):
         """
         Returns a WPToolsQuery object
 
         Arguments:
         - [lang=en]: <str> Mediawiki language code
         - [variant=None]: <str> language variant
         - [wiki=None]: <str> alternative wiki site
+        - [endpoint=None]: <str> alternative API endoint
         """
         self.lang = lang
         self.variant = variant
 
         self.wiki = wiki or "%s.wikipedia.org" % self.lang
         self.domain = domain_name(self.wiki)
+        self.endpoint = endpoint or self.DEFAULT_ENDPOINT
         self.uri = self.wiki_uri(self.wiki)
 
     def category(self, title, pageid=None, cparams=None, namespace=None):
         """
         Returns category query string
         """
-        query = self.LIST.substitute(WIKI=self.uri, LIST='categorymembers')
+        query = self.LIST.substitute(
+            WIKI=self.uri,
+            ENDPOINT=self.endpoint,
+            LIST='categorymembers')
         status = pageid or title
 
         query += "&cmlimit=500"
@@ -163,6 +170,7 @@ def labels(self, qids):
 
         query = self.WIKIDATA.substitute(
             WIKI=self.uri,
+            ENDPOINT=self.endpoint,
             LANG=self.variant or self.lang,
             PROPS='labels')
 
@@ -181,14 +189,19 @@ def imageinfo(self, files):
 
         self.set_status('imageinfo', files)
 
-        return self.IMAGEINFO.substitute(WIKI=self.uri, FILES=files)
+        return self.IMAGEINFO.substitute(
+            WIKI=self.uri,
+            ENDPOINT=self.endpoint,
+            FILES=files)
 
     def parse(self, title, pageid=None):
         """
         Returns Mediawiki action=parse query string
         """
-        qry = self.PARSE.substitute(WIKI=self.uri,
-                                    PAGE=safequote(title) or pageid)
+        qry = self.PARSE.substitute(
+            WIKI=self.uri,
+            ENDPOINT=self.endpoint,
+            PAGE=safequote(title) or pageid)
 
         if pageid and not title:
             qry = qry.replace('&page=', '&pageid=').replace('&redirects', '')
@@ -204,8 +217,10 @@ def query(self, titles, pageids=None):
         """
         Returns MediaWiki action=query query string
         """
-        query = self.QUERY.substitute(WIKI=self.uri,
-                                      TITLES=safequote(titles) or pageids)
+        query = self.QUERY.substitute(
+            WIKI=self.uri,
+            ENDPOINT=self.endpoint,
+            TITLES=safequote(titles) or pageids)
         status = titles or pageids
 
         if pageids and not titles:
@@ -225,6 +240,7 @@ def querymore(self, titles, pageids=None, cparams=None):
         """
         query = self.QUERYMORE.substitute(
             WIKI=self.uri,
+            ENDPOINT=self.endpoint,
             TITLES=safequote(titles) or pageids)
 
         status = "%s" % (pageids or titles)
@@ -247,7 +263,10 @@ def random(self, namespace=0):
         """
         Returns query string for random page
         """
-        query = self.LIST.substitute(WIKI=self.uri, LIST='random')
+        query = self.LIST.substitute(
+            WIKI=self.uri,
+            ENDPOINT=self.endpoint,
+            LIST='random')
         query += "&rnlimit=1&rnnamespace=%d" % namespace
 
         emoji = [
@@ -309,28 +328,31 @@ def site(self, action):
         """
         query = None
         viewdays = 7
+        hostpath = self.uri + self.endpoint
 
         if action == 'siteinfo':
-            query = self.uri + ('/w/api.php?action=query'
-                                '&meta=siteinfo|siteviews'
-                                '&siprop=general|statistics'
-                                '&list=mostviewed&pvimlimit=max')
+            query = hostpath + (
+                '?action=query'
+                '&meta=siteinfo|siteviews'
+                '&siprop=general|statistics'
+                '&list=mostviewed&pvimlimit=max')
             query += '&pvisdays=%d' % viewdays  # meta=siteviews
             self.set_status('query', 'siteinfo|siteviews|mostviewed')
         elif action == 'sitematrix':
-            query = self.uri + '/w/api.php?action=sitematrix'
+            query = hostpath + '?action=sitematrix'
             self.set_status('sitematrix', 'all')
         elif action == 'sitevisitors':
-            query = self.uri + ('/w/api.php?action=query'
-                                '&meta=siteviews&pvismetric=uniques')
+            query = hostpath + (
+                '?action=query'
+                '&meta=siteviews&pvismetric=uniques')
             query += '&pvisdays=%d' % viewdays  # meta=siteviews
             self.set_status('query', 'siteviews:uniques')
 
-        query += '&format=json&formatversion=2'
-
         if not query:
             raise ValueError("Could not form query")
 
+        query += '&format=json&formatversion=2'
+
         return query
 
     def wiki_uri(self, wiki):
@@ -350,6 +372,7 @@ def wikidata(self, title, wikibase=None):
 
         query = self.WIKIDATA.substitute(
             WIKI=self.uri,
+            ENDPOINT=self.endpoint,
             LANG=self.variant or self.lang,
             PROPS="aliases|info|claims|descriptions|labels|sitelinks")
 

wptools/site.py

@@ -26,6 +26,7 @@ def __init__(self, *args, **kwargs):
         Returns a WPToolsSite object.
 
         Optional keyword {params}:
+        - [endpoint]: <str> alternative API endpoint (default=/w/api.php)
         - [lang]: <str> Mediawiki language code (default=en)
         - [wiki]: <str> alternative wiki site (default=wikipedia.org)
 
@@ -36,6 +37,10 @@ def __init__(self, *args, **kwargs):
         """
         super(WPToolsSite, self).__init__(*args, **kwargs)
 
+        endpoint = kwargs.get('endpoint')
+        if endpoint:
+            self.params.update({'endpoint': endpoint})
+
     def _query(self, action, qobj):
         """
         returns query string