openerp_proxy Package

core Module

This module provides some classes to simplify access to Odoo server via xmlrpc.

Example ussage of this module

>>> cl = Client('', 'dbname', 'some_user', 'mypassword')
>>> sale_obj = cl['sale_order']
>>> sale_ids =[('state','not in',['done','cancel'])])
>>> sale_data =, ['name'])
>>> for order in sale_data:
...     print("%5s :    %s" % (order['id'],order['name']))
>>> product_tmpl_obj = cl['product.template']
>>> product_obj = cl['product.product']
>>> tmpl_ids =[('name','ilike','template_name')])
>>> print([('product_tmpl_id','in',tmpl_ids)]))

>>> db = Client('', 'dbname='db0', user='your_user')
>>> so = db['sale.order']
>>> order_ids =[('state','=','done')])
>>> order =[0])

Also You can call any method (beside private ones starting with underscore(_)) of any model. For example following code allows to check availability of stock moves:

>>> db = session.connect()
>>> move_obj = db['stock.move']
>>> move_ids = [1234] # IDs of stock moves to be checked
>>> move_obj.check_assign(move_ids)

Ability to use Record class as analog to browse_record:

>>> move_obj = db['stock.move']
>>> move = move_obj.browse(1234)
>>> move.state
... 'confirmed'
>>> move.check_assign()
>>> move.refresh()
>>> move.state
... 'assigned'
>>> move.picking_id
... R('stock.picking', 12)['OUT-12']
... 12
... 'OUT-12'
>>> move.picking_id_.state
... 'assigned'
class openerp_proxy.core.Client(host, dbname=None, user=None, pwd=None, port=8069, protocol='xml-rpc', **extra_args)[source]

Bases: extend_me.Extensible

A simple class to connect to Odoo instance via RPC (XML-RPC, JSON-RPC) Should be initialized with following arguments:

  • host (str) – server host name to connect to
  • dbname (str) – name of database to connect to
  • user (str) – username to login as
  • pwd (str) – password to log-in with
  • port (int) – port number of server
  • protocol (str) – protocol used to connect. To get list of available protcols call: openerp_proxy.connection.get_connector_names()

any other keyword arguments will be directly passed to connector


>>> db = Client('host', 'dbname', 'user', pwd = 'Password')
>>> cl = Client('host')
>>> db2 = cl.login('dbname', 'user', 'password')

Allows access to Odoo objects / models via dictionary syntax:

>>> db['sale.order']
    Object ('sale.order')

Clean client related caches


Connects to the server

if any keyword arguments will be passed, new Proxy instnace will be created using folowing algorithm: get init args from self instance and update them with passed keyword arguments, and call Proxy class constructor passing result as arguments.

Note, that if You pass any keyword arguments, You also should pass ‘pwd’ keyword argument with user password

Returns:Id of user logged in or new Client instance (if kwargs passed)
Return type:int|Client
Raises:LoginException – if wrong login or password

Connection to server.

Return type:openerp_proxy.connection.connection.ConnectorBase

Name of database to connect to

execute(obj, method, *args, **kwargs)[source]

Call method method on object obj passing all next positional and keyword (if available on server) arguments to remote method

Note that passing keyword argments not available on OpenERp/Odoo server 6.0 and older

  • obj (string) – object name to call method for
  • method (string) – name of method to call

result of RPC method call

execute_wkf(object_name, signal, object_id)[source]

Triggers workflow event on specified object

  • object_name (string) – send workflow signal for
  • signal (string) – name of signal to send
  • object_id – ID of document (record) to send signal to

Returns dictionary with init arguments which can be safely passed to class constructor


Returns wraper around Odoo object ‘object_name’ which is instance of orm.object.Object class

Parameters:object_name – name of an object to get wraper for
Returns:instance of Object which wraps choosen object
Return type:openerp_proxy.orm.object.Object

Returns dabase URL

At this moment mostly used internaly in session


Server host

login(dbname, user, password)[source]

Login to database

Return new Client instance. (Just an aliase on connect method)

  • dbname (str) – name of database to connect to
  • user (str) – username to login as
  • password (str) – password to log-in with

new Client instance, with specifed credentials

Return type:



Plugins associated with this Client instance

Return type:openerp_proxy.plugin.PluginManager

Server port


Server protocol


Recreates connection to the server and clears caches

Returns:ID of user logged in
Return type:int
Raises:ClientException – if wrong login or password

List of registered in Odoo database objects

Return type:list

Server version

(Already parsed with pkg_resources.parse_version)


ServiceManager instance, which contains list of all available services for current connection.

Return type:openerp_proxy.service.service.ServiceManager

Usage examples:   # report service   # object service (model related actions)   # used for login
                     # (,
                     #                           username,
                     #                           password)       # database management service
classmethod to_url(inst, **kwargs)[source]

Converts instance to url

Parameters:inst (Client|dict) – instance to convert to init args
Returns:generated URL
Return type:str

Returns ID of current user. if one is None, connects to database and returns it

Return type:int

Currenct logged in user instance

Return type:openerp_proxy.orm.record.Record

Get current user context

Return type:dict

User login used to access DB

session Module

class openerp_proxy.session.Session(data_file='~/.openerp_proxy.json')[source]

Bases: extend_me.Extensible, openerp_proxy.utils.DirMixIn

Simple session manager which allows to manage databases easier This class stores information about databases You used in home directory, and on init it loads history and allows simply connect to database by url or index. No more hosts, usernames, ports, etc... required to be memorized. Just on session start call:

>>> print(session)

And You will get all databases You worked with listed as (index, url) pairs. To connect to one of thouse databases just call session[index|url] and required Client object will be returned.

Parameters:data_file (string) – path to session file

Add db to session.

param db: database (client instance) to be added to session type db: Client instance


Adds extra path to python import path.

Parameters:path (string) – Paths to be added

Note: this way path will be saved in session

aliase(name, val)[source]

Sets up aliase ‘name’ for val

  • name (string) – new aliase
  • val (int|string|Client instance) – database to create aliase for

val could be index, url or Client object:

session.aliase('tdb', 1)
session.aliase('mdb', 'xml-rpc://')
session.aliase('xdb', db)

And now You can use this aliase like:

Returns:unchanged val

List of database aliases

To add new database aliase, use method aliase:

session.aliase('mdb', db)  # db is instance of Client
connect(host=None, dbname=None, user=None, pwd=None, port=8069, protocol='xml-rpc', interactive=True, no_save=False)[source]

Wraper around Client constructor class to simplify connect from shell.

  • host (str) – host name to connect to (will be asked interactvely if not provided)
  • dbname (str) – name of database to connect to (will be asked interactvely if not provided)
  • user (str) – user name to connect as (will be asked interactvely if not provided)
  • pwd (str) – password for selected user (will be asked interactvely if not provided)
  • port (int) – port to connect to. (default: 8069)
  • interactive (bool) – ask for connection parameters if not provided. (default: True)
  • no_save (bool) – if set to True database will not be saved to session

Client object


Returns list of URLs of databases available in current session

Returns:list of urls of databases from session
Return type:list of strings

List of extra pyhton paths, used by this session

get_db(url_or_index, **kwargs)[source]

Returns instance of Client object, that represents single Odoo database it connected to, specified by passed index (integer) or url (string) of database, previously saved in session.

  • url_or_index (int|string) – must be integer (if index) or string (if url). this parametr specifies database to get from session
  • kwargs – can contain aditional arguments to be passed on init of Client

Client instance


ValueError – if cannot find database by specified args


session.get_db(1)   # using index
session.get_db('my_db')   # using aliase

Property which returns dict with {index: url}


Reverse index.

Property which returns dict with {url: index}

option(opt, val=None, default=None)[source]

Get or set option. if val is passed, val will be set as value for option, else just option value will be returned

  • opt (str) – option to get or set value for
  • val – value to be set for option opt

value of option opt

Currently available options:

  • store_passwords (bool) If set to True then all used passwords will be stored on But be careful, because of encription used for stored passwords is very week.

Saves session on disc


List of start-up imports

If You want some module to be automaticaly imported on when session starts, that just add it to this list:


exceptions Module

exception openerp_proxy.exceptions.ClientException[source]

Bases: openerp_proxy.exceptions.Error

Base class for client related exceptions

exception openerp_proxy.exceptions.ConnectorError[source]

Bases: openerp_proxy.exceptions.Error

Base class for exceptions related to connectors

exception openerp_proxy.exceptions.Error[source]

Bases: Exception

Base class for exceptions

exception openerp_proxy.exceptions.LoginException[source]

Bases: openerp_proxy.exceptions.ClientException

This exception should be raised, when operations requires login and password. For example interaction with Odoo object service.

exception openerp_proxy.exceptions.ObjectException[source]

Bases: openerp_proxy.exceptions.ClientException

Base class for exceptions related to Objects

exception openerp_proxy.exceptions.ReportError[source]

Bases: openerp_proxy.exceptions.Error

Error raise in process of report generation

plugin Module

class openerp_proxy.plugin.Plugin(client)[source]

Bases: object

Base class for all plugins, extensible by name

(uses metaclass extend_me.ExtensibleByHashType)

Parameters:client (openerp_proxy.core.Client instance) – instance of Client to bind plugins to

Example of simple plugin:

from openerp_proxy.plugin import Plugin

class AttandanceUtils(Plugin):

    # This is required to register Your plugin
    # *name* - is for db.plugins.<name>
    class Meta:
        name = "attendance"

    def get_sign_state(self):
        # Note: folowing code works on version 6 of Openerp/Odoo
        emp_obj = self.client['hr.employee']
        emp_id =[('user_id', '=', self.client.uid)])
        emp =, ['state'])
        return emp[0]['state']

This plugin will automaticaly register itself in system, when module which contains it will be imported.


Related Client instance

class openerp_proxy.plugin.PluginManager(client)[source]

Bases: extend_me.Extensible, openerp_proxy.utils.DirMixIn

Class that holds information about all plugins

Parameters:client (openerp_proxy.core.Client instance) – instance of Client to bind plugins to

Plugiins will be accessible via index or attribute syntax:

plugins = PluginManager(client)
plugins.Test   # acceps plugin 'Test' as attribute
plugins['Test']  # access plugin 'Test' via indexing

Clean-up plugin cache This will force to reinitialize each plugin when asked


List of names of registered plugins

class openerp_proxy.plugin.TestPlugin(client)[source]

Bases: openerp_proxy.plugin.Plugin

Jusn an example plugin to test if plugin logic works

class Meta[source]

Bases: object

name = 'Test'

utils Module

class openerp_proxy.utils.AttrDict[source]

Bases: dict, openerp_proxy.utils.DirMixIn

Simple class to make dictionary able to use attribute get operation to get elements it contains using syntax like:

>>> d = AttrDict(arg1=1, arg2='hello')
>>> print(d.arg1)
>>> print(d.arg2)
>>> print(d['arg2'])
>>> print(d['arg1'])
class openerp_proxy.utils.DirMixIn[source]

Bases: object

class openerp_proxy.utils.UConverter(hint_encodings=None)[source]

Bases: object

Simple converter to unicode

Create instance with specified list of encodings to be used to try to convert value to unicode


ustr = UConverter(['utf-8', 'cp-1251'])
my_unicode_str = ustr(b'hello - привет')
default_encodings = ['utf-8', 'ascii']
openerp_proxy.utils.wpartial(func, *args, **kwargs)[source]

Wrapped partial, same as functools.partial decorator, but also calls functools.wrap on its result thus shwing correct function name and representation.


os.makedirs wrapper. No errors raised if directory already exists

Parameters:path (str) – directory path to create

Read specified json file

openerp_proxy.utils.json_write(file_path, *args, **kwargs)[source]

Write data to specified json file

Note, this function uses dumps function to convert data to json first, and write only if conversion is successfule. This allows to avoid loss of data when rewriting file.


input([prompt]) -> string

Read a string from standard input. The trailing newline is stripped. If the user hits EOF (Unix: Ctl-D, Windows: Ctl-Z+Return), raise EOFError. On Unix, GNU readline is used if enabled. The prompt string, if given, is printed without a trailing newline before reading.