Black formatting

Author: Simon-Rey

preflibtools/instances/convert.py

@@ -1,5 +1,6 @@
 """ This module presents procedures to convert instances from one type to another.
 """
+
 from preflibtools.properties.pairwisecomparisons import pairwise_scores
 
 
@@ -23,11 +24,15 @@ def concatenate_elements_with_delimiter(*args, delimiter=","):
     num_unique = 0
     for alt_name1, score_dict in scores.items():
         for alt_name2, score in score_dict.items():
-            pairwise_relation += concatenate_elements_with_delimiter(score, alt_name1, alt_name2)
+            pairwise_relation += concatenate_elements_with_delimiter(
+                score, alt_name1, alt_name2
+            )
             num_unique += 1
             sum_vote_count += score
     pairwise_relation = pairwise_relation[:-1]
 
-    count_line = concatenate_elements_with_delimiter(instance.num_voters, sum_vote_count, num_unique)
+    count_line = concatenate_elements_with_delimiter(
+        instance.num_voters, sum_vote_count, num_unique
+    )
 
     return header + count_line + pairwise_relation

preflibtools/instances/dataset.py

@@ -1,18 +1,18 @@
 def read_info_file(info_file_path):
     tag_mapping = {
-        'Name:': 'name',
-        'Abbreviation:': 'abb',
-        'Tags:': 'tags',
-        'Series Number:': 'series',
-        'Publication Date:': 'publication_date',
-        'Description:': 'description',
-        'Required Citations:': 'citations',
-        'Selected Studies:': 'studies'
+        "Name:": "name",
+        "Abbreviation:": "abb",
+        "Tags:": "tags",
+        "Series Number:": "series",
+        "Publication Date:": "publication_date",
+        "Description:": "description",
+        "Required Citations:": "citations",
+        "Selected Studies:": "studies",
     }
 
-    infos = {'files': {}}
+    infos = {"files": {}}
 
-    with open(info_file_path, 'r', encoding="utf-8") as file:
+    with open(info_file_path, "r", encoding="utf-8") as file:
         line_cnt = 0
         lines = file.readlines()
         for line in lines:
@@ -22,22 +22,24 @@ def read_info_file(info_file_path):
 
             for tag, key in tag_mapping.items():
                 if line.startswith(tag):
-                    value = line[len(tag):].strip()
-                    if key == 'tags':
-                        infos[key] = [tag.strip() for tag in value.split(',')]
+                    value = line[len(tag) :].strip()
+                    if key == "tags":
+                        infos[key] = [tag.strip() for tag in value.split(",")]
                     else:
                         infos[key] = value
                     break
 
-            if line.startswith('file_name, modification_type, relates_to, title, description, publication_date'):
+            if line.startswith(
+                "file_name, modification_type, relates_to, title, description, publication_date"
+            ):
                 break
 
         for line in lines[line_cnt:]:
             line = line.strip()
             if line:
-                split_line = [part.strip() for part in line.split(',')]
+                split_line = [part.strip() for part in line.split(",")]
                 new_split_line = []
-                tmp_split = ''
+                tmp_split = ""
                 inside_quotes = False
 
                 for split in split_line:
@@ -47,7 +49,7 @@ def read_info_file(info_file_path):
                             new_split_line.append(tmp_split[:-3])
                             inside_quotes = False
                         else:
-                            tmp_split += ', '
+                            tmp_split += ", "
                     else:
                         if split.startswith('"""') and len(split) > 3:
                             if split.endswith('"""'):
@@ -58,16 +60,18 @@ def read_info_file(info_file_path):
                         else:
                             new_split_line.append(split)
                 new_file_info = {
-                    'file_name': new_split_line[0],
-                    'modification_type': new_split_line[1],
-                    'relates_to': new_split_line[2],
-                    'title': new_split_line[3],
-                    'description': new_split_line[4],
-                    'publication_date': new_split_line[5]
+                    "file_name": new_split_line[0],
+                    "modification_type": new_split_line[1],
+                    "relates_to": new_split_line[2],
+                    "title": new_split_line[3],
+                    "description": new_split_line[4],
+                    "publication_date": new_split_line[5],
                 }
 
                 file_name = new_split_line[0].strip()
-                infos['files'][file_name] = {key: value.strip() for key, value in new_file_info.items()}
+                infos["files"][file_name] = {
+                    key: value.strip() for key, value in new_file_info.items()
+                }
 
     return infos
 
@@ -76,10 +80,10 @@ def file_description_line(file_dict, headers):
     values = []
     for h in headers:
         value = str(file_dict[h])
-        if ',' in value:
+        if "," in value:
             value = f'"""{value}"""'
         values.append(value)
-    return ', '.join(values)
+    return ", ".join(values)
 
 
 def write_info_file(file_path, info_dict):
@@ -94,8 +98,14 @@ def write_info_file(file_path, info_dict):
         f.write(f"Selected Studies: {info_dict['studies']}\n\n")
 
         if info_dict["files"]:
-            headers = ["file_name", "modification_type", "relates_to", "title", "description", "publication_date"]
-            f.write(', '.join(headers) + "\n")
+            headers = [
+                "file_name",
+                "modification_type",
+                "relates_to",
+                "title",
+                "description",
+                "publication_date",
+            ]
+            f.write(", ".join(headers) + "\n")
             for file_descr in sorted(info_dict["files"], key=lambda x: x["file_name"]):
                 f.write(file_description_line(file_descr, headers) + "\n")
-

preflibtools/instances/preflibinstance/__init__.py

@@ -9,5 +9,5 @@
     "get_parsed_instance",
     "CategoricalInstance",
     "MatchingInstance",
-    "OrdinalInstance"
-]
+    "OrdinalInstance",
+]

preflibtools/instances/preflibinstance/categorical.py

@@ -326,4 +326,3 @@ def __str__(self):
         return "Categorical-Instance: {} <{},{}>".format(
             self.file_name, self.num_voters, self.num_alternatives
         )
-

preflibtools/instances/preflibinstance/comparison.py

@@ -6,4 +6,3 @@ class ComparisonInstance(PrefLibInstance):
 
     def __init__(self):
         PrefLibInstance.__init__(self)
-

preflibtools/instances/preflibinstance/instance.py

@@ -1,5 +1,6 @@
 """ This module describes the main class to deal with PrefLib instances..
 """
+
 import os.path
 from os import path
 
@@ -104,7 +105,9 @@ def parse_file(self, filepath, autocorrect=False, header_only=False):
 
         self.parse_lines(lines, autocorrect=autocorrect, header_only=header_only)
 
-    def parse_str(self, string, data_type, file_name="", autocorrect=False, header_only=False):
+    def parse_str(
+        self, string, data_type, file_name="", autocorrect=False, header_only=False
+    ):
         """Parses the string provided as argument and populates the PreflibInstance object accordingly.
         The parser to be used is deduced from the file extension passed as argument.
 
@@ -125,7 +128,9 @@ def parse_str(self, string, data_type, file_name="", autocorrect=False, header_o
         self.file_name = file_name
         self.data_type = data_type
 
-        self.parse_lines(string.splitlines(), autocorrect=autocorrect, header_only=header_only)
+        self.parse_lines(
+            string.splitlines(), autocorrect=autocorrect, header_only=header_only
+        )
 
     def parse_url(self, url, autocorrect=False, header_only=False):
         """Parses the file located at the provided URL and populates the PreflibInstance object accordingly.

preflibtools/instances/preflibinstance/matching.py

@@ -83,7 +83,7 @@ def __str__(self):
 
 
 class MatchingInstance(PrefLibInstance, WeightedDiGraph):
-    """This is the class representing a PrefLib instance for matching preferences. It basically 
+    """This is the class representing a PrefLib instance for matching preferences. It basically
     contains the data and information written within a PrefLib file.
 
     """

preflibtools/instances/preflibinstance/ordinal.py

@@ -256,7 +256,9 @@ def flatten_strict(self):
         res = []
         for order in self.orders:
             if len(order) != self.num_alternatives:
-                warnings.warn("You are flattening a non-strict order, information may be lost.")
+                warnings.warn(
+                    "You are flattening a non-strict order, information may be lost."
+                )
             res.append(
                 (
                     tuple(indif_class[0] for indif_class in order),
@@ -485,4 +487,3 @@ def __str__(self):
         return "Ordinal-Instance: {} <{},{}>".format(
             self.file_name, self.num_voters, self.num_alternatives
         )
-

preflibtools/instances/preflibinstance/utils.py

@@ -28,7 +28,9 @@ def get_parsed_instance(file_path, autocorrect=False, header_only=False):
     elif extension == ".wmd":
         instance = MatchingInstance()
     else:
-        raise TypeError(f"The file extension {extension} corresponds to no known file extension "
-                        f"of PrefLib data file.")
+        raise TypeError(
+            f"The file extension {extension} corresponds to no known file extension "
+            f"of PrefLib data file."
+        )
     instance.parse_file(file_path, autocorrect=autocorrect, header_only=header_only)
     return instance

preflibtools/instances/sampling.py

@@ -2,6 +2,7 @@
 Note that this has been updated to use the samplers provided in the
 `prefsampling  <https://github.com/COMSOC-Community/prefsampling>`_ package.
 """
+
 import math
 
 from prefsampling.ordinal import mallows, urn, impartial, impartial_anonymous