[#615] reformat all Python source using black 24.10.0

Author: d-w-moore

docker_build/iinit.py

@@ -4,41 +4,48 @@
 import os
 import sys
 from os import chmod
-from os.path import expanduser,exists,join
+from os.path import expanduser, exists, join
 from getopt import getopt
 
 
-home_env_path = expanduser('~/.irods')
-env_file_path = join(home_env_path,'irods_environment.json')
-auth_file_path = join(home_env_path,'.irodsA')
+home_env_path = expanduser("~/.irods")
+env_file_path = join(home_env_path, "irods_environment.json")
+auth_file_path = join(home_env_path, ".irodsA")
 
 
 def do_iinit(host, port, user, zone, password):
     if not exists(home_env_path):
         os.makedirs(home_env_path)
     else:
-        raise RuntimeError('~/.irods already exists')
-
-    with open(env_file_path,'w') as env_file:
-        json.dump ( { "irods_host": host,
-                      "irods_port": int(port),
-                      "irods_user_name": user,
-                      "irods_zone_name": zone  }, env_file, indent=4)
-    with open(auth_file_path,'w') as auth_file:
+        raise RuntimeError("~/.irods already exists")
+
+    with open(env_file_path, "w") as env_file:
+        json.dump(
+            {
+                "irods_host": host,
+                "irods_port": int(port),
+                "irods_user_name": user,
+                "irods_zone_name": zone,
+            },
+            env_file,
+            indent=4,
+        )
+    with open(auth_file_path, "w") as auth_file:
         auth_file.write(encode(password))
-    chmod (auth_file_path,0o600)
+    chmod(auth_file_path, 0o600)
 
 
 def get_kv_pairs_from_cmdline(*args):
     arglist = list(args)
     while arglist:
-       k = arglist.pop(0)
-       v = arglist.pop(0)
-       yield k,v
+        k = arglist.pop(0)
+        v = arglist.pop(0)
+        yield k, v
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     import sys
+
     args = sys.argv[1:]
-    dct = {k:v for k,v in get_kv_pairs_from_cmdline(*args)}
+    dct = {k: v for k, v in get_kv_pairs_from_cmdline(*args)}
     do_iinit(**dct)

irods/__init__.py

@@ -1,38 +1,48 @@
 import sys
 
-minimum_compatible_python = (3,6)
+minimum_compatible_python = (3, 6)
 
 if sys.version_info < minimum_compatible_python:
-    to_dotted_string = lambda version_tuple: '.'.join(str(_) for _ in version_tuple)
-    version_message = "This library is only supported on Python {} and above.".format(to_dotted_string(minimum_compatible_python))
+    to_dotted_string = lambda version_tuple: ".".join(str(_) for _ in version_tuple)
+    version_message = "This library is only supported on Python {} and above.".format(
+        to_dotted_string(minimum_compatible_python)
+    )
     raise RuntimeError(version_message)
 
 from .version import __version__, version_as_tuple, version_as_string
 
 import logging
 import os
 
+
 def env_filename_from_keyword_args(kwargs):
     try:
-        env_file = kwargs.pop('irods_env_file')
+        env_file = kwargs.pop("irods_env_file")
     except KeyError:
         try:
-            env_file = os.environ['IRODS_ENVIRONMENT_FILE']
+            env_file = os.environ["IRODS_ENVIRONMENT_FILE"]
         except KeyError:
-            env_file = os.path.expanduser('~/.irods/irods_environment.json')
+            env_file = os.path.expanduser("~/.irods/irods_environment.json")
     return env_file
 
+
 def derived_auth_filename(env_filename):
     if not env_filename:
-        return ''
-    default_irods_authentication_file = os.path.join(os.path.dirname(env_filename),'.irodsA')
-    return os.environ.get('IRODS_AUTHENTICATION_FILE', default_irods_authentication_file)
+        return ""
+    default_irods_authentication_file = os.path.join(
+        os.path.dirname(env_filename), ".irodsA"
+    )
+    return os.environ.get(
+        "IRODS_AUTHENTICATION_FILE", default_irods_authentication_file
+    )
+
 
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 gHandler = None
 
-def client_logging(flag=True,handler=None):
+
+def client_logging(flag=True, handler=None):
     """
     Example of use:
 
@@ -45,15 +55,19 @@ def client_logging(flag=True,handler=None):
     global gHandler
     if flag:
         if handler is not None:
-            if gHandler: logger.removeHandler(gHandler)
-            if not handler: handler = logging.StreamHandler()
+            if gHandler:
+                logger.removeHandler(gHandler)
+            if not handler:
+                handler = logging.StreamHandler()
             gHandler = handler
             logger.addHandler(handler)
     else:
-        if gHandler: logger.removeHandler(gHandler)
+        if gHandler:
+            logger.removeHandler(gHandler)
         gHandler = None
     return gHandler
 
+
 # Magic Numbers
 MAX_PASSWORD_LENGTH = 50
 MAX_SQL_ATTR = 50
@@ -66,32 +80,36 @@ def client_logging(flag=True,handler=None):
 # https://stackoverflow.com/questions/45704243/value-of-c-pytime-t-in-python
 MAXIMUM_CONNECTION_TIMEOUT = 9223372036
 
-AUTH_SCHEME_KEY = 'a_scheme'
-AUTH_USER_KEY = 'a_user'
-AUTH_PWD_KEY = 'a_pw'
-AUTH_TTL_KEY = 'a_ttl'
+AUTH_SCHEME_KEY = "a_scheme"
+AUTH_USER_KEY = "a_user"
+AUTH_PWD_KEY = "a_pw"
+AUTH_TTL_KEY = "a_ttl"
 
-NATIVE_AUTH_SCHEME = 'native'
+NATIVE_AUTH_SCHEME = "native"
 
-GSI_AUTH_PLUGIN = 'GSI'
+GSI_AUTH_PLUGIN = "GSI"
 GSI_AUTH_SCHEME = GSI_AUTH_PLUGIN.lower()
 GSI_OID = "1.3.6.1.4.1.3536.1.1"  # taken from http://j.mp/2hDeczm
 
-PAM_AUTH_PLUGIN = 'PAM'
+PAM_AUTH_PLUGIN = "PAM"
 PAM_AUTH_SCHEME = PAM_AUTH_PLUGIN.lower()
-PAM_AUTH_SCHEMES = (PAM_AUTH_SCHEME, 'pam_password')
+PAM_AUTH_SCHEMES = (PAM_AUTH_SCHEME, "pam_password")
+
+DEFAULT_CONFIG_PATH = os.path.expanduser("~/.python_irodsclient")
+settings_path_environment_variable = "PYTHON_IRODSCLIENT_CONFIGURATION_PATH"
 
-DEFAULT_CONFIG_PATH = os.path.expanduser('~/.python_irodsclient')
-settings_path_environment_variable = 'PYTHON_IRODSCLIENT_CONFIGURATION_PATH'
 
 def get_settings_path():
     env_var = os.environ.get(settings_path_environment_variable)
     return DEFAULT_CONFIG_PATH if not env_var else env_var
 
+
 from . import client_configuration
 
 client_configuration.preserve_defaults()
 
 # If the settings path variable is not set in the environment, a value of None is passed,
 # and thus no settings file is auto-loaded.
-client_configuration.autoload(_file_to_load = os.environ.get(settings_path_environment_variable))
+client_configuration.autoload(
+    _file_to_load=os.environ.get(settings_path_environment_variable)
+)