Merge pull request #51 from NNPDF/folder_prefix

Add folder_prefix option

Author: Zaharid

src/reportengine/app.py

@@ -192,6 +192,12 @@ def argparser(self):
         parallel.add_argument('--no-parallel', dest='parallel',
                               action='store_false')
 
+        parser.add_argument(
+            '--folder-prefix',
+            action='store_true',
+            help="add a prefix derived from the runcard name to output resources.",
+        )
+
         parser.add_argument('-h', '--help', action=ArgumentHelpAction,
                             app=self)
 

src/reportengine/environment.py

@@ -33,6 +33,7 @@ class Environment:
     def __init__(self, *, output=None, formats=('pdf',),
                  default_figure_format=None, loglevel=logging.DEBUG,
                  config_yml = None,
+                 folder_prefix=False,
                  **kwargs):
         if output:
             self.output_path = pathlib.Path(output).absolute()
@@ -43,6 +44,11 @@ def __init__(self, *, output=None, formats=('pdf',),
         self.loglevel = loglevel
         self.extra_args = kwargs
         self.config_yml = config_yml
+        if folder_prefix and config_yml:
+            self.filename_prefix = pathlib.Path(config_yml).stem
+        else:
+            self.filename_prefix = None
+
 
     @property
     def figure_formats(self):
@@ -116,7 +122,7 @@ def ns_dump_description(cls):
         return dict(
             output_path = "Folder where the results are to be written.",
             config_rel_path = cls.config_rel_path.__doc__,
-
+            filename_prefix = "Prefix prepended to filenames",
         )
 
     def ns_dump(self):

src/reportengine/formattingtools.py

@@ -27,6 +27,9 @@ def get_nice_name(ns, nsspec, suffix=None):
     (see the ``namespaces`` documentation for more details)"""
     parts = []
     currspec = []
+    prefix = ns.get("filename_prefix", None)
+    if prefix:
+        parts.append(prefix)
     currns = ns
     for ele in nsspec:
         currspec.append(ele)