assume f-strings are available (python3.6+) for all scripts we are the only ones to run

Author: gdementen

doc/source/check_api_doc.py

@@ -113,8 +113,8 @@ def only_deprecated(self):
 
     def diff(self, other):
         if not isinstance(other, ClassItem):
-            raise TypeError("Expect a {} instance as argument. "
-                            "Got a {} instance instead".format(ClassItem.__name__, type(other).__name__))
+            raise TypeError(f"Expect a {ClassItem.__name__} instance as argument. "
+                            f"Got a {type(other).__name__} instance instead")
         diff_item = ClassItem(self.class_)
         diff_item.attrs = {k: v for k, v in self.attrs.items() if k not in other.attrs}
         diff_item.methods = {k: v for k, v in self.methods.items() if k not in other.methods}
@@ -128,15 +128,15 @@ def write(self, ofile):
             _write_header(ofile, self.name, '=', indent=indent)
             if self.attrs:
                 _write_header(ofile, 'Attributes', indent=indent)
-                ofile.writelines(indent + ' * {}\n'.format(attr) for attr in self.attrs.keys())
+                ofile.writelines(f'{indent} * {attr}\n' for attr in self.attrs.keys())
                 ofile.write('\n')
             if self.methods:
                 _write_header(ofile, 'Methods', indent=indent)
-                ofile.writelines(indent + ' * {}\n'.format(method) for method in self.methods.keys())
+                ofile.writelines(f'{indent} * {method}\n' for method in self.methods.keys())
                 ofile.write('\n')
             if self.deprecated_methods:
                 _write_header(ofile, 'Deprecated Methods', indent=indent)
-                ofile.writelines(indent + ' * {}\n'.format(method) for method in self.deprecated_methods.keys())
+                ofile.writelines(f'{indent} * {method}\n' for method in self.deprecated_methods.keys())
                 ofile.write('\n')
             ofile.write('\n')
 
@@ -182,6 +182,7 @@ def insert_element(self, name, obj):
                 self.funcs[name] = obj
         elif inspect.isclass(obj):
             if name in self.classes:
+                # FIXME: missing format or fstring
                 warnings.warn("Class '{}' was already present in '{}' module item and will be replaced")
             class_ = getattr(self.module, name)
             class_item = ClassItem(class_)
@@ -210,8 +211,8 @@ def only_deprecated(self):
 
     def diff(self, other):
         if not isinstance(other, ModuleItem):
-            raise TypeError("Expect a {} instance as argument. "
-                            "Got a {} instance instead".format(ModuleItem.__name__, type(other).__name__))
+            raise TypeError(f"Expect a {ModuleItem.__name__} instance as argument. "
+                            f"Got a {type(other).__name__} instance instead")
         diff_item = ModuleItem(self.module)
         diff_item.others = {k: v for k, v in self.others.items() if k not in other.others}
         diff_item.funcs = {k: v for k, v in self.funcs.items() if k not in other.funcs}
@@ -227,15 +228,15 @@ def write(self, ofile):
             ofile.write('\n')
             if self.others:
                 _write_header(ofile, 'Miscellaneous', '=')
-                ofile.writelines(' * {}\n'.format(other) for other in self.others.keys())
+                ofile.writelines(f' * {other}\n' for other in self.others.keys())
                 ofile.write('\n')
             if self.funcs:
                 _write_header(ofile, 'Functions', '=')
-                ofile.writelines(' * {}\n'.format(func) for func in self.funcs.keys())
+                ofile.writelines(f' * {func}\n' for func in self.funcs.keys())
                 ofile.write('\n')
             if self.deprecated_items:
                 _write_header(ofile, 'Deprecated Functions or Classes', '=')
-                ofile.writelines(' * {}\n'.format(func) for func in self.deprecated_items.keys())
+                ofile.writelines(f' * {func}\n' for func in self.deprecated_items.keys())
                 ofile.write('\n')
             if self.classes:
                 _write_header(ofile, 'Classes', '=')
@@ -270,7 +271,7 @@ def get_public_api():
             module_item.auto_discovery()
             public_api[module_name] = module_item
         except ImportError as err:
-            print('module {} could not be imported: {}'.format(module_name, err))
+            print(f'module {module_name} could not be imported: {err}')
             public_api[module_name] = err
     return public_api
 
@@ -294,7 +295,7 @@ def get_autosummary_api():
             module_item = ModuleItem(module)
             autosummary_api[module_name] = module_item
         except ImportError as err:
-            print('module {} could not be imported: {}'.format(module_name, err))
+            print(f'module {module_name} could not be imported: {err}')
             autosummary_api[module_name] = err
 
     for generated_rst_file in os.listdir(output_dir):
@@ -327,7 +328,7 @@ def write_api(filepath, api, header='API', version=True):
     failed = []
     with open(output_file, 'w') as ofile:
         if version:
-            header = '{} [{}]'.format(header, __version__)
+            header = f'{header} [{__version__}]'
         _write_header(ofile, header, '~')
         ofile.write('\n')
         keys = sorted(api.keys())
@@ -341,7 +342,7 @@ def write_api(filepath, api, header='API', version=True):
 
         if failed:
             _write_header(ofile, 'Modules that failed to import')
-            ofile.writelines(' * {} -- {}\n'.format(module_name, error) for module_name, error in failed)
+            ofile.writelines(f' * {module_name} -- {error}\n' for module_name, error in failed)
 
 
 def get_items_from_api_doc():

make_release.py

@@ -1,11 +1,8 @@
 #!/usr/bin/python
-# coding=utf-8
 # Release script for LArray
 # Licence: GPLv3
 # Requires:
 # * git
-from __future__ import print_function, unicode_literals
-
 import sys
 from os.path import abspath, dirname, join
 from subprocess import check_call
@@ -35,15 +32,12 @@ def update_metapackage(context):
     chdir(context['repository'])
     version = short(context['release_name'])
 
-    def fill(s):
-        return s.format(version=version)
-
     # TODO: this should be echocall(redirect_stdout=False)
-    print(fill('Updating larrayenv metapackage to version {version}'))
+    print(f'Updating larrayenv metapackage to version {version}')
     # - excluded versions 5.0 and 5.1 of ipykernel because these versions make the console useless after any exception
     #   https://github.com/larray-project/larray-editor/issues/166
-    check_call(['conda', 'metapackage', 'larrayenv', version, '--dependencies', fill('larray =={version}'),
-                fill('larray-editor =={version}'), fill('larray_eurostat =={version}'),
+    check_call(['conda', 'metapackage', 'larrayenv', version, '--dependencies', f'larray =={version}',
+                f'larray-editor =={version}', f'larray_eurostat =={version}',
                 "qtconsole", "matplotlib", "pyqt", "qtpy", "pytables",
                 "xlsxwriter", "xlrd", "openpyxl", "xlwings", "ipykernel !=5.0,!=5.1.0",
                 '--user', 'larray-project',
@@ -72,33 +66,44 @@ def announce_new_release(release_name):
     outlook = win32.Dispatch('outlook.application')
     mail = outlook.CreateItem(0)
     mail.To = LARRAY_ANNOUNCE_MAILING_LIST
-    mail.Subject = "LArray {} released".format(version)
-    mail.Body = """\
+    mail.Subject = f"LArray {version} released"
+    mail.Body = f"""\
 Hello all, 
 
 We are pleased to announce that version {version} of LArray is now available. 
 The complete description of changes including examples can be found at:
 
-{readthedocs}changes.html#version-{version_doc}
+{LARRAY_READTHEDOCS}changes.html#version-{version.replace('.', '-')}
 
 
 
 As always, *any* feedback is very welcome, preferably on the larray-users 
-mailing list: {larray_users_group} (you need to register to be able to post).
-""".format(version=version, readthedocs=LARRAY_READTHEDOCS, version_doc=version.replace('.', '-'),
-           larray_users_group=LARRAY_USERS_GROUP)
+mailing list: {LARRAY_USERS_GROUP} (you need to register to be able to post).
+"""
     mail.Display(True)
 
 
 if __name__ == '__main__':
     argv = sys.argv
     if len(argv) < 2:
-        print("Usage: {} [-c|--conda] release_name|dev [step|startstep:stopstep] [branch]".format(argv[0]))
-        print("make release steps:", ', '.join(f.__name__ for f, _ in make_release_steps))
-        print("update conda-forge feedstock steps:", ', '.join(f.__name__ for f, _ in update_feedstock_steps))
-        print("or")
-        print("Usage: {} -a|--announce release_name".format(argv[0]))
-        print("Usage: {} -m|--meta release_name".format(argv[0]))
+        print(f"""
+Usage:
+ * {argv[0]} release_name|dev [step|startstep:stopstep] [branch]
+   main release script
+
+   steps: {', '.join(f.__name__ for f, _ in make_release_steps)}
+
+ * {argv[0]} -c|--conda release_name
+   update conda-forge feedstock
+
+   steps: {', '.join(f.__name__ for f, _ in update_feedstock_steps)}
+
+ * {argv[0]} -a|--announce release_name
+   announce release
+
+ * {argv[0]} -m|--meta release_name
+   update metapackage
+""")
         sys.exit()
 
     local_repository = abspath(dirname(__file__))

next_release.py

@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# encoding: utf-8
 # script to start a new release cycle
 # Licence: GPLv3
 from os.path import abspath, dirname
@@ -12,7 +11,7 @@
 
     argv = sys.argv
     if len(argv) < 2:
-        print("Usage: {} release_name [branch]".format(argv[0]))
+        print(f"Usage: {argv[0]} release_name [branch]")
         sys.exit()
 
     local_repository = abspath(dirname(__file__))