kynan / dokuwikixmlrpc Goto Github PK

View Code? Open in Web Editor NEW

27.0 7.0 13.0 56 KB

Python module for the DokuWiki XML-RPC backend

License: MIT License

Python 100.00%

xmlrpc xml-rpc dokuwiki python

dokuwikixmlrpc's Introduction

https://img.shields.io/pypi/dm/dokuwikixmlrpc

https://img.shields.io/pypi/v/dokuwikixmlrpc

https://img.shields.io/pypi/pyversions/dokuwikixmlrpc

https://img.shields.io/pypi/format/dokuwikixmlrpc

https://img.shields.io/pypi/l/dokuwikixmlrpc

https://img.shields.io/github/stars/kynan/dokuwikixmlrpc?style=social

https://img.shields.io/github/forks/kynan/dokuwikixmlrpc?style=social

dokuwikixmlrpc is a python module which implements DokuWiki's XML-RPC interface.

Installation:

pip install dokuwikixmlrpc

It can be used to send/retrieve data from remote DokuWiki instances:

import dokuwikixmlrpc
dw = DokuWikiClient('https://mywikiurl.com', 'wikiuser', 'wikipassword')
print(dw.dokuwiki_version)
print(dw.pagelist(':'))

The module can be executed as a standalone script (this is mainly for testing purposes). Call

python -m dokuwikixmlrpc --help

for more information.

See LICENSE.txt for license info.

dokuwikixmlrpc's People

Contributors

Stargazers

Watchers

Forkers

yvesf michitux bbsteam bclibcoop kaie dubwoc bert eyjhb oschwab aluriak ezrider ocastrup chang-zhao

dokuwikixmlrpc's Issues

Python 3 support

The Python 3 standard library has been somewhat restructured.

Basic auth case doesn't add the script path.

This looks wrong to me:

    if not self._http_basic_auth:
        url = ''.join([self._url, script, '?',
                       urlencode({'u': self._user, 'p': self._passwd})])
    else:
        proto, url = self._url.split('://')
        url = proto + '://' + self._user + ':' + self._passwd + '@' + url

In the "not" basic auth case the script path is added to the base url, while in the "use" basic auth case it is not (and, hence, the base url need to include the full script path).

Relicense as MIT

I have approval from @chimeric to relicense under a more liberal MIT license. Any objections @foosel @kaie @yvesf @meteopascal?

Bug: 401 Unauthorized when using python 3.9

Let me use that simple code:

from dokuwikixmlrpc import DokuWikiClient
client = DokuWikiClient('https://wiki.example.net', 'remote-enabled-user', 'password')
print(client.page('home'))

With Python 3.7, i get the content of the home page, as expected. I recently updated my OS, and got python 3.9, on two different machines, i now got this stacktrace:

Traceback (most recent call last):
  File "/home/user/project/venv/lib/python3.9/site-packages/dokuwikixmlrpc.py", line 115, in catch_xmlerror
    return f(*args, **kwargs)
  File "/home/user/project/venv/lib/python3.9/site-packages/dokuwikixmlrpc.py", line 199, in page
    return self._xmlrpc.wiki.getPage(page_id)
  File "/usr/lib/python3.9/xmlrpc/client.py", line 1116, in __call__
    return self.__send(self.__name, args)
  File "/usr/lib/python3.9/xmlrpc/client.py", line 1456, in __request
    response = self.__transport.request(
  File "/usr/lib/python3.9/xmlrpc/client.py", line 1160, in request
    return self.single_request(host, handler, request_body, verbose)
  File "/usr/lib/python3.9/xmlrpc/client.py", line 1190, in single_request
    raise ProtocolError(
xmlrpc.client.ProtocolError: <ProtocolError for wiki.example.net/lib/exe/xmlrpc.php: 401 Unauthorized>

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/user/project/showbug.py", line 12, in <module>
    print(client.page('home'))
  File "/home/user/project/venv/lib/python3.9/site-packages/dokuwikixmlrpc.py", line 119, in catch_xmlerror
    raise DokuWikiXMLRPCProtocolError(fault)
dokuwikixmlrpc.DokuWikiXMLRPCProtocolError: <DokuWikiXMLRPCProtocolError 401: 'Unauthorized' at wiki.example.net/lib/exe/xmlrpc.php>

Is there any chance python 3.9 changes something that makes the XML RPC protocol fail in any way ?
The only thing, apart new bugs in CPython itself, i can imagine right now is the new operators on dict, the new string methods, or some little details.

I tried running the code with -X oldparser to use the LL(1) parser (as 3.9 introduce the PEG one), but that didn't changed anything.

Please add parameters to getPagelist

Requesting dw.pagelist(':') gives all the pages, maybe many thousands. Users may be interested in limiting the depth of search:

dw.pagelist(':', {'depth': 1})

but that gives

TypeError: DokuWikiClient.pagelist() takes 2 positional arguments but 3 were given

It's reasonable to add the second parameter here:

    def pagelist(self, namespace):
        """Lists all pages within a given namespace."""
        return self._xmlrpc.dokuwiki.getPagelist(namespace, {})

Kind of

    def pagelist(self, namespace, opts = {'depth': 0, 'hash': False, 'skipacl': False}):
        """Lists all pages within a given namespace."""
        return self._xmlrpc.dokuwiki.getPagelist(namespace, opts)

should send an moer specific execption when receiving 'XML-RPC server not enabled.' from the server

Hello,

This will be way more readable than:

Traceback (most recent call last):
  File "script.py", line 1, in <module>
    from dokuwikixmlrpc import DokuWikiClient; DokuWikiClient("http://wiki.cerkinfo.be", "Bram", "p0ulet0478")
  File "/home/psycojoker/code/python/dokuwikixmlrpc/dokuwikixmlrpc.py", line 113, in __init__
    self.dokuwiki_version = self._dokuwiki_version()
  File "/home/psycojoker/code/python/dokuwikixmlrpc/dokuwikixmlrpc.py", line 145, in _dokuwiki_version
    return self._xmlrpc.dokuwiki.getVersion()
  File "/usr/lib/python2.7/xmlrpclib.py", line 1224, in __call__
    return self.__send(self.__name, args)
  File "/usr/lib/python2.7/xmlrpclib.py", line 1578, in __request
    verbose=self.__verbose
  File "/usr/lib/python2.7/xmlrpclib.py", line 1264, in request
    return self.single_request(host, handler, request_body, verbose)
  File "/usr/lib/python2.7/xmlrpclib.py", line 1297, in single_request
    return self.parse_response(response)
  File "/usr/lib/python2.7/xmlrpclib.py", line 1467, in parse_response
    p.feed(data)
  File "/usr/lib/python2.7/xmlrpclib.py", line 557, in feed
    self._parser.Parse(data, 0)
xml.parsers.expat.ExpatError: syntax error: line 1, column 0

Which doesn't inform in any manner of the actual error.

kynan / dokuwikixmlrpc Goto Github PK

dokuwikixmlrpc's Introduction

dokuwikixmlrpc's People

Contributors

Stargazers

Watchers

Forkers

dokuwikixmlrpc's Issues

Python 3 support

Basic auth case doesn't add the script path.

Relicense as MIT

Bug: 401 Unauthorized when using python 3.9

Please add parameters to getPagelist

should send an moer specific execption when receiving 'XML-RPC server not enabled.' from the server

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent