[IMP] base_user_role_history: black, isort

base_user_role_history/__manifest__.py

@@ -2,28 +2,25 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 {
-    'name': 'Base User Role History',
-    'summary': """
+    "name": "Base User Role History",
+    "summary": """
         This module allows to track the changes on users roles.""",
-    'version': '12.0.1.0.0',
-    'license': 'AGPL-3',
-    'author': 'ACSONE SA/NV, '
-              'Odoo Community Association (OCA)',
-    'website': 'https://github.com/OCA/server-tools',
-    'depends': [
+    "version": "12.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV, " "Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/server-tools",
+    "depends": [
         # Odoo
-        'mail',
+        "mail",
         # OCA
-        'base_user_role',
-        'base_suspend_security',
+        "base_user_role",
+        "base_suspend_security",
     ],
-    'data': [
-        'security/base_user_role_line_history.xml',
-        'views/base_user_role_line_history.xml',
-        'views/res_users.xml',
-    ],
-    'development_status': 'Beta',
-    'maintainers': [
-        'ThomasBinsfeld'
+    "data": [
+        "security/base_user_role_line_history.xml",
+        "views/base_user_role_line_history.xml",
+        "views/res_users.xml",
     ],
+    "development_status": "Beta",
+    "maintainers": ["ThomasBinsfeld"],
 }

base_user_role_history/models/base_user_role_line_history.py

@@ -5,71 +5,47 @@ from odoo import api, fields, models
 
 
 class BaseUserRoleLineHistory(models.Model):
-    _name = 'base.user.role.line.history'
+    _name = "base.user.role.line.history"
     _description = "History of user roles"
-    _order = 'id desc'
+    _order = "id desc"
 
     performed_action = fields.Selection(
         string="Action",
-        selection=[
-            ('add', 'Add'),
-            ('unlink', 'Delete'),
-            ('edit', 'Edit')
-        ],
+        selection=[("add", "Add"), ("unlink", "Delete"), ("edit", "Edit")],
         required=True,
         readonly=True,
     )
     user_id = fields.Many2one(
         string="User",
-        comodel_name='res.users',
-        ondelete='cascade',
+        comodel_name="res.users",
+        ondelete="cascade",
         readonly=True,
         index=True,
     )
     old_role_id = fields.Many2one(
         string="Old role",
-        comodel_name='res.users.role',
-        ondelete='cascade',
+        comodel_name="res.users.role",
+        ondelete="cascade",
         readonly=True,
         index=True,
     )
     new_role_id = fields.Many2one(
         string="New role",
-        comodel_name='res.users.role',
-        ondelete='cascade',
+        comodel_name="res.users.role",
+        ondelete="cascade",
         readonly=True,
         index=True,
     )
-    old_date_from = fields.Date(
-        string="Old start date",
-        readonly=True,
-    )
-    new_date_from = fields.Date(
-        string="New start date",
-        readonly=True,
-    )
-    old_date_to = fields.Date(
-        string="Old end date",
-        readonly=True,
-    )
-    new_date_to = fields.Date(
-        string="New end date",
-        readonly=True,
-    )
-    old_is_enabled = fields.Boolean(
-        string="Active before edit",
-        readonly=True,
-    )
-    new_is_enabled = fields.Boolean(
-        string="Active after edit",
-        readonly=True,
-    )
+    old_date_from = fields.Date(string="Old start date", readonly=True)
+    new_date_from = fields.Date(string="New start date", readonly=True)
+    old_date_to = fields.Date(string="Old end date", readonly=True)
+    new_date_to = fields.Date(string="New end date", readonly=True)
+    old_is_enabled = fields.Boolean(string="Active before edit", readonly=True)
+    new_is_enabled = fields.Boolean(string="Active after edit", readonly=True)
 
     @api.model
     def _prepare_create_from_vals(
-            self,
-            old_role_line_values_by_user,
-            new_role_line_values_by_user
+        self, old_role_line_values_by_user, new_role_line_values_by_user
     ):
         role_history_line_vals_by_role_line = {}
         for key, value in new_role_line_values_by_user.items():
@@ -77,53 +53,51 @@ class BaseUserRoleLineHistory(models.Model):
             new_vals = value
             # Manage deletion of role lines and old values of modified lines
             for role_line_id, role_line_vals in old_vals.items():
-                action = 'unlink' if role_line_id not in new_vals else 'edit'
-                if action == 'edit':
+                action = "unlink" if role_line_id not in new_vals else "edit"
+                if action == "edit":
                     # Skip if no change
                     if not any(
-                            role_line_vals[k] != new_vals[role_line_id][k]
-                            for k in role_line_vals
+                        role_line_vals[k] != new_vals[role_line_id][k]
+                        for k in role_line_vals
                     ):
                         continue
-                role_history_line_vals_by_role_line.setdefault(
-                    role_line_id, {}
+                role_history_line_vals_by_role_line.setdefault(role_line_id, {})
+                role_history_line_vals_by_role_line[role_line_id].update(
+                    {
+                        "performed_action": action,
+                        "user_id": role_line_vals["user_id"],
+                        "old_role_id": role_line_vals["role_id"],
+                        "old_date_from": role_line_vals["date_from"],
+                        "old_date_to": role_line_vals["date_to"],
+                        "old_is_enabled": role_line_vals["is_enabled"],
+                    }
                 )
-                role_history_line_vals_by_role_line[role_line_id].update({
-                    'performed_action': action,
-                    'user_id': role_line_vals['user_id'],
-                    'old_role_id': role_line_vals['role_id'],
-                    'old_date_from': role_line_vals['date_from'],
-                    'old_date_to': role_line_vals['date_to'],
-                    'old_is_enabled': role_line_vals['is_enabled'],
-                })
             # Manage addition of role lines and new values of modified ones
             for role_line_id, role_line_vals in new_vals.items():
-                action = 'add' if role_line_id not in old_vals else 'edit'
-                if action == 'edit':
+                action = "add" if role_line_id not in old_vals else "edit"
+                if action == "edit":
                     # Skip if no change
                     if not any(
-                            role_line_vals[k] != old_vals[role_line_id][k]
-                            for k in role_line_vals
+                        role_line_vals[k] != old_vals[role_line_id][k]
+                        for k in role_line_vals
                     ):
                         continue
-                role_history_line_vals_by_role_line.setdefault(
-                    role_line_id, {}
+                role_history_line_vals_by_role_line.setdefault(role_line_id, {})
+                role_history_line_vals_by_role_line[role_line_id].update(
+                    {
+                        "performed_action": action,
+                        "user_id": role_line_vals["user_id"],
+                        "new_role_id": role_line_vals["role_id"],
+                        "new_date_from": role_line_vals["date_from"],
+                        "new_date_to": role_line_vals["date_to"],
+                        "new_is_enabled": role_line_vals["is_enabled"],
+                    }
                 )
-                role_history_line_vals_by_role_line[role_line_id].update({
-                    'performed_action': action,
-                    'user_id': role_line_vals['user_id'],
-                    'new_role_id': role_line_vals['role_id'],
-                    'new_date_from': role_line_vals['date_from'],
-                    'new_date_to': role_line_vals['date_to'],
-                    'new_is_enabled': role_line_vals['is_enabled'],
-                })
         return role_history_line_vals_by_role_line
 
     @api.model
     def create_from_vals(
-            self,
-            old_role_line_values_by_user,
-            new_role_line_values_by_user
+        self, old_role_line_values_by_user, new_role_line_values_by_user
     ):
         """
         This method creates user role line history objects based on given

base_user_role_history/models/res_users.py

@@ -1,25 +1,24 @@
 # Copyright 2019 ACSONE SA/NV
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
-from odoo import api, fields, models, _
+from odoo import _, api, fields, models
 
 
 class ResUsers(models.Model):
-    _inherit = 'res.users'
+    _inherit = "res.users"
 
     last_role_line_modification = fields.Datetime(
-        string="Last roles modification",
-        readonly=True,
+        string="Last roles modification", readonly=True
     )
 
     @api.model
     def _prepare_role_line_history_dict(self, role_line):
         return {
-            'user_id': role_line.user_id.id,
-            'role_id': role_line.role_id.id,
-            'date_from': role_line.date_from,
-            'date_to': role_line.date_to,
-            'is_enabled': role_line.is_enabled,
+            "user_id": role_line.user_id.id,
+            "role_id": role_line.role_id.id,
+            "date_from": role_line.date_from,
+            "date_to": role_line.date_to,
+            "is_enabled": role_line.is_enabled,
         }
 
     @api.multi
@@ -28,48 +27,45 @@ class ResUsers(models.Model):
         for rec in self:
             role_line_values_by_user.setdefault(rec, {})
             for role_line in rec.role_line_ids:
-                role_line_values_by_user[rec][role_line.id] = \
-                    self._prepare_role_line_history_dict(role_line)
+                role_line_values_by_user[rec][
+                    role_line.id
+                ] = self._prepare_role_line_history_dict(role_line)
         return role_line_values_by_user
 
     @api.model_create_multi
     def create(self, vals_list):
         res = super().create(vals_list)
         for vals in vals_list:
-            if 'role_line_ids' not in vals:
+            if "role_line_ids" not in vals:
                 return res
         new_role_line_values_by_user = res._get_role_line_values_by_user()
-        self.env['base.user.role.line.history'].create_from_vals(
-            {},
-            new_role_line_values_by_user
+        self.env["base.user.role.line.history"].create_from_vals(
+            {}, new_role_line_values_by_user
         )
         res.last_role_line_modification = fields.Datetime.now()
         return res
 
     @api.multi
     def write(self, vals):
-        if 'role_line_ids' not in vals:
+        if "role_line_ids" not in vals:
             return super().write(vals)
         old_role_line_values_by_user = self._get_role_line_values_by_user()
         res = super().write(vals)
         new_role_line_values_by_user = self._get_role_line_values_by_user()
-        self.env['base.user.role.line.history'].create_from_vals(
-            old_role_line_values_by_user,
-            new_role_line_values_by_user
+        self.env["base.user.role.line.history"].create_from_vals(
+            old_role_line_values_by_user, new_role_line_values_by_user
         )
-        self.write({
-            'last_role_line_modification': fields.Datetime.now()
-        })
+        self.write({"last_role_line_modification": fields.Datetime.now()})
         return res
 
     @api.multi
     def show_role_lines_history(self):  # pragma: no cover
         self.ensure_one()
-        domain = [('user_id', '=', self.id)]
+        domain = [("user_id", "=", self.id)]
         return {
-            'name': _("Roles history"),
-            'type': 'ir.actions.act_window',
-            'view_mode': 'tree,form',
-            'res_model': 'base.user.role.line.history',
-            'domain': domain,
+            "name": _("Roles history"),
+            "type": "ir.actions.act_window",
+            "view_mode": "tree,form",
+            "res_model": "base.user.role.line.history",
+            "domain": domain,
         }

base_user_role_history/tests/test_base_user_role_history.py

@@ -7,25 +7,20 @@ from odoo.tests.common import SavepointCase
 
 
 class TestBaseUserRoleHistory(SavepointCase):
-
     @classmethod
     def setUpClass(cls):
         super(TestBaseUserRoleHistory, cls).setUpClass()
 
         # MODELS
 
-        cls.history_line_model = cls.env['base.user.role.line.history']
-        cls.role_model = cls.env['res.users.role']
-        cls.user_model = cls.env['res.users']
+        cls.history_line_model = cls.env["base.user.role.line.history"]
+        cls.role_model = cls.env["res.users.role"]
+        cls.user_model = cls.env["res.users"]
 
         # INSTANCE
 
-        cls.user_01 = cls.user_model.search([
-            ('id', '!=', cls.env.user.id)
-        ], limit=1)
-        cls.role_01 = cls.role_model.create({
-            'name': "Role test 01",
-        })
+        cls.user_01 = cls.user_model.search([("id", "!=", cls.env.user.id)], limit=1)
+        cls.role_01 = cls.role_model.create({"name": "Role test 01"})
 
     def test_write_role_lines_on_user(self):
         """
@@ -43,80 +38,74 @@ class TestBaseUserRoleHistory(SavepointCase):
             4) new role history line created with performed_action == 'unlink'
         """
         # 1
-        history_lines_0 = self.history_line_model.search([
-            ('user_id', '=', self.user_01.id)
-        ])
+        history_lines_0 = self.history_line_model.search(
+            [("user_id", "=", self.user_01.id)]
+        )
         self.assertFalse(history_lines_0)
-        self.user_01.write({
-            'role_line_ids': [
-                (0, 0, {
-                    'role_id': self.role_01.id
-                })
-            ]
-        })
-        history_lines_1 = self.history_line_model.search([
-            ('user_id', '=', self.user_01.id)
-        ])
+        self.user_01.write({"role_line_ids": [(0, 0, {"role_id": self.role_01.id})]})
+        history_lines_1 = self.history_line_model.search(
+            [("user_id", "=", self.user_01.id)]
+        )
         self.assertTrue(history_lines_1)
         self.assertEqual(len(history_lines_1), 1)
-        self.assertEqual(history_lines_1.performed_action, 'add')
+        self.assertEqual(history_lines_1.performed_action, "add")
         self.assertFalse(history_lines_1.old_role_id)
         self.assertEqual(history_lines_1.new_role_id, self.role_01)
         # 2
-        self.user_01.write({
-            'role_line_ids': [
-                (1, self.user_01.role_line_ids[0].id, {
-                    'date_from': date.today(),
-                    'date_to': date.today() + timedelta(days=5),
-                })
-            ]
-        })
-        history_lines_2 = self.history_line_model.search([
-            ('user_id', '=', self.user_01.id),
-            ('id', 'not in', history_lines_1.ids)
-        ])
+        self.user_01.write(
+            {
+                "role_line_ids": [
+                    (
+                        1,
+                        self.user_01.role_line_ids[0].id,
+                        {
+                            "date_from": date.today(),
+                            "date_to": date.today() + timedelta(days=5),
+                        },
+                    )
+                ]
+            }
+        )
+        history_lines_2 = self.history_line_model.search(
+            [("user_id", "=", self.user_01.id), ("id", "not in", history_lines_1.ids)]
+        )
         self.assertTrue(history_lines_2)
         self.assertEqual(len(history_lines_2), 1)
-        self.assertEqual(history_lines_2.performed_action, 'edit')
+        self.assertEqual(history_lines_2.performed_action, "edit")
         self.assertEqual(history_lines_2.old_role_id, self.role_01)
         self.assertEqual(history_lines_2.new_role_id, self.role_01)
         self.assertFalse(history_lines_2.old_date_from)
         self.assertEqual(history_lines_2.new_date_from, date.today())
         self.assertFalse(history_lines_2.old_date_to)
-        self.assertEqual(
-            history_lines_2.new_date_to,
-            date.today() + timedelta(days=5)
+        self.assertEqual(history_lines_2.new_date_to, date.today() + timedelta(days=5))
+        self.user_01.write(
+            {"role_line_ids": [(1, self.user_01.role_line_ids[0].id, {})]}
+        )
+        history_lines_3 = self.history_line_model.search(
+            [
+                ("user_id", "=", self.user_01.id),
+                ("id", "not in", (history_lines_1 | history_lines_2).ids),
+            ]
         )
-        self.user_01.write({
-            'role_line_ids': [(1, self.user_01.role_line_ids[0].id, {})]
-        })
-        history_lines_3 = self.history_line_model.search([
-            ('user_id', '=', self.user_01.id),
-            ('id', 'not in', (history_lines_1 | history_lines_2).ids)
-        ])
         self.assertFalse(history_lines_3)
         # 4
-        self.user_01.write({
-            'role_line_ids': [(2, self.user_01.role_line_ids[0].id, False)],
-        })
-        history_lines_4 = self.history_line_model.search([
-            ('user_id', '=', self.user_01.id),
-            ('id', 'not in', (history_lines_1 | history_lines_2).ids)
-        ])
+        self.user_01.write(
+            {"role_line_ids": [(2, self.user_01.role_line_ids[0].id, False)]}
+        )
+        history_lines_4 = self.history_line_model.search(
+            [
+                ("user_id", "=", self.user_01.id),
+                ("id", "not in", (history_lines_1 | history_lines_2).ids),
+            ]
+        )
         self.assertTrue(history_lines_4)
         self.assertEqual(len(history_lines_4), 1)
-        self.assertEqual(history_lines_4.performed_action, 'unlink')
+        self.assertEqual(history_lines_4.performed_action, "unlink")
         self.assertEqual(history_lines_4.old_role_id, self.role_01)
         self.assertFalse(history_lines_4.new_role_id)
-        self.assertEqual(
-            history_lines_4.old_date_from,
-            date.today()
-        )
+        self.assertEqual(history_lines_4.old_date_from, date.today())
         self.assertFalse(history_lines_4.new_date_from)
-        self.assertEqual(
-            history_lines_4.old_date_to,
-            date.today() + timedelta(days=5)
-        )
+        self.assertEqual(history_lines_4.old_date_to, date.today() + timedelta(days=5))
         self.assertFalse(history_lines_4.new_date_to)
 
     def test_create_role_lines_on_new_user(self):
@@ -127,21 +116,17 @@ class TestBaseUserRoleHistory(SavepointCase):
         Expected results :
             - new role history line created with performed_action == 'add'
         """
-        new_user = self.user_model.create({
-            'login': 'new_user',
-            'name': 'new_user',
-            'role_line_ids': [
-                (0, 0, {
-                    'role_id': self.role_01.id,
-                })
-            ]
-        })
-        history_lines = self.history_line_model.search([
-            ('user_id', '=', new_user.id)
-        ])
+        new_user = self.user_model.create(
+            {
+                "login": "new_user",
+                "name": "new_user",
+                "role_line_ids": [(0, 0, {"role_id": self.role_01.id})],
+            }
+        )
+        history_lines = self.history_line_model.search([("user_id", "=", new_user.id)])
         self.assertTrue(history_lines)
         self.assertEqual(len(history_lines), 1)
-        self.assertEqual(history_lines.performed_action, 'add')
+        self.assertEqual(history_lines.performed_action, "add")
 
     def test_no_create_role_lines_on_new_user(self):
         """
@@ -151,11 +136,6 @@ class TestBaseUserRoleHistory(SavepointCase):
         Expected results :
             - no role history line created
         """
-        new_user = self.user_model.create({
-            'login': 'new_user',
-            'name': 'new_user',
-        })
-        history_lines = self.history_line_model.search([
-            ('user_id', '=', new_user.id)
-        ])
+        new_user = self.user_model.create({"login": "new_user", "name": "new_user"})
+        history_lines = self.history_line_model.search([("user_id", "=", new_user.id)])
         self.assertFalse(history_lines)