FitBenchmarking 1.1.0__tar.gz → 1.2.0__tar.gz

{fitbenchmarking-1.1.0 → fitbenchmarking-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: FitBenchmarking
-Version: 1.1.0
+Version: 1.2.0
 Summary: FitBenchmarking: A tool for comparing fitting software
 Project-URL: Homepage, https://fitbenchmarking.github.io
 Project-URL: Documentation, https://fitbenchmarking.readthedocs.io/en/stable
@@ -8,20 +8,19 @@ Project-URL: Repository, https://github.com/fitbenchmarking/fitbenchmarking
 Project-URL: Release Notes, https://github.com/fitbenchmarking/fitbenchmarking/releases
 Project-URL: Issues, https://github.com/fitbenchmarking/fitbenchmarking/issues
 Author: FitBenchmarkign Team
-License-File: LICENSE.txt
 Keywords: benchmark,comparison,fitting,least squares,optimisation
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7.1
-Requires-Dist: codecarbon>=2.3.4
+Requires-Python: >=3.9.1
+Requires-Dist: codecarbon<2.7,>=2.5.1
 Requires-Dist: configparser
 Requires-Dist: dash
 Requires-Dist: docutils
 Requires-Dist: jinja2
 Requires-Dist: lxml
 Requires-Dist: matplotlib>=2.0
-Requires-Dist: numpy<1.24
+Requires-Dist: numpy
 Requires-Dist: pandas>=1.3
 Requires-Dist: plotly>=5.0.0
 Requires-Dist: scipy>=0.18
@@ -31,18 +30,15 @@ Requires-Dist: bumps>=0.9.0; extra == 'bumps'
 Provides-Extra: dev
 Requires-Dist: coverage[toml]>=6.3; extra == 'dev'
 Requires-Dist: coveralls; extra == 'dev'
-Requires-Dist: flake8==3.9.2; extra == 'dev'
 Requires-Dist: iminuit>=2.25.2; extra == 'dev'
 Requires-Dist: pandas; extra == 'dev'
 Requires-Dist: parameterized; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
-Requires-Dist: pylint-exit; extra == 'dev'
-Requires-Dist: pylint==2.9.5; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
 Provides-Extra: dfo
 Requires-Dist: dfo-ls; extra == 'dfo'
-Requires-Dist: dfogn; extra == 'dfo'
 Provides-Extra: gofit
 Requires-Dist: gofit; extra == 'gofit'
 Provides-Extra: gradient-free
@@ -72,21 +68,22 @@ Requires-Dist: sasmodels; extra == 'sas'
 Requires-Dist: tinycc; (platform_system == 'Windows') and extra == 'sas'
 Description-Content-Type: text/markdown
 
-[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.1.0)
-[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.1.0)
-[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.1.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.1.0)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.2.0)
+[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.2.0)
+[![Install Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/install.yml?label=install&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/install.yml)
+[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.2.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.2.0)
 [![Coverage Status](https://img.shields.io/coveralls/github/fitbenchmarking/fitbenchmarking.svg?style=flat-square)](https://coveralls.io/github/fitbenchmarking/fitbenchmarking)
 [![Chat](https://img.shields.io/badge/chat-CompareFitMinimizers-lightgrey.svg?style=flat-square&logo=slack)](https://slack.com/)
-[![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.6597790-blue.svg?style=flat-square)](https://doi.org/10.5281/zenodo.6597790)
+[![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.11198140-blue.svg?style=flat-square)](https://doi.org/10.5281/zenodo.11198140)
 [![JOSS](https://img.shields.io/badge/JOSS-10.21105/joss.03127-brightgreen.svg?style=flat-square)](https://doi.org/10.21105/joss.03127)
 # FitBenchmarking
 
-FitBenchmarking is an open source tool for comparing different minimizers/fitting frameworks. FitBenchmarking is cross platform and we support Windows, Linux and Mac OS. For questions, feature requests or any other inquiries, please open an issue on GitHub, or send us an e-mail at support@fitbenchmarking.com.
+FitBenchmarking is an open source tool for comparing different minimizers/fitting frameworks. FitBenchmarking is cross platform and we support Windows, Linux and Mac OS. For questions, feature requests or any other inquiries, please open an issue on GitHub.
 
-- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.1.0/users/install_instructions/index.html
-- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.1.0/users/index.html
-- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.1.0/contributors/guidelines.html
-- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.1.0/users/tests.html
+- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.2.0/users/install_instructions/index.html
+- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.2.0/users/index.html
+- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.2.0/contributors/guidelines.html
+- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.2.0/users/tests.html
 
 The package is the result of a collaboration between STFC’s Scientific Computing Department and ISIS Neutron and Muon Facility and the Diamond Light Source. We also would like to acknowledge support from:
 

{fitbenchmarking-1.1.0 → fitbenchmarking-1.2.0}/README.md

@@ -1,18 +1,19 @@
-[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.1.0)
-[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.1.0)
-[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.1.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.1.0)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/release.yml?style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/release.yml?query=branch%3Av1.2.0)
+[![Tests Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/main.yml?label=tests&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/main.yml?query=branch%3Av1.2.0)
+[![Install Status](https://img.shields.io/github/actions/workflow/status/fitbenchmarking/fitbenchmarking/install.yml?label=install&style=flat-square)](https://github.com/fitbenchmarking/fitbenchmarking/actions/workflows/install.yml)
+[![Documentation Status](https://img.shields.io/readthedocs/fitbenchmarking/v1.2.0?style=flat-square)](https://fitbenchmarking.readthedocs.io/en/v1.2.0)
 [![Coverage Status](https://img.shields.io/coveralls/github/fitbenchmarking/fitbenchmarking.svg?style=flat-square)](https://coveralls.io/github/fitbenchmarking/fitbenchmarking)
 [![Chat](https://img.shields.io/badge/chat-CompareFitMinimizers-lightgrey.svg?style=flat-square&logo=slack)](https://slack.com/)
-[![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.6597790-blue.svg?style=flat-square)](https://doi.org/10.5281/zenodo.6597790)
+[![Zenodo](https://img.shields.io/badge/Zenodo-10.5281/zenodo.11198140-blue.svg?style=flat-square)](https://doi.org/10.5281/zenodo.11198140)
 [![JOSS](https://img.shields.io/badge/JOSS-10.21105/joss.03127-brightgreen.svg?style=flat-square)](https://doi.org/10.21105/joss.03127)
 # FitBenchmarking
 
-FitBenchmarking is an open source tool for comparing different minimizers/fitting frameworks. FitBenchmarking is cross platform and we support Windows, Linux and Mac OS. For questions, feature requests or any other inquiries, please open an issue on GitHub, or send us an e-mail at support@fitbenchmarking.com.
+FitBenchmarking is an open source tool for comparing different minimizers/fitting frameworks. FitBenchmarking is cross platform and we support Windows, Linux and Mac OS. For questions, feature requests or any other inquiries, please open an issue on GitHub.
 
-- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.1.0/users/install_instructions/index.html
-- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.1.0/users/index.html
-- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.1.0/contributors/guidelines.html
-- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.1.0/users/tests.html
+- **Installation Instructions:** https://fitbenchmarking.readthedocs.io/en/v1.2.0/users/install_instructions/index.html
+- **User Documentation & Example Usage:** https://fitbenchmarking.readthedocs.io/en/v1.2.0/users/index.html
+- **Community Guidelines:** https://fitbenchmarking.readthedocs.io/en/v1.2.0/contributors/guidelines.html
+- **Automated Tests:** Run via GitHub Actions, https://github.com/fitbenchmarking/fitbenchmarking/actions, and tests are documented at https://fitbenchmarking.readthedocs.io/en/v1.2.0/users/tests.html
 
 The package is the result of a collaboration between STFC’s Scientific Computing Department and ISIS Neutron and Muon Facility and the Diamond Light Source. We also would like to acknowledge support from:
 

{fitbenchmarking-1.1.0 → fitbenchmarking-1.2.0}/fitbenchmarking/__main__.py

@@ -2,7 +2,8 @@
 Main entry point for fitbenchmarking.
 This allows the package to be called on the command line.
 """
+
 from fitbenchmarking.cli.main import main
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

{fitbenchmarking-1.1.0 → fitbenchmarking-1.2.0}/fitbenchmarking/cli/checkpoint_handler.py

@@ -5,6 +5,7 @@ For more information on usage type fitbenchmarking --help
 or for more general information, see the online docs at
 docs.fitbenchmarking.com.
 """
+
 import json
 import os
 import sys
@@ -12,8 +13,11 @@ import textwrap
 from argparse import ArgumentParser, RawDescriptionHelpFormatter
 
 from fitbenchmarking.cli.exception_handler import exception_handler
-from fitbenchmarking.core.results_output import (create_index_page,
-                                                 open_browser, save_results)
+from fitbenchmarking.core.results_output import (
+    create_index_page,
+    open_browser,
+    save_results,
+)
 from fitbenchmarking.utils.checkpoint import Checkpoint
 from fitbenchmarking.utils.options import find_options_file
 
@@ -27,84 +31,110 @@ def get_parser() -> ArgumentParser:
     """
 
     description = (
-        'This is a tool for working with checkpoint files generated during a '
-        'FitBenchmarking run.'
+        "This is a tool for working with checkpoint files generated during a "
+        "FitBenchmarking run."
     )
 
     parser = ArgumentParser(
-        prog='fitbenchmarking-cp', add_help=True, description=description,
-        formatter_class=RawDescriptionHelpFormatter)
-    parser.add_argument('-d', '--debug-mode',
-                        default=False,
-                        action='store_true',
-                        help='Enable debug mode (prints traceback).',)
+        prog="fitbenchmarking-cp",
+        add_help=True,
+        description=description,
+        formatter_class=RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "-d",
+        "--debug-mode",
+        default=False,
+        action="store_true",
+        help="Enable debug mode (prints traceback).",
+    )
 
     subparsers = parser.add_subparsers(
-        metavar='ACTION',
-        dest='subprog',
-        help='Which action should be performed? '
-             'For more information on options use '
-             '`fitbenchmarking-cp ACTION -h`')
+        metavar="ACTION",
+        dest="subprog",
+        help=(
+            "Which action should be performed? "
+            "For more information on options use "
+            "`fitbenchmarking-cp ACTION -h`"
+        ),
+    )
 
-    report_epilog = textwrap.dedent('''
+    report_epilog = textwrap.dedent("""
     Usage Examples:
 
         $ fitbenchmarking-cp report
         $ fitbenchmarking-cp report -o examples/options_template.ini
         $ fitbenchmarking-cp report -f results/checkpoint
-    ''')
+    """)
     report = subparsers.add_parser(
-        'report',
-        description='Generate a report from a checkpoint file',
-        help='Generate a report from a checkpoint file',
-        epilog=report_epilog)
-    report.add_argument('-f', '--filename',
-                        metavar='CHECKPOINT_FILE',
-                        default='',
-                        help='The path to a fitbenchmarking checkpoint file. '
-                             'If omitted, this will be taken from the options '
-                             'file.')
-    report.add_argument('-o', '--options-file',
-                        metavar='OPTIONS_FILE',
-                        default='',
-                        help='The path to a fitbenchmarking options file')
-
-    merge_epilog = textwrap.dedent('''
+        "report",
+        description="Generate a report from a checkpoint file",
+        help="Generate a report from a checkpoint file",
+        epilog=report_epilog,
+    )
+    report.add_argument(
+        "-f",
+        "--filename",
+        metavar="CHECKPOINT_FILE",
+        default="",
+        help=(
+            "The path to a fitbenchmarking checkpoint file. "
+            "If omitted, this will be taken from the options file."
+        ),
+    )
+    report.add_argument(
+        "-o",
+        "--options-file",
+        metavar="OPTIONS_FILE",
+        default="",
+        help="The path to a fitbenchmarking options file",
+    )
+
+    merge_epilog = textwrap.dedent("""
     Usage Examples:
 
         $ fitbenchmarking-cp merge -f old_results/checkpoint.json \
 to_add/checkpoint.json
         $ fitbenchmarking-cp merge -f cp1 cp2 cp3 cp4 -o \
 new_results/checkpoint.json
-    ''')
+    """)
     merge_parser = subparsers.add_parser(
-        'merge',
-        description='Merge multiple checkpoint files into one',
-        help='Merge multiple checkpoint files into one',
-        epilog=merge_epilog)
-    merge_parser.add_argument('-f', '--files',
-                              metavar='FILES',
-                              nargs='+',
-                              help='The checkpoint files to merge'
-                              )
-    merge_parser.add_argument('-o', '--output-filename',
-                              metavar='OUTPUT',
-                              default='checkpoint.json',
-                              help='The name of the merged checkpoint file')
+        "merge",
+        description="Merge multiple checkpoint files into one",
+        help="Merge multiple checkpoint files into one",
+        epilog=merge_epilog,
+    )
+    merge_parser.add_argument(
+        "-f",
+        "--files",
+        metavar="FILES",
+        nargs="+",
+        help="The checkpoint files to merge",
+    )
+    merge_parser.add_argument(
+        "-o",
+        "--output-filename",
+        metavar="OUTPUT",
+        default="checkpoint.json",
+        help="The name of the merged checkpoint file",
+    )
     merge_parser.add_argument(
-        '-s', '--strategy',
-        metavar='STRATEGY',
-        default='first',
-        choices=['first', 'last', 'accuracy', 'runtime', 'emissions'],
-        help='The merge strategy to use when dealing with conflicts.'
-             'Selecting accuracy, emissions, or runtime will select for the '
-             'lowest from conflicting runs.')
+        "-s",
+        "--strategy",
+        metavar="STRATEGY",
+        default="first",
+        choices=["first", "last", "accuracy", "runtime", "energy"],
+        help=(
+            "The merge strategy to use when dealing with conflicts. "
+            "Selecting accuracy, energy, or runtime will select for the "
+            "lowest from conflicting runs."
+        ),
+    )
     return parser
 
 
 @exception_handler
-def generate_report(options_file='', additional_options=None, debug=False):
-    # pylint: disable=unused-argument
+def generate_report(options_file="", additional_options=None, debug=False):
     """
     Generate the fitting reports and tables for a checkpoint file.
 
@@ -118,21 +148,24 @@ def generate_report(options_file='', additional_options=None, debug=False):
     if additional_options is None:
         additional_options = {}
 
-    options = find_options_file(options_file=options_file,
-                                additional_options=additional_options)
+    options = find_options_file(
+        options_file=options_file, additional_options=additional_options
+    )
 
     checkpoint = Checkpoint(options=options)
-    results, unselected_minimizers, failed_problems = checkpoint.load()
+    results, unselected_minimizers, failed_problems, config = checkpoint.load()
 
     all_dirs = []
     pp_dfs_all_prob_sets = {}
-    for label in results:  # pylint: disable=consider-using-dict-items
+    for label in results:
         directory, pp_dfs = save_results(
             group_name=label,
             results=results[label],
             options=options,
             failed_problems=failed_problems[label],
-            unselected_minimizers=unselected_minimizers[label])
+            unselected_minimizers=unselected_minimizers[label],
+            config=config,
+        )
 
         pp_dfs_all_prob_sets[label] = pp_dfs
 
@@ -144,10 +177,12 @@ def generate_report(options_file='', additional_options=None, debug=False):
 
 
 @exception_handler
-def merge_data_sets(files: 'list[str]', output: 'str',
-                    strategy: 'str' = 'first',
-                    debug: 'bool' = False):
-    # pylint: disable=unused-argument
+def merge_data_sets(
+    files: list[str],
+    output: str,
+    strategy: str = "first",
+    debug: bool = False,
+):
     """
     Combine multiple checkpoint files into one following these rules:
      1) The output will be the same as combining them one at a time in
@@ -205,16 +240,16 @@ def merge_data_sets(files: 'list[str]', output: 'str',
         return
 
     print(f"Loading {files[0]}...")
-    with open(files[0], 'r', encoding='utf-8') as f:
+    with open(files[0], encoding="utf-8") as f:
         A = json.load(f)
     for to_merge in files[1:]:
         print(f"Merging {to_merge}...")
-        with open(to_merge, 'r', encoding='utf-8') as f:
+        with open(to_merge, encoding="utf-8") as f:
             B = json.load(f)
         A = merge(A, B, strategy=strategy)
 
-    print(f'Writing to {output}...')
-    with open(output, 'w', encoding='utf-8') as f:
+    print(f"Writing to {output}...")
+    with open(output, "w", encoding="utf-8") as f:
         json.dump(A, f, indent=2)
 
 
@@ -233,28 +268,31 @@ def merge(A, B, strategy):
     :return: The merged checkpoint data.
     :rtype: dict[str, any]
     """
-    if strategy == 'last':
+    if strategy == "last":
         A, B = B, A
     for k in B:
         if k not in A:
             A[k] = B[k]
             continue
-        A[k]['problems'], update_names = merge_problems(A[k]['problems'],
-                                                        B[k]['problems'])
+        A[k]["problems"], update_names = merge_problems(
+            A[k]["problems"], B[k]["problems"]
+        )
         if update_names:
-            for r in B[k]['results']:
-                if r['name'] in update_names:
-                    r['name'] = update_names[r['name']]
-        A[k]['results'] = merge_results(A[k]['results'], B[k]['results'],
-                                        strategy=strategy)
-        A[k]['failed_problems'] = []
-        A[k]['unselected_minimisers'] = {r['software_tag']: []
-                                         for r in A[k]['results']}
+            for r in B[k]["results"]:
+                if r["name"] in update_names:
+                    r["name"] = update_names[r["name"]]
+        A[k]["results"] = merge_results(
+            A[k]["results"], B[k]["results"], strategy=strategy
+        )
+        A[k]["failed_problems"] = []
+        A[k]["unselected_minimisers"] = {
+            r["software_tag"]: [] for r in A[k]["results"]
+        }
 
     return A
 
 
-def merge_problems(A: 'dict[str, dict]', B: 'dict[str, dict]'):
+def merge_problems(A: dict[str, dict], B: dict[str, dict]):
     """
     Merge the problem sections of 2 checkpoint files.
     If problems have matching names but different values, the problem from
@@ -276,26 +314,28 @@ def merge_problems(A: 'dict[str, dict]', B: 'dict[str, dict]'):
     for k, prob in B.items():
         # Handle case where A/B contains k, k*, k**, ... from previous merges
         orig_k = k
-        k = k.rstrip('*')
-        prob['name'] = prob['name'].rstrip('*')
-        prob['problem_tag'] = prob['problem_tag'].rstrip('*')
+        k = k.rstrip("*")
+        prob["name"] = prob["name"].rstrip("*")
+        prob["problem_tag"] = prob["problem_tag"].rstrip("*")
         while k in A:
             A_prob = A[k]
             # Identical - take problem from A
-            if (A_prob['ini_params'] == prob['ini_params']
-                    and A_prob['ini_y'] == prob['ini_y']
-                    and A_prob['x'] == prob['x']
-                    and A_prob['y'] == prob['y']
-                    and A_prob['e'] == prob['e']):
+            if (
+                A_prob["ini_params"] == prob["ini_params"]
+                and A_prob["ini_y"] == prob["ini_y"]
+                and A_prob["x"] == prob["x"]
+                and A_prob["y"] == prob["y"]
+                and A_prob["e"] == prob["e"]
+            ):
                 if orig_k != k:
                     update_keys[orig_k] = k
                 break
 
             # Agree on name but aren't identical
-            name_change = '{}*'
+            name_change = "{}*"
             k = name_change.format(k)
-            prob['name'] = name_change.format(prob['name'])
-            prob['problem_tag'] = name_change.format(prob['problem_tag'])
+            prob["name"] = name_change.format(prob["name"])
+            prob["problem_tag"] = name_change.format(prob["problem_tag"])
 
         else:  # k not in A (no break called)
             A[k] = prob
@@ -306,7 +346,7 @@ def merge_problems(A: 'dict[str, dict]', B: 'dict[str, dict]'):
     return A, update_keys
 
 
-def merge_results(A: 'list[dict]', B: 'list[dict]', strategy: str):
+def merge_results(A: list[dict], B: list[dict], strategy: str):
     """
     Merge the results sections of 2 checkpoint files.
 
@@ -321,24 +361,29 @@ def merge_results(A: 'list[dict]', B: 'list[dict]', strategy: str):
     :return: Merged results list
     :rtype: list[dict[str, any]]
     """
-    def key_gen(k: 'dict'):
+
+    def key_gen(k: dict):
         """
         Get a uid for a result entry in cp file.
         """
-        return (k['name'],
-                k['software_tag'],
-                k['minimizer_tag'],
-                k['jacobian_tag'],
-                k['hessian_tag'],
-                k['costfun_tag'])
+        return (
+            k["name"],
+            k["software_tag"],
+            k["minimizer_tag"],
+            k["jacobian_tag"],
+            k["hessian_tag"],
+            k["costfun_tag"],
+        )
 
     A_key = {key_gen(r): i for i, r in enumerate(A)}
 
     for res in B:
         key = key_gen(res)
         if key in A_key:
-            if (strategy in ['accuracy', 'emissions', 'runtime']
-                    and A[A_key[key]][strategy] > res[strategy]):
+            if (
+                strategy in ["accuracy", "energy", "runtime"]
+                and A[A_key[key]][strategy] > res[strategy]
+            ):
                 A[A_key[key]] = res
         else:
             A_key[key] = len(A)
@@ -357,18 +402,20 @@ def main():
 
     additional_options = {}
 
-    if args.subprog == 'report':
+    if args.subprog == "report":
         if args.filename:
-            additional_options['checkpoint_filename'] = args.filename
-        generate_report(args.options_file,
-                        additional_options,
-                        debug=args.debug_mode)
-    elif args.subprog == 'merge':
-        merge_data_sets(files=args.files,
-                        output=args.output_filename,
-                        strategy=args.strategy,
-                        debug=args.debug_mode)
-
-
-if __name__ == '__main__':
+            additional_options["checkpoint_filename"] = args.filename
+        generate_report(
+            args.options_file, additional_options, debug=args.debug_mode
+        )
+    elif args.subprog == "merge":
+        merge_data_sets(
+            files=args.files,
+            output=args.output_filename,
+            strategy=args.strategy,
+            debug=args.debug_mode,
+        )
+
+
+if __name__ == "__main__":
     main()

{fitbenchmarking-1.1.0 → fitbenchmarking-1.2.0}/fitbenchmarking/cli/exception_handler.py

@@ -3,8 +3,8 @@ This file holds an exception handler decorator that should wrap all cli
 functions to provide cleaner output.
 """
 
-from functools import wraps
 import sys
+from functools import wraps
 
 from fitbenchmarking.utils import exceptions
 from fitbenchmarking.utils.log import get_logger
@@ -13,7 +13,6 @@ LOGGER = get_logger()
 
 
 def exception_handler(f):
-    # pylint: disable=W0703
     """
     Decorator to simplify handling exceptions within FitBenchmarking
     This will strip off any 'debug' inputs.
@@ -21,16 +20,18 @@ def exception_handler(f):
     :param f: The function to wrap
     :type f: python function
     """
+
     @wraps(f)
     def wrapped(*args, **kwargs):
-        debug = kwargs.get('debug', False)
+        debug = kwargs.get("debug", False)
 
         try:
             return f(*args, **kwargs)
         except exceptions.FitBenchmarkException as e:
-
-            LOGGER.error('Error while running FitBenchmarking. Exiting. '
-                         'See below for more information.')
+            LOGGER.error(
+                "Error while running FitBenchmarking. Exiting. "
+                "See below for more information."
+            )
             if debug:
                 raise
 
@@ -38,7 +39,7 @@ def exception_handler(f):
             sys.exit(1)
 
         except Exception as e:
-            LOGGER.error('Unknown exception. Exiting.')
+            LOGGER.error("Unknown exception. Exiting.")
             if debug:
                 raise