From a6d7f9202b78bad9571e26b3cbe47f29f88ee3a3 Mon Sep 17 00:00:00 2001
From: Patrick Peglar <patrick.peglar@metoffice.gov.uk>
Date: Wed, 16 Feb 2022 08:49:06 +0000
Subject: [PATCH 1/3] Utility class in netcdf loader should not be public.

---
 lib/iris/fileformats/netcdf.py | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/lib/iris/fileformats/netcdf.py b/lib/iris/fileformats/netcdf.py
index 73a137b4af..de487092c9 100644
--- a/lib/iris/fileformats/netcdf.py
+++ b/lib/iris/fileformats/netcdf.py
@@ -570,13 +570,20 @@ def _get_cf_var_data(cf_var, filename):
     return as_lazy_data(proxy, chunks=chunks)
 
 
-class OrderedAddableList(list):
-    # Used purely in actions debugging, to accumulate a record of which actions
-    # were activated.
-    # It replaces a set, so as to record the ordering of operations, with
-    # possible repeats, and it also numbers the entries.
-    # Actions routines invoke the 'add' method, which thus effectively converts
-    # a set.add into a list.append.
+class _OrderedAddableList(list):
+    """
+    A custom container object for actions recording.
+    
+    Used purely in actions debugging, to accumulate a record of which actions
+    were activated.
+
+    It replaces a set, so as to preserve the ordering of operations, with
+    possible repeats, and it also numbers the entries.
+
+    The actions routines invoke an 'add' method, so this effectively replaces
+    a set.add with a list.append.
+
+    """
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._n_add = 0
@@ -602,7 +609,7 @@ def _load_cube(engine, cf, cf_var, filename):
     engine.cube = cube
     engine.cube_parts = {}
     engine.requires = {}
-    engine.rule_triggered = OrderedAddableList()
+    engine.rule_triggered = _OrderedAddableList()
     engine.filename = filename
 
     # Assert all the case-specific facts.

From dbb54c13b64030649e17b333764a9164cb872329 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Wed, 16 Feb 2022 09:10:38 +0000
Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
---
 lib/iris/fileformats/netcdf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/iris/fileformats/netcdf.py b/lib/iris/fileformats/netcdf.py
index de487092c9..dfc99ca005 100644
--- a/lib/iris/fileformats/netcdf.py
+++ b/lib/iris/fileformats/netcdf.py
@@ -573,7 +573,7 @@ def _get_cf_var_data(cf_var, filename):
 class _OrderedAddableList(list):
     """
     A custom container object for actions recording.
-    
+
     Used purely in actions debugging, to accumulate a record of which actions
     were activated.
 
@@ -584,6 +584,7 @@ class _OrderedAddableList(list):
     a set.add with a list.append.
 
     """
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._n_add = 0

From d4dd4e1551313eadadc39680db213661e8c1b6e2 Mon Sep 17 00:00:00 2001
From: Patrick Peglar <patrick.peglar@metoffice.gov.uk>
Date: Wed, 16 Feb 2022 09:14:48 +0000
Subject: [PATCH 3/3] Rename container for better clarity.

---
 lib/iris/fileformats/_nc_load_rules/actions.py | 4 ++--
 lib/iris/fileformats/netcdf.py                 | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/lib/iris/fileformats/_nc_load_rules/actions.py b/lib/iris/fileformats/_nc_load_rules/actions.py
index d286abbf3d..4c5184deb1 100644
--- a/lib/iris/fileformats/_nc_load_rules/actions.py
+++ b/lib/iris/fileformats/_nc_load_rules/actions.py
@@ -18,7 +18,7 @@
 
 3) Iris-specific info is (still) stored in additional properties created on
    the engine object :
-       engine.cf_var, .cube, .cube_parts, .requires, .rule_triggered, .filename
+       engine.cf_var, .cube, .cube_parts, .requires, .rules_triggered, .filename
 
 Our "rules" are just action routines.
 The top-level 'run_actions' routine decides which actions to call, based on the
@@ -78,7 +78,7 @@ def inner(engine, *args, **kwargs):
             # but also may vary depending on whether it successfully
             # triggered, and if so what it matched.
             rule_name = _default_rulenamesfunc(func.__name__)
-        engine.rule_triggered.add(rule_name)
+        engine.rules_triggered.add(rule_name)
 
     func._rulenames_func = _default_rulenamesfunc
     return inner
diff --git a/lib/iris/fileformats/netcdf.py b/lib/iris/fileformats/netcdf.py
index dfc99ca005..290cacf6fc 100644
--- a/lib/iris/fileformats/netcdf.py
+++ b/lib/iris/fileformats/netcdf.py
@@ -498,7 +498,7 @@ def _actions_activation_stats(engine, cf_name):
 
     print("Rules Triggered:")
 
-    for rule in sorted(list(engine.rule_triggered)):
+    for rule in sorted(list(engine.rules_triggered)):
         print("\t%s" % rule)
 
     print("Case Specific Facts:")
@@ -610,7 +610,7 @@ def _load_cube(engine, cf, cf_var, filename):
     engine.cube = cube
     engine.cube_parts = {}
     engine.requires = {}
-    engine.rule_triggered = _OrderedAddableList()
+    engine.rules_triggered = _OrderedAddableList()
     engine.filename = filename
 
     # Assert all the case-specific facts.