From 93f93399c17bc3c62aa47bbc95d0ac3e0677ac97 Mon Sep 17 00:00:00 2001
From: Patrick Ogenstad <patrick@ogenstad.com>
Date: Fri, 14 Jun 2024 16:15:47 +0200
Subject: [PATCH] Add property for optional runner (#913)

* Add property for optional runner

* Add method to clone parameters with private attribute

---------

Co-authored-by: David Barroso <dbarrosop@dravetech.com>
---
 nornir/core/__init__.py | 27 +++++++++++++++++++++++----
 setup.cfg               |  1 -
 2 files changed, 23 insertions(+), 5 deletions(-)

diff --git a/nornir/core/__init__.py b/nornir/core/__init__.py
index 0eec15f6..18f9c618 100644
--- a/nornir/core/__init__.py
+++ b/nornir/core/__init__.py
@@ -4,6 +4,7 @@
 from typing import Any, Callable, Dict, Generator, List, Optional, Type
 
 from nornir.core.configuration import Config
+from nornir.core.exceptions import PluginNotRegistered
 from nornir.core.inventory import Inventory
 from nornir.core.plugins.runners import RunnerPlugin
 from nornir.core.processor import Processor, Processors
@@ -43,7 +44,7 @@ def __init__(
         self.inventory = inventory
         self.config = config or Config()
         self.processors = processors or Processors()
-        self.runner = runner
+        self._runner = runner
 
     def __enter__(self) -> "Nornir":
         return self
@@ -61,14 +62,16 @@ def with_processors(self, processors: List[Processor]) -> "Nornir":
         Given a list of Processor objects return a copy of the nornir object with the processors
         assigned to the copy. The original object is left unmodified.
         """
-        return Nornir(**{**self.__dict__, **{"processors": Processors(processors)}})
+        return Nornir(
+            **{**self._clone_parameters(), **{"processors": Processors(processors)}}
+        )
 
     def with_runner(self, runner: RunnerPlugin) -> "Nornir":
         """
         Given a runner return a copy of the nornir object with the runner
         assigned to the copy. The original object is left unmodified.
         """
-        return Nornir(**{**self.__dict__, **{"runner": runner}})
+        return Nornir(**{**self._clone_parameters(), **{"runner": runner}})
 
     def filter(self, *args: Any, **kwargs: Any) -> "Nornir":
         """
@@ -77,7 +80,7 @@ def filter(self, *args: Any, **kwargs: Any) -> "Nornir":
         Returns:
             :obj:`Nornir`: A new object with same configuration as ``self`` but filtered inventory.
         """
-        b = Nornir(**self.__dict__)
+        b = Nornir(**self._clone_parameters())
         b.inventory = self.inventory.filter(*args, **kwargs)
         return b
 
@@ -165,6 +168,22 @@ def close_connections_task(task):
 
         self.run(task=close_connections_task, on_good=on_good, on_failed=on_failed)
 
+    @property
+    def runner(self) -> RunnerPlugin:
+        if self._runner:
+            return self._runner
+
+        raise PluginNotRegistered("Runner plugin not registered")
+
+    def _clone_parameters(self) -> Dict[str, Any]:
+        return {
+            "data": self.data,
+            "inventory": self.inventory,
+            "config": self.config,
+            "processors": self.processors,
+            "runner": self._runner,
+        }
+
     @classmethod
     def get_validators(cls) -> Generator[Callable[["Nornir"], "Nornir"], None, None]:
         yield cls.validate
diff --git a/setup.cfg b/setup.cfg
index bc69f979..656cba83 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -48,7 +48,6 @@ warn_redundant_casts = True
 [mypy-nornir.core]
 disallow_untyped_defs = False
 disallow_incomplete_defs = False
-strict_optional = False
 
 [mypy-tests.*]
 ignore_errors = True