Objects¶

Client.search(obj, domain, offset=0, limit=None, order=None, context=None)[source]¶

Filter the records in the domain, return the ids.

Client.count(obj, domain, context=None)[source]¶

Count the records in the domain.

Client.read(obj, domain, fields=None, offset=0, limit=None, order=None, context=None)[source]¶

Wrapper for client.execute(obj, 'read', [...], ('a', 'b')).

The first argument obj is the model name (example: "res.partner")

The second argument, domain, accepts:

• [('name', '=', 'mushroom'), ('state', '!=', 'draft')]
• ['name = mushroom', 'state != draft']
• []
• a list of ids [1, 2, 3] or a single id 42

The third argument, fields, accepts:

• a single field: 'first_name'
• a tuple of fields: ('street', 'city')
• a space separated string: 'street city'
• a format spec: '%(street)s %(city)s'

If fields is omitted, all fields are read.

If domain is a single id, then:

• return a single value if a single field is requested.
• return a string if a format spec is passed in the fields argument.
• else, return a dictionary.

If domain is not a single id, the returned value is a list of items. Each item complies with the rules of the previous paragraph.

The optional keyword arguments offset, limit and order are used to restrict the search. The order is also used to order the results returned. Note: the low-level RPC method read itself does not preserve the order of the results.

Client.perm_read(obj, ids, context=None, details=True)¶

Lookup metadata about the records in the ids list. Return a list of dictionaries with the following keys:

• id: object id
• create_uid: user who created the record
• create_date: date when the record was created
• write_uid: last user who changed the record
• write_date: date of the last change to the record
• xmlid: XML ID to use to refer to this record (if there is one), in format module.name (not available with OpenERP 5)

If details is True, the create_uid and write_uid contain the name of the user.

Client.write(obj, ids, values, context=None)¶

Update the record(s) with the content of the values dictionary.

Client.create(obj, values, context=None)¶

Create a new record for the model. The argument values is a dictionary of values for the new record. Return the object id.

Client.copy(obj, id, default=None, context=None)¶

Copy a record and return the new id. The optional argument default is a mapping which overrides some values of the new record.

Client.unlink(obj, ids, context=None)¶

Delete records with the given ids

Client.models(name='')[source]¶

Return a dictionary of models.

The argument name is a pattern to filter the models returned. If omitted, all models are returned. Keys are camel case names of the models. Values are instances of Model.

The return value can be used to declare the models in the global namespace:

>>> globals().update(client.models('res.'))

Client.model(name, check=True)[source]¶

Return a Model instance.

The argument name is the name of the model. If the optional argument check is False, no validity check is done.

Client.keys(obj)[source]¶

Wrapper for Model.keys() method.

Client.fields(obj, names=None)[source]¶

Wrapper for Model.fields() method.

Client.field(obj, name)[source]¶

Wrapper for Model.field() method.

Client.access(obj, mode='read')[source]¶

Wrapper for Model.access() method.

Advanced methods¶

Those methods give more control on the OpenERP objects: workflows and reports. Please refer to the OpenERP documentation for details.

Client.execute(obj, method, *params, **kwargs)[source]¶

Wrapper around object.execute RPC method.

Argument method is the name of an osv.osv method or a method available on this obj. Method params are allowed. If needed, keyword arguments are collected in kwargs.

Client.execute_kw(obj, ids, params, kwargs=None)¶

Wrapper around object.execute_kw RPC method.

Does not exist if server is OpenERP 5.

Client.exec_workflow(obj, signal, obj_id)[source]¶

Wrapper around object.exec_workflow RPC method.

Argument obj is the name of the model. The signal is sent to the object identified by its integer id obj_id.

Client.report(obj, ids, datas=None, context=None)¶

Wrapper around report.report RPC method.

Client.render_report(obj, ids, datas=None, context=None)¶

Wrapper around report.render_report RPC method.

Does not exist if server is OpenERP 5.

Client.report_get(report_id)¶

Wrapper around report.report_get RPC method.

Client.wizard(name, datas=None, action='init', context=None)[source]¶

Wrapper around wizard.create and wizard.execute RPC methods.

If only name is provided, a new wizard is created and its id is returned. If action is not "init", then the action is executed. In this case the name is either an id or a string. If the name is a string, the wizard is created before the execution. The optional datas argument provides data for the action. The optional context argument is passed to the RPC method.

Removed in OpenERP 7.

XML-RPC Services¶

The nake XML-RPC services are exposed too. There are five services. The db and the common services expose few methods which might be helpful for server administration. Use the dir() function to introspect them. The three other services should not be used directly: they are in the private namespace, starting with _ because their methods are wrapped and exposed on the Client object itself. Please refer to the OpenERP documentation for more details.

Client.db¶

Expose the db Service.

Examples: Client.db.list() or Client.db.server_version() RPC methods.

Client.common¶

Expose the common Service.

Example: Client.common.login_message() RPC method.

Client._object¶

Expose the object Service.

Client._report¶

Expose the report Service.

Client._wizard¶

Expose the wizard Service.

Removed in OpenERP 7.

class erppeek.Service(server, endpoint, methods, verbose=False)[source]¶

A wrapper around XML-RPC endpoints.

The connected endpoints are exposed on the Client instance. The server argument is the URL of the server (scheme+host+port). If server is an openerp module, it is used to connect to the local server. The endpoint argument is the name of the service (examples: "object", "db"). The methods is the list of methods which should be exposed on this endpoint. Use dir(...) on the instance to list them.

Manage addons¶

These helpers are convenient to list, install or upgrade addons from a Python script or interactively in a Python session.

Client.modules(name='', installed=None)[source]¶

Return a dictionary of modules.

The optional argument name is a pattern to filter the modules. If the boolean argument installed is True, the modules which are “Not Installed” or “Not Installable” are omitted. If the argument is False, only these modules are returned. If argument installed is omitted, all modules are returned. The return value is a dictionary where module names are grouped in lists according to their state.

Client.install(*modules)[source]¶

Press the button Install.

Client.upgrade(*modules)[source]¶

Press the button Upgrade.

Client.uninstall(*modules)[source]¶

Press the button Uninstall.

1.5.3 (2014-05-26)¶

• Change command line output to CSV format.
• Translate command line output according to LANG environment variable.
• Pretty print the list of modules.
• Do not report Module(s) not found when trying to install a module already installed.

1.5.2 (2014-04-12)¶

• Return an appropriate error message when the client is not connected.
• Two similar Record from different connections do not compare equal.
• Set the PGAPPNAME used for the PostgreSQL connection, in local mode.
• Close PostgreSQL connections on exit, in local mode.
• Implement the context manager protocol.

1.5.1 (2014-03-11)¶

• When switching to a different environment, with Client.connect, invalidate the previous connection to avoid mistakes (interactive mode).
• Avoid cluttering the globals in interactive mode.
• Close socket to avoid ResourceWarning on Python 3.
• The get_pool helper is only available in interactive mode and if the client is connected locally using the openerp package.
• Clear the last exception before entering interactive mode, only needed on Python 2.
• Fix the searchargs domain parser for compatibility with Python 3.4.

1.5 (2014-03-10)¶

• Advertize the Model and Record paradigm in the usage printed in interactive mode: it’s far more easier to use, and available since 1.0.
• In interactive mode, only inject four global names: client, models, model and do. Other methods are available on Model and Client instances (read search count keys fields access ...).
• Always clear the Record cache when an arbitrary method is called on this Record.
• Implement == comparison for Record instances.
• New computed attributes Record._external_id and RecordList._external_id, and new method Model._get_external_ids(ids=None).
• Better parsing of dates in search terms.
• Reject invalid == operator in search terms.
• Now the str(...) of a Record is always retrieved with name_get. Previously, the output was sometimes inconsistent.
• Fix TypeError when browsing duplicate ids.
• Fix error with Model.get(['field = value'], context={...}).
• Workaround an issue with some models: always pass a list of ids to read.
• Test the behaviour when read is called with a False id: it happens when browsing a RecordList for example.

1.4.5 (2013-03-20)¶

• Extend Model.get to retrieve a record by xml_id.
• Fix AttributeError when reading a mix of valid and invalid records.
• Fix dir() on Record and RecordList to return all declared fields, and do not report id field twice.
• Fix a crash with built-in OS X readline on Python 2.5 or 2.6.

1.4.4 (2013-03-05)¶

• Remove deprecated Record.client.
• Fix compatibility with Python 3.
• Add optional argument check to the Client.model method to bypass the verification in some cases, used to speed up the read methods.
• Do not crash when mixing non-existing and existing records: return always False for non-existing records.

1.4.3 (2013-01-10)¶

• Compatible with OpenERP 7.
• Set the database name as thread attribute to print it in the log file (local mode only).
• Do not try to access private methods through RPC when resolving attributes of the Client or any Record or RecordList.

1.4.2 (2012-12-19)¶

• Add the get_pool helper when connected using the openerp library.
• Remove the leading slash on the server option, if present.
• Do not try to access private methods through RPC when reading attributes of the model(...).

1.4.1 (2012-10-05)¶

• Fix reading many2one attribute on RecordList object in local mode.
• Fix occasional issue on login when switching database on the same server.
• Optimization: do not propagate the call to RecordList.write or RecordList.unlink if the list is empty.
• Clear the Record cache on Record._send.
• Expose the method Record.refresh to clear the local cache.

1.4 (2012-10-01)¶

• New: direct connection to a local server using the openerp library. Use scheme = local and options = -c /path/to/openerp-server.conf in the configuration.

1.3.1 (2012-09-28)¶

• Fix method Record._send.

1.3 (2012-09-27)¶

• Implement exception chaining in format_exception to print the original traceback.
• Return a list of Record objects when reading the reference field of a RecordList object.
• Fix reading attributes on RecordList with holes or gaps.
• Accessing an empty one2many or many2many attribute on a Record returns a RecordList.
• New method Model.get to retrieve a single Record. It raises a ValueError if multiple records are found.
• New method Record._send to send a workflow signal.

1.2.2 (2012-09-24)¶

• Accept Record and RecordList attribute values when writing or creating records.
• Improve the methods write and create of Record and RecordList objects to manage one2many and many2many fields.
• Return a Record when reading a reference field. Implement the create and write methods for these fields.
• Remove undocumented alias Record.update.

1.2.1 (2012-09-21)¶

• Add the special operators =ilike, =ilike, =? and fix parsing of inequality operators >= and <=.
• Fix the RecordList.id attribute, and deprecate RecordList._ids.
• Deprecate the Record.client attribute: use Record._model.client.
• Accessing an empty many2one attribute on a RecordList now returns a RecordList.
• Fix TypeError when browsing non-existent records.

1.2 (2012-09-19)¶

• Catch some malformed search domains before sending the RPC request.
• Preserve dictionary response when calling non standard Record methods.
• Expose the helper format_exception which formats the errors received through XML-RPC.
• Support XML-RPC through HTTPS with scheme = https in the erppeek.ini configuration file.
• Print an error message when client.upgrade(...) does not find any module to upgrade.

1.1 (2012-09-04)¶

• When using arbitrary methods on Record, wrap the id in a list [id]. It fixes a recurring issue with poorly tested methods.
• Do not read all records if the RecordList is empty.
• Fix the bad behaviour when switching to a different database.
• Order the results when using read method with order= argument.
• Reading attributes of the sequence <RecordList 'sea.fish,[2, 1, 2]'> will return an ordered sequence of three items. Previously it used to return an unordered sequence of two items.
• Accept the %(...)s formatting for the fields parameter of the Record.read and the RecordList.read methods too.
• Add a tutorial to the documentation.

1.0 (2012-08-29)¶

• Add the test suite for Python 2 and Python 3.
• Implement len() for RecordList objects.
• Connect to the server even if the database is missing.
• Expose the method Client.db.get_progress.
• New method Client.create_database which wraps together Client.db.create and Client.db.get_progress.
• Save the readline history in ~/.erppeek_history, only if the file already exists.
• Enable auto-completion using rlcompleter standard module.
• Raise an AttributeError when assigning to a missing or read-only attribute.

0.11 (2012-08-24)¶

• Enhance the Model.browse() method to accept the same keyword arguments as the Client.search() method.
• Fix the verbose level on Client.connect().
• Fix the Record.copy() method.
• Fix the Record.perm_read() method (workaround an OpenERP bug when dealing with single ids).
• Drop the --search argument, because the search terms can be passed as positional arguments after the options. Explain it in the description.
• Fix the shell command. Request the password interactively if it’s not in the options and not in the configuration file.

0.10 (2012-08-23)¶

• Add the --verbose switch to log the XML-RPC messages. Lines are truncated at 79 chars. Use -vv or -vvv to truncate at 179 or 9999 chars respectively.
• Removed the --write switch because it’s not really useful. Use Record.write() or client.write() for example.
• Stop raising RuntimeError when calling Client.model(name). Simply print the message if the name does not match.
• Fix RecordList.read() and Record.read() methods to accept the same diversity of fields arguments as the Client.read() method.
• RecordList.read() and Record.read() return instances of RecordList and Record for relational fields.
• Optimize: store the name of the Record when a relational field is accessed.
• Fix message wording on module install or upgrade.

0.9.2 (2012-08-22)¶

• Fix Record.write() and Record.unlink() methods.
• Fix the caching of the Model keys and fields and the Record name.

0.9.1 (2012-08-22)¶

• Fix client.model() method. Add models() to the globals() in interactive mode.

0.9 (2012-08-22)¶

• Add the Active Record pattern for convenience. New classes Model, RecordList and Record. The Client.model() method now returns a single Model instance. These models can be reached using camel case attribute too. Example: client.model('res.company') and client.ResCompany return the same Model.
• Refresh the list of modules before install or upgrade.
• List all modules which have state not in ('uninstalled', 'uninstallable') when calling client.modules(installed=True).
• Add documentation.

0.8 (2012-04-24)¶

• Fix help(client) and repr(...).
• Add basic safeguards for argument types.

0.7 (2012-04-04)¶

• Fix RuntimeError on connection.

0.6 (2012-04-03)¶

• Support Python 3.
• Return Client method instead of function when calling client.write or similar.
• Fix the case where read() is called with a single id.

0.5 (2012-03-29)¶

• Implement Client.__getattr__ special attribute to call any object method, like client.write(obj, values). This is somewhat redundant with client.execute(obj, 'write', values) and its interactive alias do(obj, 'write', values).
• Add --write switch to enable unsafe helpers: write, create, copy and unlink.
• Tolerate domain without square brackets, but show a warning.
• Add long options --search for -s, --interact for -i.

0.4 (2012-03-28)¶

• Workaround for sys.excepthook ignored, related to a Python issue.

0.3 (2012-03-26)¶

• Add --config and --version switches.
• Improve documentation with session examples.
• Move the project from Launchpad to GitHub.

0.2 (2012-03-24)¶

• Allow to switch user or database: methods client.login and client.connect.
• Allow context= keyword argument.
• Add access(...) method.
• Add %(...)s formatting for the fields parameter of the read(...) method.
• Refactor the interactive mode.
• Many improvements.
• Publish on PyPI.

0.1 (2012-03-14)¶

• Initial release.