Use black as formatter for python files

Author: cimnine

.editorconfig

@@ -7,5 +7,5 @@ charset = utf-8
 indent_style = space
 indent_size = 2
 
-[configuration/**.py]
+[*.py]
 indent_size = 4

Dockerfile

@@ -18,8 +18,8 @@ RUN apk add --no-cache \
       postgresql-dev \
       py3-pip \
       python3-dev \
- && python3 -m venv /opt/netbox/venv \
- && /opt/netbox/venv/bin/python3 -m pip install --upgrade \
+  && python3 -m venv /opt/netbox/venv \
+  && /opt/netbox/venv/bin/python3 -m pip install --upgrade \
       pip \
       setuptools \
       wheel

configuration/configuration.py

@@ -5,9 +5,8 @@
 ####
 
 import re
-
-from os.path import dirname, abspath, join
 from os import environ
+from os.path import abspath, dirname, join
 
 # For reference see https://netbox.readthedocs.io/en/stable/configuration/
 # Based on https://github.com/netbox-community/netbox/blob/master/netbox/netbox/configuration.example.py
@@ -39,16 +38,16 @@ def _read_secret(secret_name, default = None):
 # PostgreSQL database configuration. See the Django documentation for a complete list of available parameters:
 #   https://docs.djangoproject.com/en/stable/ref/settings/#databases
 DATABASE = {
-    'NAME': environ.get('DB_NAME', 'netbox'),            # Database name
-    'USER': environ.get('DB_USER', ''),                  # PostgreSQL username
+    'NAME': environ.get('DB_NAME', 'netbox'),       # Database name
+    'USER': environ.get('DB_USER', ''),             # PostgreSQL username
     'PASSWORD': _read_secret('db_password', environ.get('DB_PASSWORD', '')),
-                                                         # PostgreSQL password
-    'HOST': environ.get('DB_HOST', 'localhost'),         # Database server
-    'PORT': environ.get('DB_PORT', ''),                  # Database port (leave blank for default)
+                                                    # PostgreSQL password
+    'HOST': environ.get('DB_HOST', 'localhost'),    # Database server
+    'PORT': environ.get('DB_PORT', ''),             # Database port (leave blank for default)
     'OPTIONS': {'sslmode': environ.get('DB_SSLMODE', 'prefer')},
-                                                         # Database connection SSLMODE
+                                                    # Database connection SSLMODE
     'CONN_MAX_AGE': int(environ.get('DB_CONN_MAX_AGE', '300')),
-                                                         # Max database connection age
+                                                    # Max database connection age
 }
 
 # Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate

configuration/ldap/ldap_config.py

@@ -1,9 +1,10 @@
-import ldap
-
-from django_auth_ldap.config import LDAPSearch
 from importlib import import_module
 from os import environ
 
+import ldap
+from django_auth_ldap.config import LDAPSearch
+
+
 # Read secret from file
 def _read_secret(secret_name, default=None):
     try:
@@ -47,9 +48,11 @@ def _import_group_type(group_type_name):
 
 AUTH_LDAP_USER_SEARCH_BASEDN = environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '')
 AUTH_LDAP_USER_SEARCH_ATTR = environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName')
-AUTH_LDAP_USER_SEARCH = LDAPSearch(AUTH_LDAP_USER_SEARCH_BASEDN,
-                                   ldap.SCOPE_SUBTREE,
-                                   "(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)")
+AUTH_LDAP_USER_SEARCH = LDAPSearch(
+    AUTH_LDAP_USER_SEARCH_BASEDN,
+    ldap.SCOPE_SUBTREE,
+    "(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)"
+)
 
 # This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
 # heirarchy.

docker/configuration.docker.py

@@ -4,58 +4,58 @@
 #
 # They can be imported by other code (see `ldap_config.py` for an example).
 
-from os.path import abspath, isfile
-from os import scandir
 import importlib.util
 import sys
+from os import scandir
+from os.path import abspath, isfile
 
 
 def _filename(f):
-  return f.name
+    return f.name
 
 
 def _import(module_name, path, loaded_configurations):
-  spec = importlib.util.spec_from_file_location('', path)
-  module = importlib.util.module_from_spec(spec)
-  spec.loader.exec_module(module)
-  sys.modules[module_name] = module
+    spec = importlib.util.spec_from_file_location("", path)
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    sys.modules[module_name] = module
 
-  loaded_configurations.insert(0, module)
+    loaded_configurations.insert(0, module)
 
-  print(f"🧬 loaded config '{path}'")
+    print(f"🧬 loaded config '{path}'")
 
 
 def read_configurations(config_module, config_dir, main_config):
-  loaded_configurations = []
+    loaded_configurations = []
 
-  main_config_path = abspath(f'{config_dir}/{main_config}.py')
-  if isfile(main_config_path):
-    _import(f'{config_module}.{main_config}', main_config_path, loaded_configurations)
-  else:
-    print(f"⚠️ Main configuration '{main_config_path}' not found.")
+    main_config_path = abspath(f"{config_dir}/{main_config}.py")
+    if isfile(main_config_path):
+        _import(f"{config_module}.{main_config}", main_config_path, loaded_configurations)
+    else:
+        print(f"⚠️ Main configuration '{main_config_path}' not found.")
 
-  with scandir(config_dir) as it:
-    for f in sorted(it, key=_filename):
-      if not f.is_file():
-        continue
+    with scandir(config_dir) as it:
+        for f in sorted(it, key=_filename):
+            if not f.is_file():
+                continue
 
-      if f.name.startswith('__'):
-        continue
+            if f.name.startswith("__"):
+                continue
 
-      if not f.name.endswith('.py'):
-        continue
+            if not f.name.endswith(".py"):
+                continue
 
-      if f.name == f'{config_dir}.py':
-        continue
+            if f.name == f"{config_dir}.py":
+                continue
 
-      module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_")
-      _import(module_name, f.path, loaded_configurations)
+            module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_")
+            _import(module_name, f.path, loaded_configurations)
 
-  if len(loaded_configurations) == 0:
-    print(f"‼️ No configuration files found in '{config_dir}'.")
-    raise ImportError(f"No configuration files found in '{config_dir}'.")
+    if len(loaded_configurations) == 0:
+        print(f"‼️ No configuration files found in '{config_dir}'.")
+        raise ImportError(f"No configuration files found in '{config_dir}'.")
 
-  return loaded_configurations
+    return loaded_configurations
 
 
 ## Specific Parts
@@ -66,15 +66,16 @@ def read_configurations(config_module, config_dir, main_config):
 
 
 _loaded_configurations = read_configurations(
-  config_dir = '/etc/netbox/config/',
-  config_module = 'netbox.configuration',
-  main_config = 'configuration')
+    config_dir="/etc/netbox/config/",
+    config_module="netbox.configuration",
+    main_config="configuration",
+)
 
 
 def __getattr__(name):
-  for config in _loaded_configurations:
-    try:
-      return getattr(config, name)
-    except:
-      pass
-  raise AttributeError
+    for config in _loaded_configurations:
+        try:
+            return getattr(config, name)
+        except:
+            pass
+    raise AttributeError

docker/ldap_config.docker.py

@@ -1,21 +1,23 @@
 from .configuration import read_configurations
 
 _loaded_configurations = read_configurations(
-  config_dir = '/etc/netbox/config/ldap/',
-  config_module = 'netbox.configuration.ldap',
-  main_config = 'ldap_config')
+    config_dir="/etc/netbox/config/ldap/",
+    config_module="netbox.configuration.ldap",
+    main_config="ldap_config",
+)
 
 
 def __getattr__(name):
-  for config in _loaded_configurations:
-    try:
-      return getattr(config, name)
-    except:
-      pass
-  raise AttributeError
+    for config in _loaded_configurations:
+        try:
+            return getattr(config, name)
+        except:
+            pass
+    raise AttributeError
+
 
 def __dir__():
-  names = []
-  for config in _loaded_configurations:
-    names.extend(config.__dir__())
-  return names
+    names = []
+    for config in _loaded_configurations:
+        names.extend(config.__dir__())
+    return names

initializers/custom_fields.yml

@@ -53,20 +53,20 @@
 #   - Fifth Item
 #   - Fourth Item
 # select_field_legacy_format:
-#    type: select
-#    label: Choose between items
-#    required: false
-#    filter_logic: loose
-#    weight: 30
-#    on_objects:
-#     - dcim.models.Device
-#    choices:
-#     - value: A # this is the deprecated format.
-#     - value: B # we only use it for the tests.
-#     - value: C # please see above for the new format.
-#     - value: "D like deprecated"
-#       weight: 999
-#     - value: E
+#   type: select
+#   label: Choose between items
+#   required: false
+#   filter_logic: loose
+#   weight: 30
+#   on_objects:
+#   - dcim.models.Device
+#   choices:
+#   - value: A # this is the deprecated format.
+#   - value: B # we only use it for the tests.
+#   - value: C # please see above for the new format.
+#   - value: "D like deprecated"
+#     weight: 999
+#   - value: E
 # boolean_field:
 #   type: boolean
 #   label: Yes Or No?

pyproject.toml

@@ -0,0 +1,21 @@
+[tool.black]
+line-length = 100
+target-version = ['py38']
+include = '\.pyi?$'
+exclude = '''
+
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.venv
+    | \.netbox
+    | \.vscode
+    | configuration
+  )/
+)
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3

startup_scripts/000_users.py

@@ -4,20 +4,21 @@
 from startup_script_utils import load_yaml, set_permissions
 from users.models import Token
 
-users = load_yaml('/opt/netbox/initializers/users.yml')
+users = load_yaml("/opt/netbox/initializers/users.yml")
 if users is None:
-  sys.exit()
+    sys.exit()
 
 for username, user_details in users.items():
-  if not User.objects.filter(username=username):
-    user = User.objects.create_user(
-      username = username,
-      password = user_details.get('password', 0) or User.objects.make_random_password())
+    if not User.objects.filter(username=username):
+        user = User.objects.create_user(
+            username=username,
+            password=user_details.get("password", 0) or User.objects.make_random_password(),
+        )
 
-    print("👤 Created user",username)
+        print("👤 Created user", username)
 
-    if user_details.get('api_token', 0):
-      Token.objects.create(user=user, key=user_details['api_token'])
+        if user_details.get("api_token", 0):
+            Token.objects.create(user=user, key=user_details["api_token"])
 
-    yaml_permissions = user_details.get('permissions', [])
-    set_permissions(user.user_permissions, yaml_permissions)
+        yaml_permissions = user_details.get("permissions", [])
+        set_permissions(user.user_permissions, yaml_permissions)

startup_scripts/010_groups.py

@@ -3,21 +3,21 @@
 from django.contrib.auth.models import Group, User
 from startup_script_utils import load_yaml, set_permissions
 
-groups = load_yaml('/opt/netbox/initializers/groups.yml')
+groups = load_yaml("/opt/netbox/initializers/groups.yml")
 if groups is None:
-  sys.exit()
+    sys.exit()
 
 for groupname, group_details in groups.items():
-  group, created = Group.objects.get_or_create(name=groupname)
+    group, created = Group.objects.get_or_create(name=groupname)
 
-  if created:
-    print("👥 Created group", groupname)
+    if created:
+        print("👥 Created group", groupname)
 
-  for username in group_details.get('users', []):
-    user = User.objects.get(username=username)
+    for username in group_details.get("users", []):
+        user = User.objects.get(username=username)
 
-    if user:
-      user.groups.add(group)
+        if user:
+            user.groups.add(group)
 
-  yaml_permissions = group_details.get('permissions', [])
-  set_permissions(group.permissions, yaml_permissions)
+    yaml_permissions = group_details.get("permissions", [])
+    set_permissions(group.permissions, yaml_permissions)