change name of metadata_pathspec_file to runner_attribute_file

Author: madhur-ob

metaflow/cli.py

@@ -559,11 +559,11 @@ def common_run_options(func):
         help="Write the ID of this run to the file specified.",
     )
     @click.option(
-        "--metadata-pathspec-file",
+        "--runner-attribute-file",
         default=None,
         show_default=True,
         type=str,
-        help="Write the metadata and pathspec of this run to the file specified.",
+        help="Write the metadata and pathspec of this run to the file specified. Used internally for Metaflow's Runner API.",
     )
     @wraps(func)
     def wrapper(*args, **kwargs):
@@ -623,7 +623,7 @@ def resume(
     decospecs=None,
     run_id_file=None,
     resume_identifier=None,
-    metadata_pathspec_file=None,
+    runner_attribute_file=None,
 ):
     before_run(obj, tags, decospecs + obj.environment.decospecs())
 
@@ -684,7 +684,7 @@ def resume(
 
     runtime.persist_constants()
     write_file(
-        metadata_pathspec_file,
+        runner_attribute_file,
         "%s:%s" % (get_metadata(), "/".join((obj.flow.name, runtime.run_id))),
     )
     if clone_only:
@@ -717,7 +717,7 @@ def run(
     max_log_size=None,
     decospecs=None,
     run_id_file=None,
-    metadata_pathspec_file=None,
+    runner_attribute_file=None,
     user_namespace=None,
     **kwargs
 ):
@@ -747,7 +747,7 @@ def run(
     runtime.print_workflow_info()
     runtime.persist_constants()
     write_file(
-        metadata_pathspec_file,
+        runner_attribute_file,
         "%s:%s" % (get_metadata(), "/".join((obj.flow.name, runtime.run_id))),
     )
     runtime.execute()

metaflow/runner/metaflow_runner.py

@@ -290,19 +290,19 @@ def run(self, show_output: bool = False, **kwargs) -> ExecutingRun:
             ExecutingRun object for this run.
         """
         with tempfile.TemporaryDirectory() as temp_dir:
-            tfp_metadata_pathspec = tempfile.NamedTemporaryFile(
+            tfp_runner_attribute = tempfile.NamedTemporaryFile(
                 dir=temp_dir, delete=False
             )
             command = self.api(**self.top_level_kwargs).run(
-                metadata_pathspec_file=tfp_metadata_pathspec.name, **kwargs
+                runner_attribute_file=tfp_runner_attribute.name, **kwargs
             )
 
             pid = self.spm.run_command(
                 [sys.executable, *command], env=self.env_vars, show_output=show_output
             )
             command_obj = self.spm.get(pid)
 
-            return self.__get_executing_run(tfp_metadata_pathspec, command_obj)
+            return self.__get_executing_run(tfp_runner_attribute, command_obj)
 
     def resume(self, show_output: bool = False, **kwargs):
         """
@@ -327,19 +327,19 @@ def resume(self, show_output: bool = False, **kwargs):
             ExecutingRun object for this resumed run.
         """
         with tempfile.TemporaryDirectory() as temp_dir:
-            tfp_metadata_pathspec = tempfile.NamedTemporaryFile(
+            tfp_runner_attribute = tempfile.NamedTemporaryFile(
                 dir=temp_dir, delete=False
             )
             command = self.api(**self.top_level_kwargs).resume(
-                metadata_pathspec_file=tfp_metadata_pathspec.name, **kwargs
+                runner_attribute_file=tfp_runner_attribute.name, **kwargs
             )
 
             pid = self.spm.run_command(
                 [sys.executable, *command], env=self.env_vars, show_output=show_output
             )
             command_obj = self.spm.get(pid)
 
-            return self.__get_executing_run(tfp_metadata_pathspec, command_obj)
+            return self.__get_executing_run(tfp_runner_attribute, command_obj)
 
     async def async_run(self, **kwargs) -> ExecutingRun:
         """
@@ -358,11 +358,11 @@ async def async_run(self, **kwargs) -> ExecutingRun:
             ExecutingRun object for this run.
         """
         with tempfile.TemporaryDirectory() as temp_dir:
-            tfp_metadata_pathspec = tempfile.NamedTemporaryFile(
+            tfp_runner_attribute = tempfile.NamedTemporaryFile(
                 dir=temp_dir, delete=False
             )
             command = self.api(**self.top_level_kwargs).run(
-                metadata_pathspec_file=tfp_metadata_pathspec.name, **kwargs
+                runner_attribute_file=tfp_runner_attribute.name, **kwargs
             )
 
             pid = await self.spm.async_run_command(
@@ -371,7 +371,7 @@ async def async_run(self, **kwargs) -> ExecutingRun:
             )
             command_obj = self.spm.get(pid)
 
-            return self.__get_executing_run(tfp_metadata_pathspec, command_obj)
+            return self.__get_executing_run(tfp_runner_attribute, command_obj)
 
     async def async_resume(self, **kwargs):
         """
@@ -390,11 +390,11 @@ async def async_resume(self, **kwargs):
             ExecutingRun object for this resumed run.
         """
         with tempfile.TemporaryDirectory() as temp_dir:
-            tfp_metadata_pathspec = tempfile.NamedTemporaryFile(
+            tfp_runner_attribute = tempfile.NamedTemporaryFile(
                 dir=temp_dir, delete=False
             )
             command = self.api(**self.top_level_kwargs).resume(
-                metadata_pathspec_file=tfp_metadata_pathspec.name, **kwargs
+                runner_attribute_file=tfp_runner_attribute.name, **kwargs
             )
 
             pid = await self.spm.async_run_command(
@@ -403,7 +403,7 @@ async def async_resume(self, **kwargs):
             )
             command_obj = self.spm.get(pid)
 
-            return self.__get_executing_run(tfp_metadata_pathspec, command_obj)
+            return self.__get_executing_run(tfp_runner_attribute, command_obj)
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.spm.cleanup()