{"id":36565,"date":"2018-07-30T08:00:45","date_gmt":"2018-07-30T08:00:45","guid":{"rendered":"https:\/\/fedoramagazine.org\/?p=21995"},"modified":"2018-07-30T08:00:45","modified_gmt":"2018-07-30T08:00:45","slug":"how-to-use-vs-code-for-your-python-projects","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2018\/07\/30\/how-to-use-vs-code-for-your-python-projects\/","title":{"rendered":"How to use VS Code for your Python projects"},"content":{"rendered":"

Visual Studio Code, or VS Code,<\/em> is an open source code editor that also includes tools for building and debugging an application. With the Python extension enabled,\u00a0vscode<\/em> becomes a great working environment for any Python developer. This article shows you which extensions are useful, and how to configure VS Code\u00a0to get the most out of it.<\/p>\n

<\/span><\/p>\n

If you don’t have it\u00a0installed, check out our previous article, Using Visual Studio Code on Fedora<\/a>:<\/p>\n

\n

Using Visual Studio Code on Fedora<\/a><\/p>\n<\/blockquote>\n

Install the VS Code Python extension<\/h3>\n

First, to make VS Code Python friendly, install the Python extension from the marketplace.<\/p>\n

\"\"<\/p>\n

Once the Python extension installed, you can now configure the Python extension.<\/p>\n

VS Code manages its configuration inside JSON files. Two files are used:<\/p>\n

    \n
  • One for the global settings that applies to all projects<\/li>\n
  • One for project specific settings<\/li>\n<\/ul>\n

    Press Ctrl+,<\/strong> (comma) to open the global settings.<\/p>\n

    Setup the Python Path<\/h4>\n

    You can configure VS Code to automatically select the best Python interpreter for each of your projects. To do this, configure the python.pythonPath<\/em>\u00a0key in the global settings.<\/p>\n

    \/\/ Place your settings in this file to overwrite default and user settings. { \"python.pythonPath\":\"${workspaceRoot}\/.venv\/bin\/python\", }<\/pre>\n
    This sets\u00a0VS Code to use the Python interpreter located in the project root directory under the .venv<\/em> virtual environment directory.<\/p>\n
    Use environment variables<\/h4>\n
    By default,\u00a0VS Code uses environment variables defined in the project root directory in a .env<\/em>\u00a0file. This is useful to set environment variables like:<\/p>\n
    PYTHONWARNINGS=\"once\"<\/pre>\n
    That setting ensures that warnings are displayed when your program is running.<\/p>\n
    To change this default, set the python.envFile <\/em>configuration key as follows:<\/p>\n
    \n
    \"python.envFile\": \"${workspaceFolder}\/.env\",<\/pre>\n<\/div>\n
    Code Linting<\/h3>\n
    The Python extension also supports different code linters (pep8<\/em>, flake8<\/em>, pylint<\/em>). To enable your favorite linter, or the one used by the project you’re working on, you need to set a few configuration items.<\/p>\n
    By default\u00a0pylint <\/em>is enabled. But for this example, configure flake8:<\/em><\/p>\n
    \n
    \"python.linting.pylintEnabled\": false, \"python.linting.flake8Path\": \"${workspaceRoot}\/.venv\/bin\/flake8\", \"python.linting.flake8Enabled\": true, \"python.linting.flake8Args\": [\"--max-line-length=90\"],<\/pre>\n<\/div>\n
    After enabling the linter, your code is underlined to show where it doesn’t meet criteria enforced by the linter. Note that for this example to work, you need to install flake8<\/em> in the virtual environment of the project.<\/p>\n
    \"\"<\/p>\n
    Code Formatting<\/h3>\n
    VS Code also lets you configure automatic code formatting. The extension currently supports autopep8<\/em>, black<\/em> and yapf<\/em>. Here’s how to configure black<\/em>.<\/p>\n
    \n
    \"python.formatting.provider\": \"black\", \"python.formatting.blackPath\": \"${workspaceRoot}\/.venv\/bin\/black\" \"python.formatting.blackArgs\": [\"--line-length=90\"], \"editor.formatOnSave\": true,<\/pre>\n<\/div>\n
    If you don’t want the editor to format your file on save,\u00a0 set the option to false<\/em> and use Ctrl+Shift+I<\/strong> to format the current document. Note that for this example to work, you need to install black<\/em> in the virtual environment of the project.<\/p>\n
    Running Tasks<\/h3>\n
    Another great feature of VS Code is that it can run tasks. These tasks are also defined in a JSON file saved in the project root directory.<\/p>\n
    Run a development flask server<\/h4>\n
    In this example, you’ll create a task to run a Flask development server. Create a new Build using the basic template that can run an external command:<\/p>\n
    \"\"<\/p>\n
    Edit the tasks.json<\/em> file as follows to create a new task that runs the Flask<\/em> development server:<\/p>\n
    \n
    { \/\/ See https:\/\/go.microsoft.com\/fwlink\/?LinkId=733558 \/\/ for the documentation about the tasks.json format \"version\": \"2.0.0\", \"tasks\": [ { \"label\": \"Run Debug Server\", \"type\": \"shell\", \"command\": \"${workspaceRoot}\/.venv\/bin\/flask run -h 0.0.0.0 -p 5000\", \"group\": { \"kind\": \"build\", \"isDefault\": true } } ] }<\/pre>\n<\/div>\n
    The Flask development server uses an environment variable to get the entrypoint of the application. Use the .env <\/em>file to declare these variables. For example:<\/p>\n
    FLASK_APP=wsgi.py FLASK_DEBUG=True<\/pre>\n
    Now you can execute the task using Ctrl+Shift+B<\/strong>.<\/p>\n
    Unit tests<\/h3>\n
    VS Code also has the\u00a0unit test runners\u00a0pytest, unittest,\u00a0<\/em>and nosetest<\/em>\u00a0integrated out of the box. After you enable a test runner, VS Code discovers the unit tests and letsyou to run them individually, by test suite, or simply all the tests.<\/p>\n
    For example, to enable pytest:<\/em><\/p>\n
    \n
    \"python.unitTest.pyTestEnabled\": true, \"python.unitTest.pyTestPath\": \"${workspaceRoot}\/.venv\/bin\/pytest\",<\/pre>\n<\/div>\n
    Note that for this example to work, you need to install pytest<\/em> in the virtual environment of the project.<\/p>\n
    \"\"<\/p>\n","protected":false},"excerpt":{"rendered":"
    Visual Studio Code, or VS Code, is an open source code editor that also includes tools for building and debugging an application. With the Python extension enabled,\u00a0vscode becomes a great working environment for any Python developer. This article shows you which extensions are useful, and how to configure VS Code\u00a0to get the most out of […]<\/p>\n","protected":false},"author":2,"featured_media":36566,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[48],"tags":[45,42,46,47],"class_list":["post-36565","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-fedora-os","tag-fedora","tag-for-developers","tag-magazine","tag-news"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/36565","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=36565"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/36565\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media\/36566"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=36565"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=36565"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=36565"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}