Merge branch 'release/v0.6.0'

Author: sebalix

.travis.yml

@@ -6,6 +6,7 @@ python:
   - "3.3"
   - "3.4"
   - "3.5"
+  - "3.6"
   - "pypy"
 
 env:
@@ -35,4 +36,4 @@ install:
 
 script:
   - python -m unittest discover -v
-  - if [[ $TRAVIS_PYTHON_VERSION != 3.2 ]]; then PYTHONPATH=.:$PYTHONPATH sphinx-build -b doctest -d doc/build/doctrees doc/source build/doctest; fi
+  - if [[ "$TRAVIS_PYTHON_VERSION" != "3.2" && "$TRAVIS_PYTHON_VERSION" != "3.3" ]]; then PYTHONPATH=.:$PYTHONPATH sphinx-build -b doctest -d doc/build/doctrees doc/source build/doctest; fi

CHANGELOG

@@ -1,3 +1,9 @@
+0.6.0
+=====
+- IMP: Adds support for passing a custom URL opener
+  (e.g. to handle HTTP basic authentication)
+- IMP: Support added for Python 3.6
+
 0.5.1
 =====
 - FIX: Session file loading, read the `timeout` value as a float

README.rst

@@ -79,7 +79,7 @@ It should work on next versions if `Odoo` keeps a stable API.
 Supported Python versions
 -------------------------
 
-`OdooRPC` support Python 2.7, 3.2, 3.3, 3.4 and 3.5.
+`OdooRPC` support Python 2.7, 3.2, 3.3, 3.4, 3.5 and 3.6.
 
 License
 -------

doc/source/index.rst

@@ -85,7 +85,7 @@ It should work on next versions if `Odoo` keeps a stable API.
 Supported Python versions
 -------------------------
 
-`OdooRPC` support Python 2.7, 3.2, 3.3, 3.4 and 3.5.
+`OdooRPC` support Python 2.7, 3.2, 3.3, 3.4, 3.5 and 3.6.
 
 License
 -------

odoorpc/__init__.py

@@ -28,7 +28,7 @@
 __author__ = 'ABF Osiell - Sebastien Alix'
 __email__ = '[email protected]'
 __licence__ = 'LGPL v3'
-__version__ = '0.5.1'
+__version__ = '0.6.0'
 
 __all__ = ['ODOO', 'error']
 

odoorpc/odoo.py

@@ -48,6 +48,20 @@ class ODOO(object):
 
         >>> odoo = odoorpc.ODOO('localhost', version='10.0')
 
+    You can also define a custom URL opener to handle HTTP requests. A use
+    case is to manage a basic HTTP authentication in front of `Odoo`:
+
+    .. doctest::
+        :options: +SKIP
+
+        >>> import urllib.request
+        >>> import odoorpc
+        >>> pwd_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()
+        >>> pwd_mgr.add_password(None, "http://example.net", "userName", "passWord")
+        >>> auth_handler = urllib.request.HTTPBasicAuthHandler(pwd_mgr)
+        >>> opener = urllib.request.build_opener(auth_handler)
+        >>> odoo = odoorpc.ODOO('example.net', port=80, opener=opener)
+
     *Python 2:*
 
     :raise: :class:`odoorpc.error.InternalError`
@@ -62,7 +76,7 @@ class ODOO(object):
     """
 
     def __init__(self, host='localhost', protocol='jsonrpc',
-                 port=8069, timeout=120, version=None):
+                 port=8069, timeout=120, version=None, opener=None):
         if protocol not in ['jsonrpc', 'jsonrpc+ssl']:
             txt = ("The protocol '{0}' is not supported by the ODOO class. "
                    "Please choose a protocol among these ones: {1}")
@@ -88,7 +102,7 @@ def __init__(self, host='localhost', protocol='jsonrpc',
         # Instanciate the server connector
         try:
             self._connector = rpc.PROTOCOLS[protocol](
-                self._host, self._port, timeout, version)
+                self._host, self._port, timeout, version, opener=opener)
         except rpc.error.ConnectorError as exc:
             raise error.InternalError(exc.message)
         # Dictionary of configuration options

odoorpc/rpc/__init__.py

@@ -183,14 +183,16 @@ class ConnectorJSONRPC(Connector):
         True
     """
     def __init__(self, host, port=8069, timeout=120, version=None,
-                 deserialize=True):
+                 deserialize=True, opener=None):
         super(ConnectorJSONRPC, self).__init__(host, port, timeout, version)
         self.deserialize = deserialize
         # One URL opener (with cookies handling) shared between
         # JSON and HTTP requests
-        cookie_jar = CookieJar()
-        self._opener = build_opener(
-            HTTPCookieProcessor(cookie_jar))
+        if opener is None:
+            cookie_jar = CookieJar()
+            opener = build_opener(
+                HTTPCookieProcessor(cookie_jar))
+        self._opener = opener
         self._proxy_json, self._proxy_http = self._get_proxies()
 
     def _get_proxies(self):
@@ -250,8 +252,9 @@ class ConnectorJSONRPCSSL(ConnectorJSONRPC):
         ...     cnt = rpc.ConnectorJSONRPCSSL(HOST, port=PORT)
     """
     def __init__(self, host, port=8069, timeout=120, version=None,
-                 deserialize=True):
-        super(ConnectorJSONRPCSSL, self).__init__(host, port, timeout, version)
+                 deserialize=True, opener=None):
+        super(ConnectorJSONRPCSSL, self).__init__(
+            host, port, timeout, version, opener=opener)
         self._proxy_json, self._proxy_http = self._get_proxies()
 
     @property

odoorpc/tests/test_init.py

@@ -3,10 +3,11 @@
 import sys
 # Python 2
 if sys.version_info.major < 3:
-    from urllib2 import URLError
+    from urllib2 import BaseHandler, URLError, build_opener
 # Python >= 3
 else:
     from urllib.error import URLError
+    from urllib.request import BaseHandler, build_opener
 
 from odoorpc.tests import BaseTestCase
 import odoorpc
@@ -35,6 +36,17 @@ def test_init2(self):
         self.assertEqual(odoo.port, self.env['port'])
         self.assertEqual(odoo.config['timeout'], 42)
 
+    def test_init_opener(self):
+        # Opener
+        opener = build_opener(BaseHandler)
+        odoo = odoorpc.ODOO(
+            self.env['host'], self.env['protocol'], self.env['port'],
+            opener=opener)
+        connector = odoo._connector
+        self.assertIs(connector._opener, opener)
+        self.assertIs(connector._proxy_http._opener, opener)
+        self.assertIs(connector._proxy_json._opener, opener)
+
     def test_init_timeout_none(self):
         odoo = odoorpc.ODOO(
             self.env['host'], self.env['protocol'], self.env['port'], None)

setup.py

@@ -4,7 +4,7 @@
 from distutils.core import setup
 
 name = 'OdooRPC'
-version = '0.5.1'
+version = '0.6.0'
 description = ("OdooRPC is a Python module providing an easy way to "
                "pilot your Odoo servers through RPC.")
 keywords = ("openerp odoo server rpc client xml-rpc xmlrpc jsonrpc json-rpc "
@@ -63,10 +63,12 @@
           "Programming Language :: Python :: 3.3",
           "Programming Language :: Python :: 3.4",
           "Programming Language :: Python :: 3.5",
+          "Programming Language :: Python :: 3.6",
           "Programming Language :: Python :: Implementation :: CPython",
           "Programming Language :: Python :: Implementation :: PyPy",
           "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
           "Topic :: Software Development :: Libraries :: Python Modules",
+          "Framework :: Odoo",
       ],
       )