fix lint

Author: paulacamargo25

.flake8

@@ -0,0 +1,14 @@
+[flake8]
+ignore = W,BLK,
+    E24,E121,E123,E125,E126,E221,E226,E266,E704,
+    E265,E722,E501,E731,E306,E401,E302,E222,E303,
+    E402,E305,E261,E262,E203
+exclude =
+    __pycache__,
+    .eggs,
+    .git,
+    .tox,
+    .nox,
+    build,
+    dist,
+    src/test/python_tests/test_data

.vscode/settings.json

@@ -6,8 +6,17 @@
     },
     "search.exclude": {
         "out": true, // set this to false to include "out" folder in search results
-        "dist": true // set this to false to include "dist" folder in search results
+        "dist": true, // set this to false to include "dist" folder in search results
+        ".venv": true,
+        ".nox": true
     },
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off"
-}
+    "typescript.tsc.autoDetect": "off",
+    "python.testing.pytestArgs": ["src/test/python_tests"],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.cwd": "${workspaceFolder}",
+    "python.linting.flake8Enabled": true,
+    "python.formatting.provider": "black",
+    "editor.formatOnSave": true
+}

noxfile.py

@@ -1,16 +1,16 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 """All the action we need during build"""
+import io
 import json
 import os
-import io
 import pathlib
 import re
 import urllib.request as url_lib
 import zipfile
-from typing import List
 
-import nox # pylint: disable=import-error
+import nox  # pylint: disable=import-error
+
 
 def _install_bundle(session: nox.Session) -> None:
     session.install(
@@ -28,15 +28,6 @@ def _install_bundle(session: nox.Session) -> None:
     _install_package(f"{os.getcwd()}/bundled/libs", "debugpy")
 
 
-def _check_files(names: List[str]) -> None:
-    root_dir = pathlib.Path(__file__).parent
-    for name in names:
-        file_path = root_dir / name
-        lines: List[str] = file_path.read_text().splitlines()
-        if any(line for line in lines if line.startswith("# TODO:")):
-            raise Exception(f"Please update {os.fspath(file_path)}.")
-
-
 def _update_pip_packages(session: nox.Session) -> None:
     session.run("pip-compile", "--generate-hashes", "--upgrade", "./requirements.in")
     session.run(
@@ -46,6 +37,26 @@ def _update_pip_packages(session: nox.Session) -> None:
         "./src/test/python_tests/requirements.in",
     )
 
+
+@nox.session()
+def lint(session: nox.Session) -> None:
+    """Runs linter and formatter checks on python files."""
+
+    session.install("flake8")
+    session.run("flake8", "noxfile.py")
+
+    # check formatting using black
+    session.install("black")
+    session.run("black", "--check", "noxfile.py")
+
+    # check import sorting using isort
+    session.install("isort")
+    session.run("isort", "--check", "noxfile.py")
+
+    # check typescript code
+    session.run("npm", "run", "lint", external=True)
+
+
 @nox.session()
 def tests(session: nox.Session) -> None:
     """Runs all the tests for the extension."""
@@ -117,56 +128,27 @@ def setup(session: nox.Session) -> None:
     """Sets up the extension for development."""
     _setup_template_environment(session)
 
-@nox.session()
-def validate_readme(session: nox.Session) -> None:
-    """Ensures the linter version in 'requirements.txt' matches 'readme.md'."""
-    requirements_file = pathlib.Path(__file__).parent / "requirements.txt"
-    readme_file = pathlib.Path(__file__).parent / "README.md"
-
-    lines = requirements_file.read_text(encoding="utf-8").splitlines(keepends=False)
-    module = _get_module_name()
-    linter_ver = list(line for line in lines if line.startswith(module))[0]
-    name, version = linter_ver.split(" ")[0].split("==")
-
-    session.log(f"Looking for {name}={version} in README.md")
-    content = readme_file.read_text(encoding="utf-8")
-    if f"{name}={version}" not in content:
-        raise ValueError(f"Linter info {name}={version} was not found in README.md.")
-    session.log(f"FOUND {name}={version} in README.md")
-
-
-def _update_readme() -> None:
-    requirements_file = pathlib.Path(__file__).parent / "requirements.txt"
-    lines = requirements_file.read_text(encoding="utf-8").splitlines(keepends=False)
-    module = _get_module_name()
-    linter_ver = list(line for line in lines if line.startswith(module))[0]
-    _, version = linter_ver.split(" ")[0].split("==")
-
-    readme_file = pathlib.Path(__file__).parent / "README.md"
-    content = readme_file.read_text(encoding="utf-8")
-    regex = r"\`([a-zA-Z0-9]+)=([0-9]+\.[0-9]+\.[0-9]+)\`"
-    result = re.sub(regex, f"`{module}={version}`", content, 0, re.MULTILINE)
-    content = readme_file.write_text(result, encoding="utf-8")
-
 
 @nox.session()
 def update_packages(session: nox.Session) -> None:
     """Update pip and npm packages."""
     session.install("wheel", "pip-tools")
     _update_pip_packages(session)
     _update_npm_packages(session)
-    _update_readme()
+
 
 def _contains(s, parts=()):
     return any(p for p in parts if p in s)
 
+
 def _get_pypi_package_data(package_name):
     json_uri = "https://pypi.org/pypi/{0}/json".format(package_name)
     # Response format: https://warehouse.readthedocs.io/api-reference/json/#project
     # Release metadata format: https://github.com/pypa/interoperability-peps/blob/master/pep-0426-core-metadata.rst
     with url_lib.urlopen(json_uri) as response:
         return json.loads(response.read())
 
+
 def _get_urls(data, version):
     return list(
         r["url"] for r in data["releases"][version] if _contains(r["url"], ("cp37",))
@@ -185,6 +167,7 @@ def _download_and_extract(root, url, version):
                 print("\t" + zip_info.filename)
                 wheel.extract(zip_info.filename, root)
 
+
 def _install_package(root, package_name, version="latest"):
     from packaging.version import parse as version_parser
 
@@ -198,6 +181,7 @@ def _install_package(root, package_name, version="latest"):
     for url in _get_urls(data, use_version):
         _download_and_extract(root, url, use_version)
 
+
 @nox.session()
 def update_build_number(session: nox.Session) -> None:
     """Updates build number for the extension."""
@@ -218,4 +202,4 @@ def update_build_number(session: nox.Session) -> None:
 
     session.log(f"Updating version from {package_json['version']} to {version}")
     package_json["version"] = version
-    package_json_path.write_text(json.dumps(package_json, indent=4), encoding="utf-8")
+    package_json_path.write_text(json.dumps(package_json, indent=4), encoding="utf-8")