IDE Configuration¶

PyCharm¶

PyCharm uses its own built-in linter; it doesn’t allow using external linters such as pylint. It will still catch common Python mistakes, but not the specific stbt checks like the example above.

VS Code¶

Run Python: Select Linter from the Command Palette (Control+Shift+P) and select pylint.

Next, add the following pylint args in .vscode/settings.json:

"python.linting.pylintArgs": ["--load-plugins=stbt.pylint_plugin"],

Disabling annoying pylint warnings¶

Some of Pylint’s built-in checks are related to coding style, not real problems. You can disable specific checks by listing them in the .pylintrc file in the root of your test-pack. For example:

[MESSAGES CONTROL]
disable=
  line-too-long,
  missing-docstring,

The name of each checker (such as “line-too-long”) is shown after the error message in your IDE.

PyCharm¶

In Preferences > Plugins install the File Watchers plugin.

Now in Preferences > Tools > File Watchers add a new watcher with the following settings:

• Name: stbt_rig snapshot
• File type: Any
• Scope: Project Files
• Program: python
• Arguments: -m stbt_rig -v snapshot
• Working directory: path to your test-pack checkout

VS Code¶

In VS Code’s Extensions Marketplace (Ctrl+Shift+X) install the Run on Save extension by pucelle (or any of the dozens of similar extensions if you have a favourite, but you’ll need to change the configuration below to match your chosen extension):

Next, add this to .vscode/settings.json:

"runOnSave.commands": [
    {
        "match": ".*\\.py$",
        "command": "${workspaceFolder}/.venv/bin/python -m stbt_rig -v snapshot",
        "runIn": "terminal",
        "runningStatusMessage": "Running stbt_rig snapshot...",
        "finishStatusMessage": "Snapshot complete"
    }
],

PyCharm¶

First go to File > Settings and select Tools > Python Integrated Tools. Under Testing: Default test runner select pytest. Click OK.

Next, go to Run > Edit Configurations and select Templates > Python tests > pytest. Fill in the following settings:

• Target: Module name
• Additional Arguments: -p stbt_rig --node-id=stb-tester-123456789abc
• Add content roots to PYTHONPATH: True

(Change “stb-tester-123456789abc” to the actual ID of your Stb-tester Node.)

Note that you aren’t creating a new configuration (don’t click the little “+” icon on the left-hand pane). You are editing the Template from which PyCharm creates new configurations on the fly for each test.

The configuration should now look like:

You can now run the current test with Ctrl-Shift-F10 or by clicking the green play button in the margin on the left and selecting “Run ‘pytest for …’”:

VS Code¶

Run Python: Configure Tests from the Command Palette (Control+Shift+P) and select pytest. When it asks for the directory containing the tests, choose tests.

Now open .vscode/settings.json and change python.testing.pytestArgs to this:

"python.testing.pytestArgs": [
    "-p", "stbt_rig", "--node-id=stb-tester-123456789abc",
    "--override-ini=python_files=*.py",
    "--override-ini=python_functions=test_*",
    "--tb=no", "--capture=no",
    "tests"
],

(Change “stb-tester-123456789abc” to the actual ID of your Stb-tester Node.)

Now run Python: Discover Tests from the Command Palette (Control+Shift+P) to identify each test. This adds a little “Run Test” button just above each testcase:

After the test finishes, its output appears in the Output window: View > Output (Control+K Control+H) and select Python Test Log.

VS Code¶

After following all the instructions above, your .vscode/settings.json should look like this:

{
    "python.linting.pylintEnabled": true,
    "python.linting.enabled": true,
    "python.linting.pylintArgs": ["--load-plugins=stbt.pylint_plugin"],

    "runOnSave.commands": [
        {
            "match": ".*\\.py$",
            "command": "${workspaceFolder}/.venv/bin/python -m stbt_rig -v snapshot",
            "runIn": "terminal",
            "runningStatusMessage": "Running stbt_rig snapshot...",
            "finishStatusMessage": "Snapshot complete"
        }
    ],

    "python.testing.pytestArgs": [
        "-p", "stbt_rig", "--node-id=stb-tester-123456789abc",
        "--override-ini=python_files=*.py",
        "--override-ini=python_functions=test_*",
        "--tb=no", "--capture=no",
        "tests"
    ],
    "python.testing.unittestEnabled": false,
    "python.testing.nosetestsEnabled": false,
    "python.testing.pytestEnabled": true
}