Change formatter to black to strongly enforce pep8 style

.devcontainer/build/Dockerfile

@@ -7,17 +7,17 @@ FROM node:lts-slim
 # Install some basic dependencies
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \
-        apt-transport-https ca-certificates curl gnupg2 software-properties-common \
-        less jq \
-        build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev python-is-python3 python3-minimal
+    apt-transport-https ca-certificates curl gnupg2 software-properties-common \
+    less jq \
+    build-essential g++ libx11-dev libxkbfile-dev libsecret-1-dev python-is-python3 python3-minimal
 
 # Install docker CLI
 # https://docs.docker.com/engine/install/debian/
 RUN install -m 0755 -d /etc/apt/keyrings \
     && curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg \
     && chmod a+r /etc/apt/keyrings/docker.gpg \
     && echo "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
-        "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | tee /etc/apt/sources.list.d/docker.list \
+    "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | tee /etc/apt/sources.list.d/docker.list \
     && apt-get update \
     && apt-get install -y --no-install-recommends docker-ce-cli docker-buildx-plugin docker-compose-plugin
 

.vscode/extensions.json

@@ -16,7 +16,7 @@
         "lextudio.restructuredtext",
         "matangover.mypy",
         "ms-azuretools.vscode-docker",
-        "ms-python.autopep8",
+        "ms-python.black-formatter",
         "ms-python.flake8",
         "ms-python.pylint",
         "ms-python.python",

.vscode/settings.json

@@ -17,7 +17,6 @@
         // See Also:
         // - https://github.com/microsoft/vscode/issues/2809#issuecomment-1544387883
         // - mlos_bench/config/schemas/README.md
-
         {
             "fileMatch": [
                 "mlos_bench/mlos_bench/tests/config/schemas/environments/test-cases/**/*.jsonc",
@@ -129,15 +128,19 @@
         "--experimental"
     ],
     "[python]": {
-        "editor.defaultFormatter": "ms-python.autopep8",
+        "editor.defaultFormatter": "ms-python.black-formatter",
         "editor.formatOnSave": true,
-        "editor.formatOnSaveMode": "modifications"
+        "editor.formatOnSaveMode": "modifications",
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": true,
+            "source.fixAll": "always"
+        },
     },
     // See Also .vscode/launch.json for environment variable args to pytest during debug sessions.
     // For the rest, see setup.cfg
     "python.testing.pytestArgs": [
-        "--log-level=DEBUG",
         "."
     ],
-    "python.testing.unittestEnabled": false
+    "python.testing.unittestEnabled": false,
+    "restructuredtext.pythonRecommendation.disabled": true
 }

Makefile

@@ -46,23 +46,23 @@ clean-conda-env:
 	rm -f build/conda-env.${CONDA_ENV_NAME}.build-stamp
 
 .PHONY: check
-check: pycodestyle pydocstyle pylint mypy # cspell licenseheaders markdown-link-check
+check: black pydocstyle pylint mypy # cspell licenseheaders markdown-link-check
 
-.PHONY: pycodestyle
-pycodestyle: conda-env
-pycodestyle: build/pycodestyle.mlos_core.${CONDA_ENV_NAME}.build-stamp
-pycodestyle: build/pycodestyle.mlos_bench.${CONDA_ENV_NAME}.build-stamp
-pycodestyle: build/pycodestyle.mlos_viz.${CONDA_ENV_NAME}.build-stamp
+.PHONY: black
+black: conda-env
+black: build/black.mlos_core.${CONDA_ENV_NAME}.build-stamp
+black: build/black.mlos_bench.${CONDA_ENV_NAME}.build-stamp
+black: build/black.mlos_viz.${CONDA_ENV_NAME}.build-stamp
 
 
-build/pycodestyle.mlos_core.${CONDA_ENV_NAME}.build-stamp: $(MLOS_CORE_PYTHON_FILES)
-build/pycodestyle.mlos_bench.${CONDA_ENV_NAME}.build-stamp: $(MLOS_BENCH_PYTHON_FILES)
-build/pycodestyle.mlos_viz.${CONDA_ENV_NAME}.build-stamp: $(MLOS_VIZ_PYTHON_FILES)
+build/black.mlos_core.${CONDA_ENV_NAME}.build-stamp: $(MLOS_CORE_PYTHON_FILES)
+build/black.mlos_bench.${CONDA_ENV_NAME}.build-stamp: $(MLOS_BENCH_PYTHON_FILES)
+build/black.mlos_viz.${CONDA_ENV_NAME}.build-stamp: $(MLOS_VIZ_PYTHON_FILES)
 
-build/pycodestyle.%.${CONDA_ENV_NAME}.build-stamp: build/conda-env.${CONDA_ENV_NAME}.build-stamp setup.cfg
-	# Check for decent pep8 code style with pycodestyle.
-	# Note: if this fails, try using autopep8 to fix it.
-	conda run -n ${CONDA_ENV_NAME} pycodestyle $(filter-out setup.cfg,$+)
+build/black.%.${CONDA_ENV_NAME}.build-stamp: build/conda-env.${CONDA_ENV_NAME}.build-stamp setup.cfg
+	# Check for decent pep8 code style with black.
+	# Note: if this fails, try using black to fix it.
+	conda run -n ${CONDA_ENV_NAME} black --check $(filter-out setup.cfg,$+)
 	touch $@
 
 .PHONY: pydocstyle
@@ -528,9 +528,9 @@ clean-check:
 	rm -f build/pylint.${CONDA_ENV_NAME}.build-stamp
 	rm -f build/pylint.mlos_*.${CONDA_ENV_NAME}.build-stamp
 	rm -f build/mypy.mlos_*.${CONDA_ENV_NAME}.build-stamp
-	rm -f build/pycodestyle.build-stamp
-	rm -f build/pycodestyle.${CONDA_ENV_NAME}.build-stamp
-	rm -f build/pycodestyle.mlos_*.${CONDA_ENV_NAME}.build-stamp
+	rm -f build/black.build-stamp
+	rm -f build/black.${CONDA_ENV_NAME}.build-stamp
+	rm -f build/black.mlos_*.${CONDA_ENV_NAME}.build-stamp
 	rm -f build/pydocstyle.build-stamp
 	rm -f build/pydocstyle.${CONDA_ENV_NAME}.build-stamp
 	rm -f build/pydocstyle.mlos_*.${CONDA_ENV_NAME}.build-stamp

README.md

@@ -12,19 +12,19 @@ MLOS is a project to enable autotuning for systems.
 <!-- TOC -->
 
 - [MLOS](#mlos)
-    - [Contents](#contents)
-    - [Overview](#overview)
-    - [Organization](#organization)
-    - [Contributing](#contributing)
-    - [Getting Started](#getting-started)
-        - [conda activation](#conda-activation)
-        - [Usage Examples](#usage-examples)
-            - [mlos-core](#mlos-core)
-            - [mlos-bench](#mlos-bench)
-            - [mlos-viz](#mlos-viz)
-    - [Installation](#installation)
-    - [See Also](#see-also)
-        - [Examples](#examples)
+  - [Contents](#contents)
+  - [Overview](#overview)
+  - [Organization](#organization)
+  - [Contributing](#contributing)
+  - [Getting Started](#getting-started)
+    - [conda activation](#conda-activation)
+    - [Usage Examples](#usage-examples)
+      - [mlos-core](#mlos-core)
+      - [mlos-bench](#mlos-bench)
+      - [mlos-viz](#mlos-viz)
+  - [Installation](#installation)
+  - [See Also](#see-also)
+    - [Examples](#examples)
 
 <!-- /TOC -->
 

SECURITY.md

@@ -18,13 +18,13 @@ You should receive a response within 24 hours. If for some reason you do not, pl
 
 Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
 
-  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
+* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
 
 This information will help us triage your report more quickly.
 

conda-envs/mlos-3.10.yml

@@ -6,7 +6,7 @@ dependencies:
   # All other dependencies for the mlos modules come from pip.
   - pip
   - pylint
-  - pycodestyle
+  - black
   - pydocstyle
   - flake8
   - setuptools
@@ -24,18 +24,18 @@ dependencies:
   # See comments in mlos.yml.
   #- gcc_linux-64
   - pip:
-    - autopep8>=1.7.0
-    - bump2version
-    - check-jsonschema
-    - licenseheaders
-    - mypy
-    - pandas-stubs
-    - types-beautifulsoup4
-    - types-colorama
-    - types-jsonschema
-    - types-pygments
-    - types-requests
-    - types-setuptools
-    - "--editable ../mlos_core[full-tests]"
-    - "--editable ../mlos_bench[full-tests]"
-    - "--editable ../mlos_viz[full-tests]"
+      - autopep8>=1.7.0
+      - bump2version
+      - check-jsonschema
+      - licenseheaders
+      - mypy
+      - pandas-stubs
+      - types-beautifulsoup4
+      - types-colorama
+      - types-jsonschema
+      - types-pygments
+      - types-requests
+      - types-setuptools
+      - "--editable ../mlos_core[full-tests]"
+      - "--editable ../mlos_bench[full-tests]"
+      - "--editable ../mlos_viz[full-tests]"

conda-envs/mlos-3.11.yml

@@ -6,7 +6,7 @@ dependencies:
   # All other dependencies for the mlos modules come from pip.
   - pip
   - pylint
-  - pycodestyle
+  - black
   - pydocstyle
   - flake8
   - setuptools
@@ -24,18 +24,18 @@ dependencies:
   # See comments in mlos.yml.
   #- gcc_linux-64
   - pip:
-    - autopep8>=1.7.0
-    - bump2version
-    - check-jsonschema
-    - licenseheaders
-    - mypy
-    - pandas-stubs
-    - types-beautifulsoup4
-    - types-colorama
-    - types-jsonschema
-    - types-pygments
-    - types-requests
-    - types-setuptools
-    - "--editable ../mlos_core[full-tests]"
-    - "--editable ../mlos_bench[full-tests]"
-    - "--editable ../mlos_viz[full-tests]"
+      - autopep8>=1.7.0
+      - bump2version
+      - check-jsonschema
+      - licenseheaders
+      - mypy
+      - pandas-stubs
+      - types-beautifulsoup4
+      - types-colorama
+      - types-jsonschema
+      - types-pygments
+      - types-requests
+      - types-setuptools
+      - "--editable ../mlos_core[full-tests]"
+      - "--editable ../mlos_bench[full-tests]"
+      - "--editable ../mlos_viz[full-tests]"

conda-envs/mlos-3.8.yml

@@ -6,7 +6,7 @@ dependencies:
   # All other dependencies for the mlos modules come from pip.
   - pip
   - pylint
-  - pycodestyle
+  - black
   - pydocstyle
   - flake8
   - setuptools
@@ -24,18 +24,18 @@ dependencies:
   # See comments in mlos.yml.
   #- gcc_linux-64
   - pip:
-    - autopep8>=1.7.0
-    - bump2version
-    - check-jsonschema
-    - licenseheaders
-    - mypy
-    - pandas-stubs
-    - types-beautifulsoup4
-    - types-colorama
-    - types-jsonschema
-    - types-pygments
-    - types-requests
-    - types-setuptools
-    - "--editable ../mlos_core[full-tests]"
-    - "--editable ../mlos_bench[full-tests]"
-    - "--editable ../mlos_viz[full-tests]"
+      - autopep8>=1.7.0
+      - bump2version
+      - check-jsonschema
+      - licenseheaders
+      - mypy
+      - pandas-stubs
+      - types-beautifulsoup4
+      - types-colorama
+      - types-jsonschema
+      - types-pygments
+      - types-requests
+      - types-setuptools
+      - "--editable ../mlos_core[full-tests]"
+      - "--editable ../mlos_bench[full-tests]"
+      - "--editable ../mlos_viz[full-tests]"

conda-envs/mlos-3.9.yml

@@ -6,7 +6,7 @@ dependencies:
   # All other dependencies for the mlos modules come from pip.
   - pip
   - pylint
-  - pycodestyle
+  - black
   - pydocstyle
   - flake8
   - setuptools
@@ -24,18 +24,18 @@ dependencies:
   # See comments in mlos.yml.
   #- gcc_linux-64
   - pip:
-    - autopep8>=1.7.0
-    - bump2version
-    - check-jsonschema
-    - licenseheaders
-    - mypy
-    - pandas-stubs
-    - types-beautifulsoup4
-    - types-colorama
-    - types-jsonschema
-    - types-pygments
-    - types-requests
-    - types-setuptools
-    - "--editable ../mlos_core[full-tests]"
-    - "--editable ../mlos_bench[full-tests]"
-    - "--editable ../mlos_viz[full-tests]"
+      - autopep8>=1.7.0
+      - bump2version
+      - check-jsonschema
+      - licenseheaders
+      - mypy
+      - pandas-stubs
+      - types-beautifulsoup4
+      - types-colorama
+      - types-jsonschema
+      - types-pygments
+      - types-requests
+      - types-setuptools
+      - "--editable ../mlos_core[full-tests]"
+      - "--editable ../mlos_bench[full-tests]"
+      - "--editable ../mlos_viz[full-tests]"

conda-envs/mlos-windows.yml

@@ -9,7 +9,7 @@ dependencies:
   # All other dependencies for the mlos modules come from pip.
   - pip
   - pylint
-  - pycodestyle
+  - black
   - pydocstyle
   - flake8
   - setuptools
@@ -28,19 +28,19 @@ dependencies:
   # This also requires a more recent vs2015_runtime from conda-forge.
   - conda-forge::pyrfr>=0.9.0
   - pip:
-    - autopep8>=1.7.0
-    - bump2version
-    - check-jsonschema
-    - licenseheaders
-    - mypy
-    - pandas-stubs
-    - types-beautifulsoup4
-    - types-colorama
-    - types-jsonschema
-    - types-pygments
-    - types-requests
-    - types-setuptools
-    - pyarrow
-    - "--editable ../mlos_core[full-tests]"
-    - "--editable ../mlos_bench[full-tests]"
-    - "--editable ../mlos_viz[full-tests]"
+      - autopep8>=1.7.0
+      - bump2version
+      - check-jsonschema
+      - licenseheaders
+      - mypy
+      - pandas-stubs
+      - types-beautifulsoup4
+      - types-colorama
+      - types-jsonschema
+      - types-pygments
+      - types-requests
+      - types-setuptools
+      - pyarrow
+      - "--editable ../mlos_core[full-tests]"
+      - "--editable ../mlos_bench[full-tests]"
+      - "--editable ../mlos_viz[full-tests]"