odoo-client-lib 1.2.4__py3-none-any.whl

odoo_client_lib-1.2.4.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: odoo-client-lib
+Version: 1.2.4
+Summary: Odoo Client Library allows to easily interact with Odoo in Python.
+Home-page: 
+Author: Nicolas Vanhoren
+Author-email: 
+License: BSD
+Keywords: odoo library com communication rpc xml-rpc net-rpc xmlrpc python client lib web service
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Requires-Dist: requests
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+See the home page for any information: https://github.com/odoo/odoo-client-lib .

odoo_client_lib-1.2.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+odoolib/__init__.py,sha256=MPs3zGu069RR57C79EAVD78Zc-XZ9jTNsajaDJb4aBA,1688
+odoolib/dates.py,sha256=E5arcSE32h-dHxvDN5ikmmOlqNJNnaRLOjvdrbT7Cr4,3613
+odoolib/main.py,sha256=CYvjIs6C1vRPz6Vx29sY818gNEF35JrxZ5Y5C4sX1Do,15341
+odoo_client_lib-1.2.4.dist-info/METADATA,sha256=748HguXUMcCuXs5IwaU6lyhjM159EUIk7Hy5M5fYqiM,630
+odoo_client_lib-1.2.4.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+odoo_client_lib-1.2.4.dist-info/top_level.txt,sha256=zJJ0KUA_b-iQPYRzgyH5a4zT9uBNhAVzVxKRuz6UoA8,8
+odoo_client_lib-1.2.4.dist-info/RECORD,,

odoo_client_lib-1.2.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (79.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

odoo_client_lib-1.2.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+odoolib

odoolib/__init__.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (C) Stephane Wirtel
+# Copyright (C) 2011 Nicolas Vanhoren
+# Copyright (C) 2011 OpenERP s.a. (<http://openerp.com>)
+# Copyright (C) 2018 Odoo s.a. (<http://odoo.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: 
+# 
+# 1. Redistributions of source code must retain the above copyright notice, this
+# 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. 
+# 
+# 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
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# 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.
+# 
+##############################################################################
+
+from .main import *

odoolib/dates.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (C) Stephane Wirtel
+# Copyright (C) 2011 Nicolas Vanhoren
+# Copyright (C) 2011 OpenERP s.a. (<http://openerp.com>)
+# Copyright (C) 2018 Odoo s.a. (<http://odoo.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: 
+# 
+# 1. Redistributions of source code must retain the above copyright notice, this
+# 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. 
+# 
+# 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
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# 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.
+# 
+##############################################################################
+
+import datetime
+
+DEFAULT_SERVER_DATE_FORMAT = "%Y-%m-%d"
+DEFAULT_SERVER_TIME_FORMAT = "%H:%M:%S"
+DEFAULT_SERVER_DATETIME_FORMAT = "%s %s" % (
+    DEFAULT_SERVER_DATE_FORMAT,
+    DEFAULT_SERVER_TIME_FORMAT)
+
+def str_to_datetime(str):
+    """
+    Converts a string to a datetime object using Odoo's
+    datetime string format (exemple: '2011-12-01 15:12:35').
+    
+    No timezone information is added, the datetime is a naive instance, but
+    according to Odoo 9.0 specification the timezone is always UTC.
+    """
+    if not str:
+        return str
+    return datetime.datetime.strptime(str.split(".")[0], DEFAULT_SERVER_DATETIME_FORMAT)
+
+def str_to_date(str):
+    """
+    Converts a string to a date object using Odoo's
+    date string format (exemple: '2011-12-01').
+    """
+    if not str:
+        return str
+    return datetime.datetime.strptime(str, DEFAULT_SERVER_DATE_FORMAT).date()
+
+def str_to_time(str):
+    """
+    Converts a string to a time object using Odoo's
+    time string format (exemple: '15:12:35').
+    """
+    if not str:
+        return str
+    return datetime.datetime.strptime(str.split(".")[0], DEFAULT_SERVER_TIME_FORMAT).time()
+
+def datetime_to_str(obj):
+    """
+    Converts a datetime object to a string using Odoo's
+    datetime string format (exemple: '2011-12-01 15:12:35').
+    
+    The datetime instance should not have an attached timezone and be in UTC.
+    """
+    if not obj:
+        return False
+    return obj.strftime(DEFAULT_SERVER_DATETIME_FORMAT)
+
+def date_to_str(obj):
+    """
+    Converts a date object to a string using Odoo's
+    date string format (exemple: '2011-12-01').
+    """
+    if not obj:
+        return False
+    return obj.strftime(DEFAULT_SERVER_DATE_FORMAT)
+
+def time_to_str(obj):
+    """
+    Converts a time object to a string using Odoo's
+    time string format (exemple: '15:12:35').
+    """
+    if not obj:
+        return False
+    return obj.strftime(DEFAULT_SERVER_TIME_FORMAT)

odoolib/main.py

@@ -0,0 +1,387 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (C) Stephane Wirtel
+# Copyright (C) 2011 Nicolas Vanhoren
+# Copyright (C) 2011 OpenERP s.a. (<http://openerp.com>)
+# Copyright (C) 2018 Odoo s.a. (<http://odoo.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: 
+# 
+# 1. Redistributions of source code must retain the above copyright notice, this
+# 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. 
+# 
+# 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
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# 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.
+# 
+##############################################################################
+
+"""
+Odoo Client Library
+
+Home page: http://pypi.python.org/pypi/odoo-client-lib
+Code repository: https://github.com/odoo/odoo-client-lib
+"""
+
+import sys
+import requests
+if sys.version_info >= (3, 0, 0):
+    from xmlrpc.client import ServerProxy
+else:
+    from xmlrpclib import ServerProxy
+import logging
+import json
+import random
+
+_logger = logging.getLogger(__name__)
+
+def _getChildLogger(logger, subname):
+    return logging.getLogger(logger.name + "." + subname)
+
+class Connector(object):
+    """
+    The base abstract class representing a connection to an Odoo Server.
+    """
+
+    __logger = _getChildLogger(_logger, 'connector')
+
+    def get_service(self, service_name):
+        """
+        Returns a Service instance to allow easy manipulation of one of the services offered by the remote server.
+
+        :param service_name: The name of the service.
+        """
+        return Service(self, service_name)
+
+class XmlRPCConnector(Connector):
+    """
+    A type of connector that uses the XMLRPC protocol.
+    """
+    PROTOCOL = 'xmlrpc'
+    
+    __logger = _getChildLogger(_logger, 'connector.xmlrpc')
+
+    def __init__(self, hostname, port=8069):
+        """
+        Initialize by specifying the hostname and the port.
+        :param hostname: The hostname of the computer holding the instance of Odoo.
+        :param port: The port used by the Odoo instance for XMLRPC (default to 8069).
+        """
+        self.url = 'http://%s:%d/xmlrpc' % (hostname, port)
+
+    def send(self, service_name, method, *args):
+        url = '%s/%s' % (self.url, service_name)
+        service = ServerProxy(url)
+        return getattr(service, method)(*args)
+
+class XmlRPCSConnector(XmlRPCConnector):
+    """
+    A type of connector that uses the secured XMLRPC protocol.
+    """
+    PROTOCOL = 'xmlrpcs'
+
+    __logger = _getChildLogger(_logger, 'connector.xmlrpcs')
+
+    def __init__(self, hostname, port=8069):
+        super(XmlRPCSConnector, self).__init__(hostname, port)
+        self.url = 'https://%s:%d/xmlrpc' % (hostname, port)
+
+class JsonRPCException(Exception):
+    def __init__(self, error):
+         self.error = error
+    def __str__(self):
+         return repr(self.error)
+
+def json_rpc(url, fct_name, params):
+    data = {
+        "jsonrpc": "2.0",
+        "method": fct_name,
+        "params": params,
+        "id": random.randint(0, 1000000000),
+    }
+    result_req = requests.post(url, data=json.dumps(data), headers={
+        "Content-Type":"application/json",
+    })
+    result = result_req.json()
+    if result.get("error", None):
+        raise JsonRPCException(result["error"])
+    return result.get("result", False)
+
+class JsonRPCConnector(Connector):
+    """
+    A type of connector that uses the JsonRPC protocol.
+    """
+    PROTOCOL = 'jsonrpc'
+    
+    __logger = _getChildLogger(_logger, 'connector.jsonrpc')
+
+    def __init__(self, hostname, port=8069):
+        """
+        Initialize by specifying the hostname and the port.
+        :param hostname: The hostname of the computer holding the instance of Odoo.
+        :param port: The port used by the Odoo instance for JsonRPC (default to 8069).
+        """
+        self.url = 'http://%s:%d/jsonrpc' % (hostname, port)
+
+    def send(self, service_name, method, *args):
+        return json_rpc(self.url, "call", {"service": service_name, "method": method, "args": args})
+
+class JsonRPCSConnector(Connector):
+    """
+    A type of connector that uses the JsonRPC protocol.
+    """
+    PROTOCOL = 'jsonrpcs'
+    
+    __logger = _getChildLogger(_logger, 'connector.jsonrpc')
+
+    def __init__(self, hostname, port=8069):
+        """
+        Initialize by specifying the hostname and the port.
+        :param hostname: The hostname of the computer holding the instance of Odoo.
+        :param port: The port used by the Odoo instance for JsonRPC (default to 8069).
+        """
+        self.url = 'https://%s:%d/jsonrpc' % (hostname, port)
+
+    def send(self, service_name, method, *args):
+        return json_rpc(self.url, "call", {"service": service_name, "method": method, "args": args})
+
+class Service(object):
+    """
+    A class to execute RPC calls on a specific service of the remote server.
+    """
+    def __init__(self, connector, service_name):
+        """
+        :param connector: A valid Connector instance.
+        :param service_name: The name of the service on the remote server.
+        """
+        self.connector = connector
+        self.service_name = service_name
+        self.__logger = _getChildLogger(_getChildLogger(_logger, 'service'),service_name or "")
+        
+    def __getattr__(self, method):
+        """
+        :param method: The name of the method to execute on the service.
+        """
+        self.__logger.debug('method: %r', method)
+        def proxy(*args):
+            """
+            :param args: A list of values for the method
+            """
+            self.__logger.debug('args: %r', args)
+            result = self.connector.send(self.service_name, method, *args)
+            self.__logger.debug('result: %r', result)
+            return result
+        return proxy
+
+class Connection(object):
+    """
+    A class to represent a connection with authentication to an Odoo Server.
+    It also provides utility methods to interact with the server more easily.
+    """
+    __logger = _getChildLogger(_logger, 'connection')
+
+    def __init__(self, connector,
+                 database=None,
+                 login=None,
+                 password=None,
+                 user_id=None):
+        """
+        Initialize with login information. The login information is facultative to allow specifying
+        it after the initialization of this object.
+
+        :param connector: A valid Connector instance to send messages to the remote server.
+        :param database: The name of the database to work on.
+        :param login: The login of the user.
+        :param password: The password of the user.
+        :param user_id: The user id is a number identifying the user. This is only useful if you
+        already know it, in most cases you don't need to specify it.
+        """
+        self.connector = connector
+
+        self.set_login_info(database, login, password, user_id)
+        self.user_context = None
+
+    def set_login_info(self, database, login, password, user_id=None):
+        """
+        Set login information after the initialisation of this object.
+
+        :param connector: A valid Connector instance to send messages to the remote server.
+        :param database: The name of the database to work on.
+        :param login: The login of the user.
+        :param password: The password of the user.
+        :param user_id: The user id is a number identifying the user. This is only useful if you
+        already know it, in most cases you don't need to specify it.
+        """
+        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
+        authentication fails.
+
+        :param force: Force to re-check even if this Connection was already validated previously.
+        Default to True.
+        """
+        if self.user_id and not force:
+            return
+        
+        if not self.database or not self.login or self.password is None:
+            raise AuthenticationError("Credentials not provided")
+
+        # TODO use authenticate instead of login
+        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_user_context(self):
+        """
+        Query the default context of the user.
+        """
+        if not self.user_context:
+            self.user_context = self.get_model('res.users').context_get()
+        return self.user_context
+    
+    def get_model(self, model_name):
+        """
+        Returns a Model instance to allow easy remote manipulation of an Odoo model.
+
+        :param model_name: The name of the model.
+        """
+        return Model(self, model_name)
+
+    def get_service(self, service_name):
+        """
+        Returns a Service instance to allow easy manipulation of one of the services offered by the remote server.
+        Please note this Connection instance does not need to have valid authentication information since authentication
+        is only necessary for the "object" service that handles models.
+
+        :param service_name: The name of the service.
+        """
+        return self.connector.get_service(service_name)
+
+class AuthenticationError(Exception):
+    """
+    An error thrown when an authentication to an Odoo server failed.
+    """
+    pass
+
+class Model(object):
+    """
+    Useful class to dialog with one of the models provided by an Odoo server.
+    An instance of this class depends on a Connection instance with valid authentication information.
+    """
+
+    def __init__(self, connection, model_name):
+        """
+        :param connection: A valid Connection instance with correct authentication information.
+        :param model_name: The name of the model.
+        """
+        self.connection = connection
+        self.model_name = model_name
+        self.__logger = _getChildLogger(_getChildLogger(_logger, 'object'), model_name or "")
+
+    def __getattr__(self, method):
+        """
+        Provides proxy methods that will forward calls to the model on the remote Odoo server.
+
+        :param method: The method for the linked model (search, read, write, unlink, create, ...)
+        """
+        def proxy(*args, **kw):
+            """
+            :param args: A list of values for the method
+            """
+            self.connection.check_login(False)
+            self.__logger.debug(args)
+            result = self.connection.get_service('object').execute_kw(
+                                                    self.connection.database,
+                                                    self.connection.user_id,
+                                                    self.connection.password,
+                                                    self.model_name,
+                                                    method,
+                                                    args, kw)
+            if method == "read":
+                if isinstance(result, list) and len(result) > 0 and "id" in result[0]:
+                    index = {}
+                    for r in result:
+                        index[r['id']] = r
+                    if isinstance(args[0], list):
+                        result = [index[x] for x in args[0] if x in index]
+                    elif args[0] in index:
+                        result = index[args[0]]
+                    else:
+                        result = False
+            self.__logger.debug('result: %r', result)
+            return result
+        return proxy
+
+    def search_read(self, domain=None, fields=None, offset=0, limit=None, order=None, context=None):
+        """
+        A shortcut method to combine a search() and a read().
+
+        :param domain: The domain for the search.
+        :param fields: The fields to extract (can be None or [] to extract all fields).
+        :param offset: The offset for the rows to read.
+        :param limit: The maximum number of rows to read.
+        :param order: The order to class the rows.
+        :param context: The context.
+        :return: A list of dictionaries containing all the specified fields.
+        """
+        record_ids = self.search(domain or [], offset, limit or False, order or False, context=context or {})
+        if not record_ids: return []
+        records = self.read(record_ids, fields or [], context=context or {})
+        return records
+
+def get_connector(hostname=None, protocol="xmlrpc", port="auto"):
+    """
+    A shortcut method to easily create a connector to a remote server using XMLRPC.
+
+    :param hostname: The hostname to the remote server.
+    :param protocol: The name of the protocol, must be "xmlrpc", "xmlrpcs", "jsonrpc" or "jsonrpcs".
+    :param port: The number of the port. Defaults to auto.
+    """
+    if port == 'auto':
+        port = 8069
+    if protocol == "xmlrpc":
+        return XmlRPCConnector(hostname, port)
+    elif protocol == "xmlrpcs":
+        return XmlRPCSConnector(hostname, port)
+    if protocol == "jsonrpc":
+        return JsonRPCConnector(hostname, port)
+    elif protocol == "jsonrpcs":
+        return JsonRPCSConnector(hostname, port)
+    else:
+        raise ValueError("You must choose xmlrpc, xmlrpcs, jsonrpc or jsonrpcs")
+
+def get_connection(hostname=None, protocol="xmlrpc", port='auto', database=None,
+                 login=None, password=None, user_id=None):
+    """
+    A shortcut method to easily create a connection to a remote Odoo server.
+
+    :param hostname: The hostname to the remote server.
+    :param protocol: The name of the protocol, must be "xmlrpc", "xmlrpcs", "jsonrpc" or "jsonrpcs".
+    :param port: The number of the port. Defaults to auto.
+    :param connector: A valid Connector instance to send messages to the remote server.
+    :param database: The name of the database to work on.
+    :param login: The login of the user.
+    :param password: The password of the user.
+    :param user_id: The user id is a number identifying the user. This is only useful if you
+    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)
+