Example of HTML capabilities of project inside IPython / Jupyter notebook¶

Note, this file used in tests, so it may contain additional test related logic.

Contents¶

Initializing Environment
Connect to odoo database
Session class
Connect to odoo database (via session)
Module Utils plugin
Get list of all registered objects / models
Get object / model
Getting information about available columns for Object / Model
Search for sale orders
Display Sale orders as HTML table
Anyfield integration
Nested HTMLTables
Recordlist-elements-access
Display one sale order as HTML Table
Report service

Initializing Environment¶

# import extensions first (they modify Session and Client classes)
from openerp_proxy.ext.all import HField

# Enable module_utils plugin
import openerp_proxy.plugins.module_utils

# Import Client and Session classes
from openerp_proxy import (Client,
                           Session)

Connect to odoo database¶

For connection to Odoo Client class is used. Below is example of it's usage.

cl = Client('localhost')  # connect to local instance of server
cl

Next we should check if our database is present on server. For this purpose we should use Odoo's database service, which could be accessed via Client.services.db. And if database does not exists, we can create it.

# check if our demo database exists
if 'openerp_proxy_test_db' not in cl.services.db:
    # create demo database
    cl.services.db.create_db('admin', 'openerp_proxy_test_db', demo=True, lang='en_US')

And now we can login to our database.

ldb = cl.login('openerp_proxy_test_db', 'admin', 'admin')  # all this arguments could be passed directly to Client constructor.

# and let's look how it is displayed in IPython
ldb

Note, that ldb is new instance of Client class, but with login credential. it can be used to interact with object service (models, documents, logic, ...)

Session class¶

If You often need to connect to same databases, there are a Session class, which automaticaly save, most of your connections, made via Session.connect method in specified file.

# create session instance
session = Session('~/.openerp_proxy.local.json')  # default file path is '~/.openerp_proxy.json'

And there are option You may be interested in. It is 'store_passwords', which automaticaly saves password You have used for connection.

session.option('store_passwords', True)

True

We used openerp_proxy.Client class to create connection to database, so our session does not know anything about it. Let's add our connection to our session:

session.add_db(ldb)
session

And now we can get this connection from session by index, or by URL (look at the table above). But to simplify next connections, we may add aliase to this connection

session.aliase('ldb', ldb)
session

So, now, to get connection again we could just type session.ldb.

Ok. initialization is done, and now we could save it.

session.save()

Connect to odoo database via session¶

Let's now create new instance of session, and connect to created above database

session = Session('~/.openerp_proxy.local.json')  # default file path is '~/.openerp_proxy.json'
ldb = session.ldb
ldb

Module Utils plugin¶

Our database is clean, for next code, we need to install sale addon. For this, we have module_utils plugin, out-of-the box, which simplyfies work with modules. To enable this plugin, we just need to import it, and then we will have it in ldb.plugins property. This plugin was imported above. This plugin extends ir.module.module model from client side, adding simple methods: install and upgrade to it for shorter syntax. If You're interested for code, look here, it is very simple!

Also this plugin allows to acces any module registered in database, as attribute of plugin. All module attributes are prefixed with m_. So to get access to sale module we can use folowing syntax: ldb.plugins.module_utils.m_sale.

So now, let's install sale module. (Note that in most cases, IPython autocompletition work's fine)

ldb.plugins.module_utils.m_sale.install()

{'tag': 'reload', 'type': 'ir.actions.client'}

Congratulation! module was installed!

One more interesting method of this plugins is module_utils.update_module_list method, which updates list of Odoo addons registered in database.

ldb.plugins.module_utils.update_module_list()

[58, 0]

Get list of all registered objects / models¶

To get list of registered models, just use registered_objects proerty of Client instance. It returns list of all registered models in database. For example:

ldb.registered_objects

Get object / model¶

ldb here represents database connection (Client class instance) As told in help message above .get_obj method allows to get instance of specified Object proxy, where Object means model, document.

so = ldb.get_obj('sale.order')
so

Also it is posible to use shorter (dictionary style) syntax:

so = ldb['sale.order']
so

And as result of using openerp_proxy.ext.sugar extension (which is automaticaly imported in 'openerp_proxy.ext.all') there are attribute-style access (which also support's IPython auto-completition):

so = ldb._sale_order
so

Getting information about available columns for Object¶

so.columns_info

Search for sale orders¶

# Standard search .search_records(domain)
so_list = so.search_records([])
so_list

Also there are shorter syntax provided by openerp_proxy.ext.sugar extension:

so_list = so([])
so_list

Display Sale orders as HTML table¶

It is posible to represent RecordList as HTML table, with ability to highlight rows by specified conditions. Also, when building result table, it is posible to display values of related fields, and even method calls. This functionality is implemented in openerp_proxy.ext.repr module

# High light rows by condition
highlighters = {
    '#99FF99': lambda x: x.state == 'done',
    '#9999FF': lambda x: x.state == 'draft',
    '#FFFF99': lambda x: x.state == 'progress',
}

# Display as table.
# Note that prefetch method is used to fetch some set of fields with less RPC call.
# on big datasets it may speed up performance signifiantly.
# Each RecordList instance have related cache, which reduce need of reading data on each field get.
so_list.prefetch('id', 'name', 'partner_id', 'partner_id.email', 'state')
so_table = so_list.as_html_table(
    'id',
    'name',
    # _name attribute provides result of *name_search method:
    HField('partner_id._name', name='Partner name'),
    # silent=True means, if field cannot be found, not throw error
    HField('partner_id.email', name='Partner email', silent=True),
    # Also it is posible to display result of method calls
    # 'as_html_list()' is method of RecordList.
    ('order_line.as_html_list', 'Order lines'),
    'state',
    highlighters=highlighters,
)
so_table

There also available to_csv method, which allow to represent table in csv format

so_table.to_csv()

Anyfield integration¶

This app has experimental integration with Anyfield library. For example it is posible to use Anyfield expressions in RecordList.filter method.

Ususaly You use lambdas to filter some records. Something like this:

partners = ldb._res_partner()  # find all partners in database
filtered_partners_l = partners.filter(lambda x: x.sale_order_ids.length >= 1)
filtered_partners_l

But using Anyfield expressions may be simpler. This library have F variable defined, which could be used as starting point of SField expressions.

from anyfield import F

# Imagine that F is record in partners recordlist. and pass expression based on this to filter method.
# It will automaticaly be converted to filter function
filtered_partners_f = partners.filter(F.sale_order_ids.length >= 1)
filtered_partners_f

To check that resultes are same, let's just compare them:

assert sorted(filtered_partners_f.ids) == sorted(filtered_partners_l.ids), \
    "Filtered partners must be same in both cases"

Nested HTMLTables¶

Also it is posible to display nested html tables. For example, lets list partners with sale orders related to them Here anyfield.F expression is used too.

filtered_partners_l.as_html_table(
    'id',
    'name',
    'parent_id',
    
    HField(F.sale_order_ids.as_html_table('id',
                                          '_name',
                                          'date_order',
                                          'amount_total',
                                          'state'),
           'Sale orders'),
)

Recordlist elements access¶

Recordlist supports access to containing elements via indexes

so_list[0]

Display one sale order as HTML Table¶

so_list[0].as_html('name',
                   'origin',
                   
                   # Will display Reacord instance representing partner related to this sale order
                   ('partner_id', 'Partner'),
                   
                   # Will display result of 'name_get' called on partner
                   ('partner_id._name', 'Partner name'),
                   
                   # Display how many sale orders have this partner
                   ('partner_id.sale_order_ids.length', 'Sales QTY'),
)

so_list[0].as_html()  # Display all fields for firest sale order record

Report service¶

Odoo 11.0 Note: in Odoo 11.0 report service was completely removed. All reports now handled by model ir.actions.report. So to get generated report, just call render method of this model and get generated report.

There is reports service available in Odoo (before 11.0), which allows to print reports. Example below is deprecated, use ir.actions.report model directly

from pkg_resources import parse_version as V

if ldb.server_version < V('11.0'):
    if 'sale.report_saleorder' in ldb.services.report:
        report_name = 'sale.report_saleorder'  # Odoo version >= 8.0
    elif 'sale.order' in ldb.services.report:
        report_name = 'sale.order'  # Odoo version 7.0
    else:
        raise Exception("Cannot find sale report")  # no such report registered on server
    report = ldb.services.report[report_name]
else:
    report = None

if report:
    report_result = report.generate(so_list)
    report_result

login	None
Host	localhost
Protocol	xml-rpc
Port	8069
Database	None

login	admin
Host	localhost
Protocol	xml-rpc
Port	8069
Database	openerp_proxy_test_db

login	admin
Host	localhost
Protocol	xml-rpc
Port	8069
Database	openerp_proxy_test_db

Model	sale.order
Client	xml-rpc://[email protected]:8069/openerp_proxy_test_db
Name	Sales Order
Record count	8

Model	sale.order
Client	xml-rpc://[email protected]:8069/openerp_proxy_test_db
Name	Sales Order
Record count	8

Name	Disp. Name	Type	Required	Help
amount_tax	Taxes	float	None	The tax amount.
amount_total	Total	float	None	The total amount.
amount_untaxed	Untaxed Amount	float	None	The amount without tax.
client_order_ref	Customer Reference	char	None	None
company_id	Company	many2one	None	None
create_date	Creation Date	datetime	None	Date on which sales order is created.
currency_id	Currency	many2one	True	None
date_confirm	Confirmation Date	date	None	Date on which sales order is confirmed.
date_order	Date	date	True	None
fiscal_position	Fiscal Position	many2one	None	None
invoice_exists	Invoiced	boolean	None	It indicates that sales order has at least one invoice.
invoice_ids	Invoices	many2many	None	This is the list of invoices that have been generated for this sales order. The same sales order may have been invoiced in several times (by line for example).
invoice_quantity	Invoice on	selection	True	The sales order will automatically create the invoice proposition (draft invoice).
invoiced	Paid	boolean	None	It indicates that an invoice has been paid.
invoiced_rate	Invoiced Ratio	float	None	None
message_follower_ids	Followers	many2many	None	None
message_ids	Messages	one2many	None	Messages and communication history
message_is_follower	Is a Follower	boolean	None	None
message_summary	Summary	text	None	Holds the Chatter summary (number of messages, ...). This summary is directly in html format in order to be inserted in kanban views.
message_unread	Unread Messages	boolean	None	If checked new messages require your attention.
name	Order Reference	char	True	None
note	Terms and conditions	text	None	None
order_line	Order Lines	one2many	None	None
order_policy	Create Invoice	selection	True	This field controls how invoice and delivery operations are synchronized.
origin	Source Document	char	None	Reference of the document that generated this sales order request.
partner_id	Customer	many2one	True	None
partner_invoice_id	Invoice Address	many2one	True	Invoice address for current sales order.
partner_shipping_id	Delivery Address	many2one	True	Delivery address for current sales order.
payment_term	Payment Term	many2one	None	None
paypal_url	Paypal Url	char	None	None
portal_payment_options	Portal Payment Options	html	None	None
pricelist_id	Pricelist	many2one	True	Pricelist for current sales order.
project_id	Contract / Analytic	many2one	None	The analytic account related to a sales order.
shop_id	Shop	many2one	True	None
state	Status	selection	None	Gives the status of the quotation or sales order. The exception status is automatically set when a cancel operation occurs in the processing of a document linked to the sales order. The 'Waiting Schedule' status is set when the invoice is confirmed but waiting for the scheduler to run on the order date.
user_id	Salesperson	many2one	None	None

Client	xml-rpc://[email protected]:8069/openerp_proxy_test_db
Object	Object ('sale.order')
Record count	8

id	name	Partner name	Partner email	Order lines	state
8	SO008	Millennium Industries	False	20: Laptop Customized 21: Mouse, Wireless	draft
7	SO007	Luminous Technologies	False	16: Laptop E5023 17: GrapWorks Software 18: Datacard 19: USB Adapter	manual
6	SO006	Think Big Systems	[email protected]	15: PC Assamble + 2GB RAM	draft
5	SO005	Agrolait	[email protected]	12: External Hard disk 13: Blank DVD-RW 14: Printer, All-in-one	draft
4	SO004	Millennium Industries	False	8: Service on demand 9: Webcam 10: Multimedia Speakers 11: Switch, 24 ports	draft
3	SO003	Chamber Works	[email protected]	6: On Site Monitoring 7: Toner Cartridge	draft
2	SO002	Bank Wealthy and sons	[email protected]	4: Service on demand 5: On Site Assistance	draft
1	SO001	Agrolait	[email protected]	1: Laptop E5023 2: Pen drive, 16GB 3: Headset USB	sent

Name	System Name	Description
Account	account.account	False
Templates for Accounts	account.account.template	False
Account Type	account.account.type	False
account.addtmpl.wizard	account.addtmpl.wizard	Add one more account from the template. With the 'nocreate' option, some accounts may not be created. Use this to add them later.
Account Aged Trial balance Report	account.aged.trial.balance	False
Analytic Account	account.analytic.account	False
Account Analytic Balance	account.analytic.balance	False
Account Analytic Chart	account.analytic.chart	False
Account Analytic Cost Ledger	account.analytic.cost.ledger	False
Account Analytic Cost Ledger For Journal Report	account.analytic.cost.ledger.journal.report	False
Account Analytic Inverted Balance	account.analytic.inverted.balance	False
Analytic Journal	account.analytic.journal	False
Account Analytic Journal	account.analytic.journal.report	False
Analytic Line	account.analytic.line	False
Automatic Reconcile	account.automatic.reconcile	False
Trial Balance Report	account.balance.report	False
account.bank.accounts.wizard	account.bank.accounts.wizard	False
Bank Statement	account.bank.statement	False
Bank Statement Line	account.bank.statement.line	False
CashBox Line	account.cashbox.line	Cash Box Details
Account Central Journal	account.central.journal	False
Change Currency	account.change.currency	False
Account chart	account.chart	For Chart of Accounts
Templates for Account Chart	account.chart.template	False
Account Common Account Report	account.common.account.report	False
Account Common Journal Report	account.common.journal.report	False
Account Common Partner Report	account.common.partner.report	False
Account Common Report	account.common.report	False
account.config.settings	account.config.settings	False
Journal Items Analysis	account.entries.report	False
Account Report	account.financial.report	False
Fiscal Position	account.fiscal.position	False
Accounts Fiscal Position	account.fiscal.position.account	False
Template Account Fiscal Mapping	account.fiscal.position.account.template	False
Taxes Fiscal Position	account.fiscal.position.tax	False
Template Tax Fiscal Position	account.fiscal.position.tax.template	False
Template for Fiscal Position	account.fiscal.position.template	False
Fiscal Year	account.fiscalyear	False
Fiscalyear Close	account.fiscalyear.close	Closes Account Fiscalyear and Generate Opening entries for New Fiscalyear
Fiscalyear Close state	account.fiscalyear.close.state	Closes Account Fiscalyear