New API in connector, bump to 3.0.0 #47

guewen · 2015-02-19T13:02:44Z

The changes done here will break the API compatibility.
However, they are necessary to keep up with the changes in Odoo.

The API in the connector still uses the cr, uid, ids, context api, even if
hidden in connector.Session. Not using new recordsets is restricting.

Example:
If I implements a new onchange on sale.order:

class SaleOrder(models.Model):
    @api.onchange('workflow_process_id'):
    def onchange_workflow_process_id(self):
        self.payment_method_id = self.workflow_process_id.payment_method_id

Then I won't be able to call from within a ConnectorUnit directly.
Locally I could do:

import openerp
[...]

  env = openerp.api.Environment(self.session.cr,
                                self.session.uid,
                                self.session.context)
  sale = env['sale.order'].new(values)
  sale.onchange_workflow_process_id()

But it would be far better to include the new API in the root classes.

Changes:

Add openerp.api.Environment in Session
It is accessible in self.env in Session and all
ConnectorUnit instances.
Also in ConnectorUnit, model returns the current (new api!) model:

    # On the current model
    self.model.search([])
    self.model.browse(ids)
    # on another model
    self.env['res.users'].search([])
    self.env['res.users'].browse(ids)

Deprecate the CRUD methods in Session

    # NO
    self.session.search('res.partner', [])
    self.session.browse('res.partner', ids)

    # YES
    self.env['res.partner'].search([])
    self.env['res.partner'].browse(ids)

Environment.set_lang() is removed. It was modifying the context
in place which is not possible with the new frozendict context. It
should be done with:
```
    with self.session.change_context(lang=lang_code):
        ...
```
Add an argument on the Binders methods to return a browse record
```
    binder.to_openerp(magento_id, browse=True)
```
Shorten ConnectorUnit.get_binder_for_model to
ConnectorUnit.binder_for
Shorten ConnectorUnit.get_connector_unit_for_model to
ConnectorUnit.unit_for
Renamed Environment to ConnectorEnvironment to avoid
confusion with openerp.api.Environment
Renamed the class attribute ConnectorUnit.model_name to
ConnectorUnit.for_model_name.
Added _base_binder, _base_mapper, _base_backend_adapter in
the synchronizers (Importer, Exporter) so it is no longer required to
override the binder, mapper, backend_adapter property
methods
Session.change_context() now supports the same
argument/keyword arguments semantics than
openerp.model.BaseModel.with_context().
Renamed ExportSynchronizer to Exporter
Renamed ImportSynchronizer to Importer
Renamed DeleteSynchronizer to Deleter
Session.commit do not commit when tests are running
Cleaned the methods that have been deprecated in version 2.x

guewen · 2015-02-19T13:07:01Z

connector/session.py

+        """ Context Manager: temporarily change the user's session and
+        restablish the normal user at closing,
+        """
+        raise Exception('Deprecated: use sudo() on a recordset.')


Maybe just yield a new Environment, and restore the original at closing.

This is required by the new api.onchange methods. The change needs OCA/connector#47

guewen · 2015-02-19T20:12:31Z

connector/connector.py

+                        'new-api model/recordset.')
+        return self.session.pool.get(self.environment.model_name)
+
+    def recordset(self, model=None):


The perfect name for this method would have been model... but it is already used.
recordset is a bit odd as it returns a model (but a model is also a new recordset in the new api), but I can't find a better name.

What about records?

users = self.records().search([]) # when the model of the ConnectorUnit is 'res.users' users = self.records('res.users').search([]) # when the model is another thing things = self.records().browse(ids) things.unlink()

coveralls · 2015-02-20T13:40:40Z

Coverage decreased (-0.22%) to 71.14% when pulling 0694a72440ca1ee07becabcef17dd5914d8480bd on guewen:8.0-connector-new-api into c89b66e on OCA:8.0.

Start to deprecate the Session class which can be entirely replaced by openerp.Environment and recordsets. The first step is to include the env in Session, and in a later version we'll replace it entirely by openerp.Environment. Now, 'self.env' in any ConnectorUnit returns the new API 'env'.

Beware, it should now be used as a contextmanager

…dset

Allow to customize them without overriding the whole property mapper or backend_adapter.

… instead

…e openerp's api

…h binder_for

Do not point directly to them from ConnectorUnit or Environment or it would not return the correct ones inside a Session.change_context() or Session.change_user()

And corrected a wrong __str__!

coveralls · 2015-03-12T20:03:13Z

Coverage increased (+3.88%) to 75.24% when pulling 3dfb312 on guewen:8.0-connector-new-api into 8a23ebe on OCA:8.0.

When a job has been canceled, it could no longer be read

Also documented a bit the construction of mappings in the metaclass

guewen · 2015-03-20T08:34:13Z

Branch's ready, I need reviews

This is required by the new api.onchange methods. The change needs OCA/connector#47

lmignon · 2015-03-20T10:34:59Z

@thank you @guewen for this hard work... Even if there are a lot of changes, I did not find any comments to make. 👍 (Code review)

pedrobaeza · 2015-03-20T10:48:46Z

Well, I have to check it when I change Prestashop connector, but at first glance, it seems 👍

I think we can merge and then make possibles PRs to fix problems.

tremlin · 2015-04-01T14:32:03Z

I reviewed the code and tested it (as part of magentoerpconnect), I recommend it for merging 👍
Thanks for the port to v8!

pedrobaeza · 2015-04-01T16:53:46Z

I proceed with the merge then and possible fixes will come as another PRs.

Thanks to all that have contributed!

New API in connector, bump to 3.0.0

pedrobaeza · 2015-04-01T16:54:58Z

@guewen, can you please include the same version log of this PR in any side of the web to have it as reference?

yvaucher · 2015-04-01T17:18:50Z

connector/CHANGES.rst

@@ -1,6 +1,74 @@
 Changelog
 ---------

+3.0.0 (not released)


Date needs to be set

I think you can make it via direct commit.

guewen · 2015-04-02T05:43:00Z

@guewen, can you please include the same version log of this PR in any side of the web to have it as reference?

What do you mean exactly by "in any side of the web"?
I updated http://odoo-connector.com if that's what you mean.

pedrobaeza · 2015-04-02T09:36:56Z

Yeah, http://odoo-connector.com/project/changes.html#id2 is what I mean. Thanks.

- see: OCA/connector#47

[MIG] Rename manifest file [MIG] Replace "openerp" ocurrences with "odoo" [MIG] Do not use RedmineConnectorSession anymore (issue #212) - extend ConnectorEnvironment to host the redmine_cache that was previously extended in RedmineConnectorSession - remove session parameter from connector.get_environment (the connector module takes the environment from the backend object now). the default language from the backend is not applied there, because the session object is not available anymore. - Simplify RedmineModelBinder reusing the generalizations from of Binder. This way the use of the session property is not needed. - Proxy the redmine_cache of RedmineImportSyncronizer to the one saved in the connector environment. The same happens for RedmineAdapter - Simplify RedmineImportSynchronizer to avoid the use of session - remove "session" parameter from: import_batch, import_record, mock_delay, get_environment, import_single_user_time_entries. It is not replaced with "env", because env parameter passing is also removed in the last version of odoo_connector. the environment is now taken from the backend_record... - that's why some methods pass now the backend object instead of the backend_id. The backend is used now to get the environment, not at the opossite. [MIG] replace `hr.analytic.timesheet` by `account.analytic.line` - since v9 the model 'hr.analytic.timesheet` has been replaced by `account.analytic.line`: https://github.com/OCA/OpenUpgrade/blob/9.0/addons/hr_timesheet/migrations/9.0.1.0/post-migration.py#L17 - note that in v9 we need also a mapper, in order to set:: is_timesheet = True during the import of the timesheet records [MIG] Use queue_job module from OCA/queue see: OCA/queue#1 [MIG] Renamed ImportSynchronizer to Importer - see: OCA/connector#47 [MIG] import exception module - the job exception types has been moved to the module: `queue_job`. - They are still loaded / proxied by the module `connector.exception`. - But somehow this requires that the module is correctly imported. - It is better to use always import. See: http://effbot.org/zone/import-confusion.htm - Import made similar to: OCA/connector#188 (comment) [MIG] slight changes to the Binder - Rename 'to_backend' to 'to_external' - Rename 'to_odoo' to 'to_internal' see: OCA/connector@fef7ee2 pep8 adjustments [MIG] rename ImportSynchronizers that left [MIG] fix hr_timesheet_sheet_form - the `buttons` element taked as reference by the previous version does not exist anymore - another position was selected so the result is the same fix pylint suggestions fix pyflakes errors

guewen reviewed Feb 19, 2015
View reviewed changes

guewen added a commit to guewen/connector-ecommerce that referenced this pull request Feb 19, 2015

SaleOrderOnChange now works with recordset instead of dicts

5ba242d

This is required by the new api.onchange methods. The change needs OCA/connector#47

guewen mentioned this pull request Feb 19, 2015

Migration of connector_ecommerce OCA/connector-ecommerce#18

Merged

3 tasks

guewen reviewed Feb 19, 2015
View reviewed changes

yvaucher added the work in progress label Feb 20, 2015

guewen force-pushed the 8.0-connector-new-api branch from 05b0b25 to 1c2412e Compare February 23, 2015 09:01

guewen added 2 commits March 5, 2015 21:28

ConnectorUnit.env to a property to prevent it to be modified

38a4932

guewen force-pushed the 8.0-connector-new-api branch from 223f2e7 to adc07cb Compare March 5, 2015 20:29

guewen mentioned this pull request Mar 12, 2015

[WIP] [MIG] Migrated Prestashop connector to v8 OCA/connector-prestashop#11

Closed

3 tasks

guewen added 18 commits March 12, 2015 14:43

Reimplement change_context and change_user with the env

41d74bf

set_lang must generate a new env because the context is frozen

fa2bb39

Beware, it should now be used as a contextmanager

Add ConnectorUnit.recordset, that returns a new api model/empty recor…

7205df7

…dset

Add a record argument on the Binder

1a53c9e

Shorten get_binder_for_model for binder_for

917b67f

Rename argument to 'browse' to be consistent with unwrap_binding

f04ba00

Add class attributes for the base ConnectorUnit classes

8b22edb

Allow to customize them without overriding the whole property mapper or backend_adapter.

Look for new fields in the Mapper

b349ee3

Rename the method 'recordset' to 'records'

a4da7be

Shorten 'get_connector_unit_for_model' to 'get_unit_for'

dad41e9

Deprecate Environment.set_lang, session.change_context should be used…

4bcedb7

… instead

Replace usage of ConnectorUnit.model by ConnectorUnit.records()

750d436

Use Session.pool instead of Session.registry to be consistent with th…

6819306

…e openerp's api

Shorten get_connector_unit_for_model to unit_for to be consistent wit…

bd471e3

…h binder_for

Remove methods deprecated in the previous versions

60fcc19

Give more details in the deprecation warnings

479b4cd

The pool or the context can be switched in Session,

8d0cfed

Do not point directly to them from ConnectorUnit or Environment or it would not return the correct ones inside a Session.change_context() or Session.change_user()

Migrate connector.backend to new API

a3f795d

Add test coverage on the backend

0a0ae38

And corrected a wrong __str__!

guewen added 4 commits March 12, 2015 21:23

More tests on jobs. Correct an issue on canceled jobs

01acb68

When a job has been canceled, it could no longer be read

too many blank lines

2aaef00

More tests in the Mapper, notably on Mapper with several bases

79b94d2

Also documented a bit the construction of mappings in the metaclass

Add test on the queue.job model

b05172a

This was referenced Mar 13, 2015

[ADD] 2 modules that allow you to manage your dns entries in DNSPod with... OCA/connector-interfaces#12

Closed

Migration of magentoerpconnect OCA/connector-magento#85

Merged

Set version 3 in __openerp__

8cd17cb

guewen changed the title ~~[WIP] New API in connector~~ New API in connector Mar 20, 2015

guewen changed the title ~~New API in connector~~ New API in connector, bump to 3.0.0 Mar 20, 2015

guewen added needs review and removed work in progress labels Mar 20, 2015

guewen added a commit to guewen/connector-ecommerce that referenced this pull request Mar 20, 2015

SaleOrderOnChange now works with recordset instead of dicts

b05870a

This is required by the new api.onchange methods. The change needs OCA/connector#47

guewen added a commit to guewen/connector-ecommerce that referenced this pull request Mar 20, 2015

SaleOrderOnChange now works with recordset instead of dicts

e548872

This is required by the new api.onchange methods. The change needs OCA/connector#47

pedrobaeza added a commit that referenced this pull request Apr 1, 2015

Merge pull request #47 from guewen/8.0-connector-new-api

ca5916d

New API in connector, bump to 3.0.0

pedrobaeza merged commit ca5916d into OCA:8.0 Apr 1, 2015

yvaucher removed the needs review label Apr 1, 2015

yvaucher reviewed Apr 1, 2015
View reviewed changes

yucer pushed a commit to elego/connector-redmine that referenced this pull request Mar 17, 2017

[MIG] Renamed ImportSynchronizer to Importer

81f4622

- see: OCA/connector#47

yucer pushed a commit to elego/connector-redmine that referenced this pull request Mar 22, 2017

[MIG] Renamed ImportSynchronizer to Importer

e7a28ce

- see: OCA/connector#47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New API in connector, bump to 3.0.0 #47

New API in connector, bump to 3.0.0 #47

guewen commented Feb 19, 2015

guewen Feb 19, 2015

guewen Feb 19, 2015

guewen Feb 20, 2015

coveralls commented Feb 20, 2015

coveralls commented Mar 12, 2015

guewen commented Mar 20, 2015

lmignon commented Mar 20, 2015

pedrobaeza commented Mar 20, 2015

tremlin commented Apr 1, 2015

pedrobaeza commented Apr 1, 2015

pedrobaeza commented Apr 1, 2015

yvaucher Apr 1, 2015

pedrobaeza Apr 1, 2015

guewen Apr 2, 2015

guewen commented Apr 2, 2015

pedrobaeza commented Apr 2, 2015

New API in connector, bump to 3.0.0 #47

New API in connector, bump to 3.0.0 #47

Conversation

guewen commented Feb 19, 2015

Changes:

guewen Feb 19, 2015

Choose a reason for hiding this comment

guewen Feb 19, 2015

Choose a reason for hiding this comment

guewen Feb 20, 2015

Choose a reason for hiding this comment

coveralls commented Feb 20, 2015

coveralls commented Mar 12, 2015

guewen commented Mar 20, 2015

lmignon commented Mar 20, 2015

pedrobaeza commented Mar 20, 2015

tremlin commented Apr 1, 2015

pedrobaeza commented Apr 1, 2015

pedrobaeza commented Apr 1, 2015

yvaucher Apr 1, 2015

Choose a reason for hiding this comment

pedrobaeza Apr 1, 2015

Choose a reason for hiding this comment

guewen Apr 2, 2015

Choose a reason for hiding this comment

guewen commented Apr 2, 2015

pedrobaeza commented Apr 2, 2015