1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
=======================
Tryton Scripting Client
=======================
A library to access Tryton's models like a client.
Example of usage
----------------
>>> from proteus import config, Model, Wizard, Report
Configuration
~~~~~~~~~~~~~
Configuration to connect to a sqlite memory database using trytond as module.
>>> config = config.set_trytond('sqlite:///:memory:')
There is also the ``config.set_xmlrpc`` method which can be used to connect
using a URL, and the ``config.set_xmlrpc_session`` method (when used as a
context manager) which connects for a session.
Activating a module
~~~~~~~~~~~~~~~~~~~
Find the module, call the activate button and run the upgrade wizard.
>>> Module = Model.get('ir.module')
>>> party_module, = Module.find([('name', '=', 'party')])
>>> party_module.click('activate')
>>> Wizard('ir.module.activate_upgrade').execute('upgrade')
Creating a party
~~~~~~~~~~~~~~~~
First instantiate a new Party:
>>> Party = Model.get('party.party')
>>> party = Party()
>>> party.id < 0
True
Fill the fields:
>>> party.name = 'ham'
Save the instance into the server:
>>> party.save()
>>> party.name
'ham'
>>> party.id > 0
True
Setting the language of the party
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The language on party is a ``Many2One`` relation field. So it requires to get a
``Model`` instance as value.
>>> Lang = Model.get('ir.lang')
>>> en, = Lang.find([('code', '=', 'en')])
>>> party.lang = en
>>> party.save()
>>> party.lang.code
'en'
Creating an address for the party
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Addresses are store on party with a ``One2Many`` field.
So the new address just needs to be appended to the list ``addresses``.
>>> address = party.addresses.new(postal_code='42')
>>> party.save()
>>> party.addresses #doctest: +ELLIPSIS
[proteus.Model.get('party.address')(...)]
Adding category to the party
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Categories are linked to party with a ``Many2Many`` field.
So first create a category
>>> Category = Model.get('party.category')
>>> category = Category()
>>> category.name = 'spam'
>>> category.save()
Append it to categories of the party
>>> party.categories.append(category)
>>> party.save()
>>> party.categories #doctest: +ELLIPSIS
[proteus.Model.get('party.category')(...)]
Print party label
~~~~~~~~~~~~~~~~~
There is a label report on ``Party``.
>>> label = Report('party.label')
The report is executed with a list of records and some extra data.
>>> type_, data, print_, name = label.execute([party], {})
Sorting addresses and register order
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Addresses are ordered by sequence which means they can be stored following a
specific order.
The ``set_sequence`` method stores the current order.
>>> address = party.addresses.new(postal_code='69')
>>> party.save()
>>> address = party.addresses.new(postal_code='23')
>>> party.save()
Now changing the order.
>>> reversed_addresses = list(reversed(party.addresses))
>>> while party.addresses:
... _ = party.addresses.pop()
>>> party.addresses.extend(reversed_addresses)
>>> party.addresses.set_sequence()
>>> party.save()
>>> party.addresses == reversed_addresses
True
Setting context
~~~~~~~~~~~~~~~
Make French translatable:
>>> Language = Model.get('ir.lang')
>>> french, = Language.find([('code', '=', 'fr')])
>>> french.translatable = True
>>> french.save()
Create a category in English:
>>> Category = Model.get('party.category')
>>> with config.set_context(language='en'):
... category = Category(name="Category")
... category.save()
Translate in French:
>>> with config.set_context(language='fr'):
... category_fr = Category(category.id)
... category_fr.name = "Categorie"
... category_fr.save()
Read in English:
>>> category.reload()
>>> category.name
'Category'
Read in French:
>>> category_fr.reload()
>>> category_fr.name
'Categorie'
.. toctree::
:maxdepth: 2
releases
|
