fixup! [REF] util.domains: DRY model fields path code and helpers

Author: aj-fuentes

src/util/domains.py

@@ -33,7 +33,7 @@
     from openerp.tools.safe_eval import safe_eval
 
 from .const import NEARLYWARN
-from .helpers import _dashboard_actions, _resolve_model_fields_path, _validate_model
+from .helpers import _dashboard_actions, _validate_model, resolve_model_fields_path
 from .inherit import for_each_inherit
 from .misc import SelfPrintEvalContext
 from .pg import column_exists, get_value_or_en_translation, table_exists
@@ -163,7 +163,7 @@ def _model_of_path(cr, model, path):
     if not path:
         return model
     path = tuple(path)
-    resolved_parts = _resolve_model_fields_path(cr, model, path)
+    resolved_parts = resolve_model_fields_path(cr, model, path)
     if not resolved_parts:
         return None
     last_part = resolved_parts[-1]

src/util/fields.py

@@ -40,7 +40,7 @@ def make_index_name(table_name, column_name):
 from .const import ENVIRON
 from .domains import _adapt_one_domain, _replace_path, _valid_path_to, adapt_domains
 from .exceptions import SleepyDeveloperError
-from .helpers import _dashboard_actions, _resolve_model_fields_path, _validate_model, table_of_model
+from .helpers import _dashboard_actions, _validate_model, resolve_model_fields_path, table_of_model
 from .inherit import for_each_inherit
 from .misc import SelfPrintEvalContext, log_progress, version_gte
 from .orm import env, invalidate
@@ -79,7 +79,7 @@ def make_index_name(table_name, column_name):
 )
 
 
-def _get_resolved_ir_exports(cr, models=None, fields=None):
+def _getresolved_ir_exports(cr, models=None, fields=None):
     """
     Return a list of ir.exports.line records which models or fields match the given arguments.
 
@@ -122,7 +122,7 @@ def _get_resolved_ir_exports(cr, models=None, fields=None):
     # Resolve intermediate models for all model fields paths, filter only matching paths parts
     matching_paths_parts = {}
     for model, path in paths_to_line_ids:
-        resolved_paths = _resolve_model_fields_path(cr, model, path)
+        resolved_paths = resolve_model_fields_path(cr, model, path)
         if fields:
             matching_parts = [p for p in resolved_paths if (p.field_model, p.field_name) in fields]
         else:
@@ -151,7 +151,7 @@ def rename_ir_exports_fields(cr, models_fields_map):
 
     :meta private: exclude from online docs
     """
-    matching_exports = _get_resolved_ir_exports(
+    matching_exports = _getresolved_ir_exports(
         cr,
         fields=[(model, field) for model, fields_map in models_fields_map.items() for field in fields_map],
     )
@@ -192,7 +192,7 @@ def remove_ir_exports_lines(cr, models=None, fields=None):
 
     :meta private: exclude from online docs
     """
-    matching_exports = _get_resolved_ir_exports(cr, models=models, fields=fields)
+    matching_exports = _getresolved_ir_exports(cr, models=models, fields=fields)
     if not matching_exports:
         return
     _logger.debug("Deleting %d export template lines with removed models/fields", len(matching_exports))

src/util/helpers.py

@@ -221,18 +221,40 @@ def _get_theme_models():
     "FieldsPathPart",
     "model path part_index field_model field_name relation_model",
 )
+FieldsPathPart.__doc__ = """
+Encapsulate information about a field within a fields path.
 
+:param str model: model to resolve the fields ``path`` from
+:param typing.Sequence[str] path: fields path starting from ``model``
+:param int part_index: index of this field in ``path``
+:param str field_model: model of the field
+:param str field_name: name of the field
+:param str relation_model: target model of the field, if relational, otherwise ``None``
+"""
+for _f in FieldsPathPart._fields:
+    getattr(FieldsPathPart, _f).__doc__ = None
 
-def _resolve_model_fields_path(cr, model, path):
+
+def resolve_model_fields_path(cr, model, path):
     """
-    Resolve model fields paths (e.g. `hr.appraisal` `['employee_id', 'user_id', 'partner_id']`).
+    Resolve model fields paths.
+
+    This function returns a list of :class:`~odoo.upgrade.util.helpers.FieldsPathPart` where
+    each item describes the field in ``path`` (in the same order).
+
+    .. example::
+
+       To get the information about the fields path ``user_ids.partner_id.title_id``
+       from model `res.users`, we can call this function as
+
+       .. code-block:: python
 
-    :param str model: the model to resolve the fields ``path`` from.
-    :param typing.Sequence[str] path: the fields path starting from ``model``.
-    :return: a list of the resolved fields path parts through their relation models.
-    :rtype: list[FieldsPathPart]
+          resolve_model_fields_path(cr, "res.users", "user_ids.partner_id.title_id".split("."))
 
-    :meta private: exclude from online docs
+    :param str model: model to resolve the fields ``path`` from
+    :param typing.Sequence[str] path: fields path starting from ``model``
+    :return: list of resolved fields path parts
+    :rtype: list(:class:`~odoo.upgrade.util.helpers.FieldsPathPart`)
     """
     path = list(path)
     cr.execute(