PyCharm
 
2022.2
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Run, debug, test, and deploy
  2. Test
  3. BDD Testing Framework
  4. Create step definitions

Create step definitions

Last modified: 17 March 2022

Professional feature: download PyCharm Professional to try.

Creating step definition

If a .feature file refers to a non-existent step, PyCharm recognizes and highlights such a step, and provides an intention action that helps create the missing step definition.

To create a missing step definition

  1. While editing the .feature file, type a reference to a step definition. PyCharm highlights step as undefined, and gives detailed information at the tooltip:

    cucumberUndefinedStepInspection

  2. Press Alt+Enter to show the Create Step Definition intention action:

    cucumberCreateStepDefinition

  3. Select the target step definition file from the list:

    Py create undefined step

    You can either select one of the existing step definition files from the suggestion list, or create a new one.

    PyCharm creates a step definition stub in the specified location.

  4. In the selected step definition file that opens in the editor, enter the desired code.

Tips and tricks

  • While typing, use code completion Ctrl+Space after keywords. Note that you can narrow down the suggestion list by typing characters contained anywhere within a description. On top of the suggestion list there will be the variants that contain specified characters as prefixes, followed by the variants with the arbitrary occurrences of characters:

    Py gherkin code completion

  • You can find usages of a step definition. To do that, place the caret at the desired definition, and press Alt+F7. Refer to the section Find usages in a project for details.

  • PyCharm keeps an eye on the uniqueness of the step definitions. Step definitions with the same names are highlighted.

    Py duplicated step definition

See also

Procedures

External Links