Merge pull request #270 from kobotoolbox/268-black

Apply `black` formatting

Author: noliveleger

pyproject.toml

@@ -0,0 +1,4 @@
+[tool.black]
+verbose = true
+line-length = 80
+skip-string-normalization = true

src/formpack/__main__.py

@@ -30,11 +30,11 @@ def print_xls(filename, expand=False, flatten=False, xml=False):
             if xml:
                 print(FormPack({'content': content}, **settings)[0].to_xml())
             else:
-                print(json.dumps(content,
-                                 indent=2))
+                print(json.dumps(content, indent=2))
     except EnvironmentError as e:
-        sys.exit('error trying to read input as xls file? {}: {}'.format(
-                 filename, e))
+        sys.exit(
+            'error trying to read input as xls file? {}: {}'.format(filename, e)
+        )
 
 
 @begin.subcommand

src/formpack/errors.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+
 class TranslationError(ValueError):
     pass
 

src/formpack/pack.py

@@ -13,12 +13,17 @@
 
 
 class FormPack:
-
-    def __init__(self, versions=None, title='Submissions', id_string=None,
-                 default_version_id_key='__version__',
-                 strict_schema=False,
-                 root_node_name='data',
-                 asset_type=None, submissions_xml=None):
+    def __init__(
+        self,
+        versions=None,
+        title='Submissions',
+        id_string=None,
+        default_version_id_key='__version__',
+        strict_schema=False,
+        root_node_name='data',
+        asset_type=None,
+        submissions_xml=None,
+    ):
         """
 
 
@@ -54,7 +59,7 @@ def __init__(self, versions=None, title='Submissions', id_string=None,
     # FIXME: Find a safe way to use this. Wrapping with try/except isn't enough
     # to fix https://github.com/kobotoolbox/formpack/issues/150
     #
-    #def __repr__(self):
+    # def __repr__(self):
     #    return '<FormPack %s>' % self._stats()
 
     def version_id_keys(self, _versions=None):
@@ -101,8 +106,9 @@ def _stats(self):
         _stats['versions'] = len(self.versions)
         # _stats['submissions'] = self.submissions_count()
         if self.versions:
-            _stats['row_count'] = len(self[-1].schema.get('content', {})
-                                                     .get('survey', []))
+            _stats['row_count'] = len(
+                self[-1].schema.get('content', {}).get('survey', [])
+            )
         # returns stats in the format [ key="value" ]
         return '\n\t'.join('%s="%s"' % item for item in _stats.items())
 
@@ -111,20 +117,20 @@ def load_all_versions(self, versions):
             self.load_version(deepcopy(schema))
 
     def load_version(self, schema):
-        """ Load one version and attach it to this Formpack
+        """Load one version and attach it to this Formpack
 
-            All the metadata parsing is delegated to the FormVersion class,
-            hence several attributes for FormPack are populated on the fly
-            while getting versions loaded:
+        All the metadata parsing is delegated to the FormVersion class,
+        hence several attributes for FormPack are populated on the fly
+        while getting versions loaded:
 
-                - title : the human readable name of the form. Match the one
-                          from the most recent version.
-                - id_string : the human readable id of the form. The same for
-                              all versions of the same FormPack.
+            - title : the human readable name of the form. Match the one
+                      from the most recent version.
+            - id_string : the human readable id of the form. The same for
+                          all versions of the same FormPack.
 
-            Each version can be distinguish by its version_id, which is
-            unique accross an entire FormPack. It can be None, but only for
-            one version in the FormPack.
+        Each version can be distinguish by its version_id, which is
+        unique accross an entire FormPack. It can be None, but only for
+        one version in the FormPack.
         """
         replace_aliases(schema['content'], in_place=True)
         expand_content(schema['content'], in_place=True)
@@ -140,20 +146,27 @@ def load_version(self, schema):
         # Avoid duplicate versions id
         if form_version.id in self.versions:
             if form_version.id is None:
-                raise ValueError('cannot have two versions without '
-                                 'a "version" id specified')
+                raise ValueError(
+                    'cannot have two versions without '
+                    'a "version" id specified'
+                )
 
-            raise ValueError('cannot have duplicate version id: %s'
-                             % form_version.id)
+            raise ValueError(
+                'cannot have duplicate version id: %s' % form_version.id
+            )
 
         # If the form pack doesn't have an id_string, we get it from the
         # first form version. We also avoid heterogenenous id_string in versions
         if form_version.id_string:
             if self.id_string and self.id_string != form_version.id_string:
-                raise ValueError('Versions must of the same form must '
-                                 'share an id_string: %s != %s' % (
-                                    self.id_string, form_version.id_string,
-                                 ))
+                raise ValueError(
+                    'Versions must of the same form must '
+                    'share an id_string: %s != %s'
+                    % (
+                        self.id_string,
+                        form_version.id_string,
+                    )
+                )
 
             self.id_string = form_version.id_string
 
@@ -169,16 +182,16 @@ def version_diff(self, vn1, vn2):
         v2 = self.versions[vn2]
 
         def summr(v):
-            return json.dumps(v.schema.get('content'),
-                              indent=4,
-                              sort_keys=True,
-                              ).splitlines(1)
+            return json.dumps(
+                v.schema.get('content'),
+                indent=4,
+                sort_keys=True,
+            ).splitlines(1)
+
         out = []
-        for line in difflib.unified_diff(summr(v1),
-                                         summr(v2),
-                                         fromfile=vn1,
-                                         tofile=vn2,
-                                         n=1):
+        for line in difflib.unified_diff(
+            summr(v1), summr(v2), fromfile=vn1, tofile=vn2, n=1
+        ):
             out.append(line)
         return ''.join(out)
 
@@ -268,12 +281,15 @@ def get_fields_for_versions(self, versions=-1, data_types=None):
                     if not isinstance(field_object, CopyField):
                         if section_field_name in positions:
                             position = positions[section_field_name]
-                            latest_field_object = tmp2d[position[0]][position[1]]
+                            latest_field_object = tmp2d[position[0]][
+                                position[1]
+                            ]
                             # Because versions_desc are ordered from latest to oldest,
                             # we use current field object as the old one and the one already
                             # in position as the latest one.
                             new_object = self._combine_field_choices(
-                                field_object, latest_field_object)
+                                field_object, latest_field_object
+                            )
                             tmp2d[position[0]][position[1]] = new_object
                         else:
                             try:
@@ -286,7 +302,10 @@ def get_fields_for_versions(self, versions=-1, data_types=None):
                                 # it can happen when current version has more items than newest one.
                                 index = len(tmp2d) - 1
 
-                            positions[section_field_name] = (index, len(tmp2d[index]) - 1)
+                            positions[section_field_name] = (
+                                index,
+                                len(tmp2d[index]) - 1,
+                            )
 
                         index += 1
 
@@ -367,7 +386,7 @@ def export(
             tag_cols_for_header=tag_cols_for_header,
             filter_fields=filter_fields,
             xls_types_as_text=xls_types_as_text,
-            include_media_url=include_media_url
+            include_media_url=include_media_url,
         )
 
     def autoreport(self, versions=-1):
@@ -381,7 +400,7 @@ def _get_versions(self, versions):
         if versions is None:
             versions = -1
 
-        if isinstance(versions, (str, int,)):
+        if isinstance(versions, (str, int)):
             versions = [versions]
         versions = [self[key] for key in versions]
 

src/formpack/reporting/autoreport.py

@@ -8,9 +8,9 @@
 
 
 class AutoReportStats:
-
-    def __init__(self, autoreport, stats, submissions_count,
-                 submission_counts_by_version):
+    def __init__(
+        self, autoreport, stats, submissions_count, submission_counts_by_version
+    ):
         self.autoreport = autoreport
         self.stats = stats
         self.submissions_count = submissions_count
@@ -21,7 +21,6 @@ def __iter__(self):
 
 
 class AutoReport:
-
     def __init__(self, formpack, form_versions):
         self.formpack = formpack
         self.versions = form_versions
@@ -91,14 +90,22 @@ def _calculate_stats(self, submissions, fields, versions, lang):
 
         def stats_generator():
             for field in fields:
-                yield (field,
-                       field.get_labels(lang)[0],
-                       field.get_stats(metrics[field.name], lang=lang))
-
-        return AutoReportStats(self, stats_generator(), submissions_count,
-                               submission_counts_by_version)
+                yield (
+                    field,
+                    field.get_labels(lang)[0],
+                    field.get_stats(metrics[field.name], lang=lang),
+                )
+
+        return AutoReportStats(
+            self,
+            stats_generator(),
+            submissions_count,
+            submission_counts_by_version,
+        )
 
-    def _disaggregate_stats(self, submissions, fields, versions, lang, split_by_field):
+    def _disaggregate_stats(
+        self, submissions, fields, versions, lang, split_by_field
+    ):
 
         # We want only the most used values so we build a separate counter
         # for it to filter them
@@ -168,7 +175,7 @@ def _disaggregate_stats(self, submissions, fields, versions, lang, split_by_fiel
             if splitter is not None:
                 values = split_by_field.parse_values(splitter)
             else:
-                values = (None, )
+                values = (None,)
 
             splitters_rank.update(values)
 
@@ -191,14 +198,25 @@ def _disaggregate_stats(self, submissions, fields, versions, lang, split_by_fiel
 
         def stats_generator():
             for field in fields:
-                stats = field.get_disaggregated_stats(metrics[field.name], lang=lang,
-                                                      top_splitters=top_splitters)
+                stats = field.get_disaggregated_stats(
+                    metrics[field.name], lang=lang, top_splitters=top_splitters
+                )
                 yield (field, field.get_labels(lang)[0], stats)
 
-        return AutoReportStats(self, stats_generator(), submissions_count,
-                               submission_counts_by_version)
+        return AutoReportStats(
+            self,
+            stats_generator(),
+            submissions_count,
+            submission_counts_by_version,
+        )
 
-    def get_stats(self, submissions, fields=(), lang=UNSPECIFIED_TRANSLATION, split_by=None):
+    def get_stats(
+        self,
+        submissions,
+        fields=(),
+        lang=UNSPECIFIED_TRANSLATION,
+        split_by=None,
+    ):
 
         all_fields = self.formpack.get_fields_for_versions(self.versions)
         all_fields = [field for field in all_fields if field.has_stats]
@@ -214,10 +232,12 @@ def get_stats(self, submissions, fields=(), lang=UNSPECIFIED_TRANSLATION, split_
             try:
                 split_by_field = next(f for f in fields if f.name == split_by)
             except StopIteration:
-                raise ValueError('No field matching name "%s" '
-                                 'for split_by' % split_by)
+                raise ValueError(
+                    'No field matching name "%s" ' 'for split_by' % split_by
+                )
 
-            return self._disaggregate_stats(submissions, fields,
-                                            self.versions, lang, split_by_field)
+            return self._disaggregate_stats(
+                submissions, fields, self.versions, lang, split_by_field
+            )
 
         return self._calculate_stats(submissions, fields, self.versions, lang)