Check formatting of Python code in AzDO pipelines (#9743)

* Check formatting of Python code in AzDO pipelines
* Buy one double quote get one free 💥
* Update contributing guide
* Install black as part of CI
* Undo small change
* Install pip and black when formatting Python code
* Install pip in initialization step (for all steps)
* Remove pip install condition
* New Python files since my formatting pass LOL

Author: kimadeline

CONTRIBUTING.md

@@ -38,6 +38,8 @@ npm ci
 python3 -m venv .venv
 # Activate the virtual environment as appropriate for your shell, For example ...
 source .venv/bin/activate
+# The Python code in the extension is formatted using Black.
+python3 -m pip install black
 # Install Python dependencies using `python3`.
 # If you want to use a different interpreter then specify it in the
 # CI_PYTHON_PATH environment variable.

build/ci/templates/jobs/build_compile.yml

@@ -36,9 +36,15 @@ jobs:
       workingDirectory: $(Build.SourcesDirectory)
 
     - bash: npx prettier "src/**/*.ts*" --check
-      displayName: "Code Format"
+      displayName: "Code Format (TypeScript)"
       workingDirectory: $(Build.SourcesDirectory)
 
     - bash: npx prettier "build/**/*.js" --check
-      displayName: "Code Format"
+      displayName: "Code Format (JavaScript)"
       workingDirectory: $(Build.SourcesDirectory)
+
+    - bash: |
+            python -m pip install -U black
+            python -m black . --check
+      displayName: "Code Format (Python)"
+      workingDirectory: $(Build.SourcesDirectory)/pythonFiles

build/ci/templates/steps/build.yml

@@ -19,7 +19,6 @@ steps:
           compile: 'false'
 
     - bash: |
-          python -m pip install -U pip
           python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
           python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
           python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/new_ptvsd/no_wheels --no-cache-dir --implementation py --no-deps --upgrade --pre ptvsd

build/ci/templates/steps/initialization.yml

@@ -120,6 +120,9 @@ steps:
       displayName: 'Start Display Server (xvfb) to launch VS Code)'
       condition: and(succeeded(), eq(variables['Agent.Os'], 'Linux'))
 
+    - bash: python -m pip install -U pip
+      displayName: 'Install pip'
+
     # # Show all versions installed/available on PATH if in verbose mode.
     # # Example command line (windows pwsh):
     # # > Write-Host Node ver: $(& node -v) NPM Ver: $(& npm -v) Python ver: $(& python --version)"

build/ci/templates/test_phases.yml

@@ -93,7 +93,6 @@ steps:
     # > python -m pip install --upgrade -r build/test-requirements.txt
     # > python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
     - bash: |
-          python -m pip install -U pip
           python -m pip install --upgrade -r build/test-requirements.txt
           python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
           python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python/old_ptvsd --no-cache-dir --implementation py --no-deps --upgrade 'ptvsd==4.3.2'
@@ -119,7 +118,6 @@ steps:
     # > python -m pip install --upgrade -r build/functional-test-requirements.txt
     # > python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
     - bash: |
-          python -m pip install -U pip
           python -m pip install numpy
           python -m pip install --upgrade -r ./build/functional-test-requirements.txt
       displayName: 'pip install functional requirements'
@@ -142,7 +140,6 @@ steps:
     # > python -m pip install --upgrade -r build/ipython-test-requirements.txt
     # > python -m pip --disable-pip-version-check install -t ./pythonFiles/lib/python --no-cache-dir --implementation py --no-deps --upgrade -r requirements.txt
     - bash: |
-          python -m pip install -U pip
           python -m pip install numpy
           python -m pip install --upgrade -r ./build/ipython-test-requirements.txt
       displayName: 'pip install ipython requirements'

news/3 Code Health/2012.md

@@ -1 +1 @@
-Use [prettier](https://prettier.io/) as the formatter for `TypeScript` code within the extension.
+Use [prettier](https://prettier.io/) as the `TypeScript` formatter and [Black](https://github.com/psf/black) as the `Python` formatter within the extension.

pythonFiles/printEnvVariablesToFile.py

@@ -9,5 +9,5 @@
 # Last argument is the target file into which we'll write the env variables as json.
 json_file = sys.argv[-1]
 
-with open(json_file, 'w') as outfile:
+with open(json_file, "w") as outfile:
     json.dump(dict(os.environ), outfile)

pythonFiles/pyproject.toml

@@ -0,0 +1,11 @@
+[tool.black]
+exclude = '''
+
+(
+  /(
+    .data
+    | .vscode
+    | lib
+  )/
+)
+'''

pythonFiles/shell_exec.py

@@ -37,7 +37,7 @@
         fp.flush()
         try:
             # ALso log the error for use from the other side.
-            with open(lock_file + '.error', 'w') as fpError:
+            with open(lock_file + ".error", "w") as fpError:
                 fpError.write(traceback.format_exc())
         except Exception:
             pass