Merge lp:~toolpart/openerp-client-lib/default_context into lp:openerp-client-lib

[ViktorNagy]

Backward compatible addition of context support.

[Nicolas Vanhoren (OpenERP) (niv-openerp)]

Hello,

You can't implicitly add a context to each method call, for these reasons:

- A lot of methods have optional arguments before the context, if those arguments are not provided the context will be inserted at the wrong place.
- There are some methods in the openerp server and addons where the context is not the last argument (this should be changed in openerp 6.2).

So, I agree this functionality would be a good thing, but it's not technically possible right now.

[Nicolas Vanhoren (OpenERP) (niv-openerp)]

review: Disapprove

[Nicolas Vanhoren (OpenERP) (niv-openerp)]

... but in the next version of the client lib I plan to implement that functionality, because we modified the openerp server to make it possible to implement.

It will only be usable using a OpenERP server v 6.1

Unmerged revisions

31. By ViktorNagy on 2011-09-25

Added default_context argument to Connection.
Added set_context method to connection
Added set_user_lang method to connection. This sets the default_context to include the user's language settings.

Added add_context argument to Model.__init__ (by default equals True). If True, then the Connection's default context is added to every request of the proxy.
Modified the proxy method to check for self.add_context, and add the connection's context if necessary.

=== modified file 'openerplib/main.py'
--- openerplib/main.py	2011-09-22 15:45:57 +0000
+++ openerplib/main.py	2011-09-25 10:35:24 +0000
@@ -5,16 +5,16 @@
 # Copyright (C) 2011 Nicolas Vanhoren
 # Copyright (C) 2011 OpenERP s.a. (<http://openerp.com>).
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met: 
-# 
+# modification, are permitted provided that the following conditions are met:
+#
 # 1. Redistributions of source code must retain the above copyright notice, this
-# list of conditions and the following disclaimer. 
+# list of conditions and the following disclaimer.
 # 2. Redistributions in binary form must reproduce the above copyright notice,
 # this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution. 
-# 
+# and/or other materials provided with the distribution.
+#
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -25,7 +25,7 @@
 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-# 
+#
 ##############################################################################
 
 """
@@ -36,7 +36,7 @@
 """
 
 import xmlrpclib
-import logging 
+import logging
 import socket
 
 try:
@@ -75,7 +75,7 @@
     A type of connector that uses the XMLRPC protocol.
     """
     PROTOCOL = 'xmlrpc'
-    
+
     __logger = _getChildLogger(_logger, 'connector.xmlrpc')
 
     def __init__(self, hostname, port=8069):
@@ -171,7 +171,7 @@
     """
 
     PROTOCOL = 'netrpc'
-    
+
     __logger = _getChildLogger(_logger, 'connector.netrpc')
 
     def __init__(self, hostname, port=8070):
@@ -202,7 +202,7 @@
         self.connector = connector
         self.service_name = service_name
         self.__logger = _getChildLogger(_getChildLogger(_logger, 'service'),service_name)
-        
+
     def __getattr__(self, method):
         """
         :param method: The name of the method to execute on the service.
@@ -224,6 +224,7 @@
     It also provides utility methods to interact with the server more easily.
     """
     __logger = _getChildLogger(_logger, 'connection')
+    default_context = {}
 
     def __init__(self, connector,
                  database=None,
@@ -259,7 +260,7 @@
         self.database, self.login, self.password = database, login, password
 
         self.user_id = user_id
-        
+
     def check_login(self, force=True):
         """
         Checks that the login information is valid. Throws an AuthenticationError if the
@@ -270,15 +271,15 @@
         """
         if self.user_id and not force:
             return
-        
+
         if not self.database or not self.login or self.password is None:
             raise AuthenticationError("Creditentials not provided")
-        
+
         self.user_id = self.get_service("common").login(self.database, self.login, self.password)
         if not self.user_id:
             raise AuthenticationError("Authentication failure")
         self.__logger.debug("Authenticated with user id %s", self.user_id)
-    
+
     def get_model(self, model_name):
         """
         Returns a Model instance to allow easy remote manipulation of an OpenERP model.
@@ -297,6 +298,21 @@
         """
         return Service(self.connector, service_name)
 
+    def set_user_lang(self):
+        if not self.user_id:
+            self.check_login()
+
+        self.default_context.update({
+            'lang': self.get_model('res.users').read(self.user_id,
+                ['context_lang'])['context_lang'],
+        })
+
+    def set_context(self, context, reset=False):
+        if reset:
+            self.default_context = context
+        else:
+            self.default_context.update(context)
+
 class AuthenticationError(Exception):
     """
     An error thrown when an authentication to an OpenERP server failed.
@@ -309,11 +325,13 @@
     An instance of this class depends on a Connection instance with valid authentication information.
     """
 
-    def __init__(self, connection, model_name):
+    def __init__(self, connection, model_name, add_context=True):
         """
         :param connection: A valid Connection instance with correct authentication information.
         :param model_name: The name of the model.
+        :param add_context: Automatically adds the connection's default context to requests
         """
+        self.add_default_context = add_context
         self.connection = connection
         self.model_name = model_name
         self.__logger = _getChildLogger(_getChildLogger(_logger, 'object'), model_name)
@@ -328,6 +346,8 @@
             """
             :param args: A list of values for the method
             """
+            if self.add_default_context:
+                args = args + (self.connection.default_context,)
             self.connection.check_login(False)
             self.__logger.debug(args)
             result = self.connection.get_service('object').execute(
@@ -396,4 +416,4 @@
     already know it, in most cases you don't need to specify it.
     """
     return Connection(get_connector(hostname, protocol, port), database, login, password, user_id)
-        
+