Merge pull request #747 from consideRatio/pr/pre-adding-pre-commit-fixes

Small fixes for flake8 and other smaller pre-commit tools

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+# Ignore style and complexity
+# E: style errors
+# W: style warnings
+# C: complexity
+# F841: local variable assigned but never used
+ignore = E, C, W, F841
+builtins =
+    c
+    load_subconfig
+exclude =
+    build/

.github/integration-test.py

@@ -104,7 +104,7 @@ def run_test(image_name, test_name, bootstrap_pip_spec, test_files, upgrade, ins
     if upgrade:
         run_container_command(
             test_name,
-            f'curl -L https://tljh.jupyter.org/bootstrap.py | python3 -'
+            'curl -L https://tljh.jupyter.org/bootstrap.py | python3 -'
         )
 
     run_container_command(

.github/workflows/integration-test.yaml

@@ -24,7 +24,6 @@ on:
   workflow_dispatch:
 
 jobs:
-
   # This job is used as a workaround to a limitation when using a matrix of
   # variations that a job should be executed against. The limitation is that a
   # matrix once defined can't include any conditions.

bootstrap/bootstrap.py

@@ -211,7 +211,7 @@ def ensure_host_system_can_install_tljh():
 class ProgressPageRequestHandler(SimpleHTTPRequestHandler):
     def do_GET(self):
         if self.path == "/logs":
-            with open("/opt/tljh/installer.log", "r") as log_file:
+            with open("/opt/tljh/installer.log") as log_file:
                 logs = log_file.read()
 
             self.send_response(200)

docs/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
- - [ ] Add / update documentation
- - [ ] Add tests
+- [ ] Add / update documentation
+- [ ] Add tests
 
- <!-- Read more about our code-review guidelines at https://the-littlest-jupyterhub.readthedocs.io/en/latest/contributing/code-review.html -->
+ <!-- Read more about our code-review guidelines at https://the-littlest-jupyterhub.readthedocs.io/en/latest/contributing/code-review.html -->

docs/contributing/code-review.rst

@@ -48,4 +48,4 @@ add more tests.
 If you are unsure what kind of tests to add for your pull request, other
 contributors to the repo will be happy to help guide you!
 
-See :ref:`contributing/tests` for guidelines on writing tests.
+See :ref:`contributing/tests` for guidelines on writing tests.

docs/contributing/packages.rst

@@ -43,4 +43,4 @@ Base operating system packages, including Python itself, are installed
 via ``apt`` from the base Ubuntu repositories.
 
 We generally do not pin versions of packages provided by apt, instead
-just using the latest versions provided by Ubuntu.
+just using the latest versions provided by Ubuntu.

docs/howto/admin/enable-extensions.rst

@@ -56,5 +56,3 @@ Enabling extensions via the command line
 
    .. image:: ../../images/admin/enable-spellcheck.png
       :alt: spellcheck-interface-changes
-
-

docs/howto/content/share-data.rst

@@ -136,4 +136,4 @@ and User C cannot edit the Notebook. Only User A can make changes.
 
 .. note::
    The TLJH Plugin at https://github.com/kafonek/tljh-shared-directory installs ``voila`` and sets up the directories as specified above.
-   Include ``--plugin git+https://github.com/kafonek/tljh-shared-directory`` in your deployment startup script to install it.
+   Include ``--plugin git+https://github.com/kafonek/tljh-shared-directory`` in your deployment startup script to install it.

docs/howto/providers/azure.rst

@@ -34,5 +34,3 @@ If you no longer need any of your resources you can delete the entire resource g
 * Go to "Reosurce groups" on the left hand panel
 * Click on your resource group
 * Click on "Delete resource group" you will then be asked to confirm the operation.  This operation will take between 5 and 10 minutes.
-
-

docs/howto/providers/digitalocean.rst

@@ -40,4 +40,4 @@ disk space, or CPUs. Digital Ocean servers can be resized in the
 
 Now that you've resized your Droplet, you may want to change the resources available
 to your users. Further information on making more resources available to
-users and verifying resource availability can be found in :ref:`howto/admin/resize`. 
+users and verifying resource availability can be found in :ref:`howto/admin/resize`. 

docs/install/custom-server.rst

@@ -97,4 +97,3 @@ Step 4: Setup HTTPS
 
 Once you are ready to run your server for real, and have a domain, it's a good
 idea to proceed directly to :ref:`howto/admin/https`.
-

docs/install/digitalocean.rst

@@ -116,4 +116,4 @@ Step 2: Adding more users
 Step 3: Install conda / pip packages for all users
 ==================================================
 
-.. include:: add_packages.txt
+.. include:: add_packages.txt

docs/topic/jupyterhub-configurator.rst

@@ -25,4 +25,4 @@ Accessing the Configurator
 
 After enabling the configurator using ``tljh-config``, the service will only be available to hub admins, from within the control panel.
 The configurator can be accessed from under ``Services`` in the top navigation bar. It will ask to authenticate, so it knows the user is an admin.
-Once done, the configurator interface will be available.
+Once done, the configurator interface will be available.

docs/troubleshooting/restart.rst

@@ -27,5 +27,3 @@ This calls systemctl and restarts Traefik. The user may call systemctl and resta
 .. code-block:: console
 
      $ sudo tljh-config reload hub
-
-

integration-tests/test_admin_installer.py

@@ -2,7 +2,6 @@ from hubtraf.user import User
 from hubtraf.auth.dummy import login_dummy
 import pytest
 from functools import partial
-import asyncio
 
 
 @pytest.mark.asyncio

integration-tests/test_extensions.py

@@ -1,4 +1,3 @@
-import os
 import subprocess
 
 
@@ -39,7 +38,7 @@ def test_nbextensions():
     ]
 
     for e in extensions:
-        assert '{} \x1b[32m enabled \x1b[0m'.format(e) in proc.stdout.decode()
+        assert f'{e} \x1b[32m enabled \x1b[0m' in proc.stdout.decode()
 
     # Ensure we have 'OK' messages in our stdout, to make sure everything is importable
     assert proc.stderr.decode() == '      - Validating: \x1b[32mOK\x1b[0m\n' * len(extensions)

integration-tests/test_hub.py

@@ -8,7 +8,6 @@ from functools import partial
 import asyncio
 import pwd
 import grp
-import sys
 import subprocess
 from os import system
 from tljh.normalize import generate_system_username

integration-tests/test_proxy.py

@@ -12,7 +12,6 @@ import pytest
 from tljh.config import (
     reload_component,
     set_config_value,
-    unset_config_value,
     CONFIG_FILE,
     CONFIG_DIR,
     STATE_DIR,

integration-tests/test_simplest_plugin.py

@@ -84,7 +84,7 @@ def test_new_user_create():
     # Call ensure_user to make sure the user plugin gets called
     user.ensure_user(username)
 
-    with open(f"test_new_user_create") as f:
+    with open("test_new_user_create") as f:
         content = f.read()
 
     assert content == username

tests/test_conda.py

@@ -59,7 +59,7 @@ def test_ensure_pip_requirements(prefix):
     conda.ensure_conda_packages(prefix, ['pip'])
     with tempfile.NamedTemporaryFile() as f:
         # Sample small package to test
-        f.write('there'.encode())
+        f.write(b'there')
         f.flush()
         conda.ensure_pip_requirements(prefix, f.name)
     subprocess.check_call([

tests/test_configurer.py

@@ -2,7 +2,6 @@
 Test configurer
 """
 
-from traitlets import Dict
 from traitlets.config import Config
 import os
 import sys

tests/test_installer.py

@@ -31,7 +31,7 @@ def test_ensure_admins(tljh_dir, admins, expected_config):
 	installer.ensure_admins(admins)
 
 	config_path = installer.CONFIG_FILE
-	with open(config_path, 'r') as f:
+	with open(config_path) as f:
 	    config = yaml.load(f)
 
 	# verify the list was flattened

tests/test_traefik.py

@@ -1,6 +1,5 @@
 """Test traefik configuration"""
 import os
-from unittest import mock
 
 import toml
 import pytest

tljh/conda.py

@@ -72,7 +72,7 @@ def fix_permissions(prefix):
     Run after each install command.
     """
     utils.run_subprocess(
-        ["chown", "-R", "{}:{}".format(os.getuid(), os.getgid()), prefix]
+        ["chown", "-R", f"{os.getuid()}:{os.getgid()}", prefix]
     )
     utils.run_subprocess(["chmod", "-R", "o-w", prefix])
 

tljh/config.py

@@ -13,7 +13,6 @@ tljh-config show firstlevel.second_level
 """
 
 import argparse
-import asyncio
 from collections.abc import Sequence, Mapping
 from copy import deepcopy
 import os

tljh/configurer.py

@@ -121,7 +121,7 @@ def load_traefik_api_credentials():
     proxy_secret_path = os.path.join(STATE_DIR, 'traefik-api.secret')
     if not os.path.exists(proxy_secret_path):
         return {}
-    with open(proxy_secret_path, 'r') as f:
+    with open(proxy_secret_path) as f:
         password = f.read()
     return {
         'traefik_api': {

tljh/installer.py

@@ -16,7 +16,6 @@ import bcrypt
 import pluggy
 import requests
 from requests.packages.urllib3.exceptions import InsecureRequestWarning
-from getpass import getpass
 
 from tljh import (
     apt,
@@ -26,7 +25,6 @@ from tljh import (
     systemd,
     traefik,
     user,
-    utils
 )
 from .config import (
     CONFIG_DIR,
@@ -227,7 +225,7 @@ def ensure_admins(admin_password_list):
     logger.info("Setting up admin users")
     config_path = CONFIG_FILE
     if os.path.exists(config_path):
-        with open(config_path, 'r') as f:
+        with open(config_path) as f:
             config = yaml.load(f)
     else:
         config = {}
@@ -263,7 +261,7 @@ def ensure_jupyterhub_running(times=20):
 
     for i in range(times):
         try:
-            logger.info('Waiting for JupyterHub to come up ({}/{} tries)'.format(i + 1, times))
+            logger.info(f'Waiting for JupyterHub to come up ({i + 1}/{times} tries)')
             # Because we don't care at this level that SSL is valid, we can suppress
             # InsecureRequestWarning for this request.
             with warnings.catch_warnings():
@@ -285,7 +283,7 @@ def ensure_jupyterhub_running(times=20):
             # Everything else should immediately abort
             raise
 
-    raise Exception("Installation failed: JupyterHub did not start in {}s".format(times))
+    raise Exception(f"Installation failed: JupyterHub did not start in {times}s")
 
 
 def ensure_symlinks(prefix):
@@ -390,7 +388,7 @@ def ensure_config_yaml(plugin_manager):
     migrator.migrate_config_files()
 
     if os.path.exists(CONFIG_FILE):
-        with open(CONFIG_FILE, 'r') as f:
+        with open(CONFIG_FILE) as f:
             config = yaml.load(f)
     else:
         config = {}

tljh/jupyterhub_config.py

@@ -5,7 +5,6 @@ JupyterHub config for the littlest jupyterhub.
 from glob import glob
 import os
 
-from systemdspawner import SystemdSpawner
 from tljh import configurer
 from tljh.config import INSTALL_PREFIX, USER_ENV_PREFIX, CONFIG_DIR
 from tljh.utils import get_plugin_manager

tljh/traefik.py

@@ -69,7 +69,7 @@ def ensure_traefik_binary(prefix):
     # verify that we got what we expected
     checksum = checksum_file(traefik_bin)
     if checksum != checksums[plat]:
-        raise IOError(f"Checksum failed {traefik_bin}: {checksum} != {checksums[plat]}")
+        raise OSError(f"Checksum failed {traefik_bin}: {checksum} != {checksums[plat]}")
 
 
 def compute_basic_auth(username, password):

tljh/user.py

@@ -34,7 +34,7 @@ def ensure_user(username):
     subprocess.check_call([
         'chmod',
         'o-rwx',
-        expanduser('~{username}'.format(username=username))
+        expanduser(f'~{username}')
     ])
 
     pm = get_plugin_manager()