Python

Below are visualizations of all our scope tests for this language. These were created primarily for testing purposes rather than as documentation. There are quite a few, and they may feel a bit overwhelming from a documentation standpoint.

Scopes

Content rangeRemoval rangeBlended rangesRender whitespace

Anonymous function

1. Anonymous function

An anonymous function, eg a lambda function, an arrow function, etc.

Argument list

1. Argument list: Actual constructor empty

An empty list of arguments in a constructor call. Insertion delimiter should be empty.

2. Argument list: Actual constructor multi line

A multi-line list of arguments in a constructor call. Insertion delimiter should include a newline.

3. Argument list: Actual constructor single line

A single-line list of arguments in a constructor call

4. Argument list: Actual empty

An empty list of arguments in a function call. Insertion delimiter should be empty.

5. Argument list: Actual method empty

An empty list of arguments in a method call. Insertion delimiter should be empty.

6. Argument list: Actual method multi line

A multi-line list of arguments in a method call. Insertion delimiter should include a newline.

7. Argument list: Actual method single line

A single-line list of arguments in a method call

8. Argument list: Actual multi line

A multi-line list of arguments in a function call. Insertion delimiter should include a newline.

9. Argument list: Actual single line

A single-line list of arguments in a function call

10. Argument list: Formal constructor empty

An empty list of parameters in a constructor declaration. Insertion delimiter should be empty.

11. Argument list: Formal constructor multi line

A multi-line list of parameters in a constructor declaration. Insertion delimiter should include a newline.

12. Argument list: Formal constructor single line

A single-line list of parameters in a constructor declaration

13. Argument list: Formal empty

An empty list of parameters in a function declaration. Insertion delimiter should be empty.

14. Argument list: Formal lambda empty

An empty list of parameters in an anonymous function. Insertion delimiter should be empty.

15. Argument list: Formal lambda single line

A single-line list of parameters in an anonymous function

16. Argument list: Formal method empty

An empty list of parameters in a method declaration. Insertion delimiter should be empty.

17. Argument list: Formal method multi line

A multi-line list of parameters in a method declaration. Insertion delimiter should include a newline.

18. Argument list: Formal method single line

A single-line list of parameters in a method declaration

19. Argument list: Formal multi line

A multi-line list of parameters in a function declaration. Insertion delimiter should include a newline.

20. Argument list: Formal single line

A single-line list of parameters in a function declaration

Argument or parameter

1. Argument: Actual constructor multi line

A multi-line argument in a constructor call. Insertion delimiter should include a newline.

2. Argument: Actual constructor single line

A single-line argument in a constructor call

3. Argument: Actual method multi line

A multi-line argument in a method call. Insertion delimiter should include a newline.

4. Argument: Actual method single line

A single-line argument in a method call

5. Argument: Actual multi line

A multi-line argument in a function call. Insertion delimiter should include a newline.

6. Argument: Actual single line

A single-line argument in a function call

7. Argument: Formal catch

A parameter in a catch clause

8. Argument: Formal constructor multi line

A multi-line parameter in a constructor declaration. Insertion delimiter should include a newline.

9. Argument: Formal constructor single line

A single-line parameter in a constructor declaration

10. Argument: Formal lambda single line

A single-line parameter in an anonymous function

11. Argument: Formal method multi line

A multi-line parameter in a method declaration. Insertion delimiter should include a newline.

12. Argument: Formal method single line

A single-line parameter in a method declaration

13. Argument: Formal multi line

A multi-line parameter in a function declaration. Insertion delimiter should include a newline.

14. Argument: Formal single line

A single-line parameter in a function declaration

15. Argument: Actual (iteration)

Iteration scope for arguments in a function call: the argument list. The domain should be the entire function call.

16. Argument: Actual constructor (iteration)

Iteration scope for arguments in a constructor call: the argument list. The domain should be the entire constructor call..

17. Argument: Actual method (iteration)

Iteration scope for arguments in a method call: the argument list. The domain should be the entire method call.

18. Argument: Formal (iteration)

Iteration scope for parameters in a function declaration: the parameter list. The domain should be the entire function.

19. Argument: Formal constructor (iteration)

Iteration scope for parameters in a constructor declaration: the parameter list. The domain should be the entire constructor.

20. Argument: Formal lambda (iteration)

Iteration scope for parameters in an anonymous function: the parameter list. The domain should be the entire anonymous function.

21. Argument: Formal method (iteration)

Iteration scope for parameters in a method declaration: the parameter list. The domain should be the entire method.

Branch

1. Branch: If

An if branch

2. Branch: If elif else

An if-elif-else branch. The removal range for the if branch should include the trailing else keyword.

3. Branch: If else

An if-else branch

4. Branch: Loop

A for / while loop branch. For most languages this is not supported, but eg in Python you can have an else branch for a loop.

5. Branch: Switch case

A case/default branch in a switch statement

6. Branch: Ternary

A branch in a ternary expression

7. Branch: Try

A try/catch/finally branch

8. Branch: If (iteration)

Iteration scope for if/elif/else branches: the if/elif/else statement.

9. Branch: Loop (iteration)

Iteration scope for loop branches: the loop statement.

10. Branch: Switch case (iteration)

Iteration scope for case/default branches in a switch statement: the switch statement body.

11. Branch: Ternary (iteration)

Iteration scope for ternary expression branches: the ternary expression.

12. Branch: Try (iteration)

Iteration scope for try/catch/finally branches: the try/catch/finally statement.

Class

1. Class

A class/struct declaration

2. Class (iteration class)

Iteration scope for classes: class bodies.

3. Class (iteration document)

Iteration scope for classes: the entire document including leading and trailing empty lines.

Collection item

1. Collection item: Unenclosed single line

An item in a comma-separated single-line list without enclosing delimiters. This could be multi-variable declarations, import statements, etc.

2. Collection item: Unenclosed (iteration)

Iteration scope for items in a comma-separated list without enclosing delimiters

Collection key

1. Key: Map pair

Key (LHS) of a key-value pair in a map

2. Key: Map pair (iteration)

Iteration scope for keys of key-value pairs in a map: should be between the braces.

Comment

1. Comment: Line

A line comment

Condition

1. Condition: If

A condition in an if statement

2. Condition: Switch case

A condition in a switch statement

3. Condition: Ternary

A condition in a ternary expression

4. Condition: While

A condition in a while loop

5. Condition: Switch case (iteration)

Iteration scope for conditions in a switch statement: the switch statement body.

Function call

1. Function call

A function call

2. Function call: Chain

A chain of function calls, eg foo().bar()

3. Function call: Constructor

A constructor call

4. Function call: Method

A method call

Function callee

1. Function callee

The function being called in a function call

2. Function callee: Chain

The function being called in a chain of function calls, including parent objects.

3. Function callee: Constructor

The class being constructed in a class instantiation, including the new keyword.

4. Function callee: Method

The function being called in a method call, including parent objects.

If statement

1. If statement

An if statement

Interior

1. Interior: Class

The body of a class/struct declaration

2. Interior: Constructor

The body of a constructor declaration

3. Interior: Foreach

The body of a for-each loop

4. Interior: Function

The body of a function declaration

5. Interior: If

The body of an if/elif/else branch

6. Interior: Method

The body of a method declaration

7. Interior: Resource

The body of a resource management statement, eg with / use / using

8. Interior: Switch

The body of a switch statement

9. Interior: Switch case

The body of a case/default branch in a switch statement

10. Interior: Try

The body of a try/catch/finally branch

11. Interior: While

The body of a while loop

List

1. List

A list/array

Map

1. Map

A map/dictionary

Name

1. Name: Argument actual

Name of a (keyword) argument in a function call

2. Name: Argument catch

Name of a parameter in a catch clause

3. Name: Argument formal

Name of a parameter in a function declaration

4. Name: Argument formal constructor

Name of a parameter in a constructor declaration

5. Name: Argument formal lambda

Name of a parameter in an anonymous function

6. Name: Argument formal method

Name of a parameter in a method declaration

7. Name: Assignment

Name (LHS) of an assignment statement

8. Name: Assignment compound

Name (LHS) of a compound assignment statement, eg +=/-=

9. Name: Assignment destructuring

Name (LHS) of an assignment statement using a destructuring pattern

10. Name: Class

Name of a class/struct declaration

11. Name: Constructor

Name of a constructor declaration

12. Name: Field class

Name (LHS) of a field declaration in a class/struct

13. Name: Foreach

Iteration variable name in a for-each loop

14. Name: Function

Name of a function declaration

15. Name: Method

Name of a method declaration

16. Name: Resource

Name in a resource management statement, eg with / use / using

17. Name: Variable destructuring

Name (LHS) of a variable declaration using a destructuring pattern

18. Name: Variable initialized

Name (LHS) of an initialized variable declaration

19. Name: Variable uninitialized

Name (LHS) of an uninitialized variable declaration

20. Name (iteration block)

Iteration scope for names: statement blocks (body of functions/if-statements/for-loops/etc).

21. Name (iteration class)

Iteration scope for names: class bodies.

22. Name (iteration document)

Iteration scope for names: the entire document including leading and trailing empty lines.

23. Name: Argument actual (iteration)

Iteration scope for names of (keyword) arguments in a function call: the argument list.

24. Name: Argument formal (iteration)

Iteration scope for names of parameters in a function declaration: the parameter list.

25. Name: Argument formal constructor (iteration)

Iteration scope for names of parameters in a constructor declaration: the parameter list.

26. Name: Argument formal lambda (iteration)

Iteration scope for names of parameters in an anonymous function: the parameter list.

27. Name: Argument formal method (iteration)

Iteration scope for names of parameters in a method declaration: the parameter list.

Named function

1. Named function

A named function declaration

2. Named function: Constructor

A constructor declaration

3. Named function: Method

A method declaration

4. Named function (iteration class)

Iteration scope for named functions: class bodies.

5. Named function (iteration document)

Iteration scope for named functions: the entire document including leading and trailing empty lines.

Statement

1. Statement: Assignment

An assignment statement

2. Statement: Assignment compound

A compound assignment statement, eg +=/-=

3. Statement: Assignment destructuring

An assignment statement using a destructuring pattern

4. Statement: Break

A break statement

5. Statement: Class

A class/struct declaration

6. Statement: Constructor

A constructor declaration

7. Statement: Continue

A continue statement

8. Statement: Field class

A field declaration in a class/struct

9. Statement: Foreach

A for-each loop

10. Statement: Function

A named function declaration

11. Statement: Function call

A function call statement

12. Statement: If

An if/elif/else statement

13. Statement: Import

An import statement

14. Statement: Method

A method declaration

15. Statement: Resource

A resource management statement, eg with / use / using

16. Statement: Return

A return statement

17. Statement: Switch

A switch statement

18. Statement: Throw

A throw statement

19. Statement: Try

A try/catch/finally statement

20. Statement: Variable destructuring

A variable declaration using a destructuring pattern, eg const { x, y } = point

21. Statement: Variable initialized

An initialized variable declaration

22. Statement: Variable uninitialized

An uninitialized variable declaration

23. Statement: While

A while loop

24. Statement: Yield

A yield statement

25. Statement (iteration block)

Iteration scope for statements: statement blocks (body of functions/if-statements/for-loops/etc).

26. Statement (iteration class)

Iteration scope for statements: class bodies.

27. Statement (iteration document)

Iteration scope for statements: the entire document including leading and trailing empty lines.

Type

1. Type: Argument catch

Type of a parameter in a catch clause

2. Type: Argument formal

Type of a parameter in a function declaration

3. Type: Argument formal constructor

Type of a parameter in a constructor declaration

4. Type: Argument formal method

Type of a parameter in a method declaration

5. Type: Class

A class/struct declaration

6. Type: Field class

Type of a field declaration in a class/struct

7. Type: Return

Type of a return value in a function declaration

8. Type: Return method

Type of a return value in a method declaration

9. Type: Type argument

Type argument to a generic / parametrized type

10. Type: Variable initialized

Type of an initialized variable declaration

11. Type: Variable uninitialized

Type of an uninitialized variable declaration

12. Type (iteration block)

Iteration scope for types: statement blocks (body of functions/if-statements/for-loops/etc).

13. Type (iteration class)

Iteration scope for types: class bodies.

14. Type (iteration document)

Iteration scope for types: the entire document including leading and trailing empty lines.

15. Type: Argument formal (iteration)

Iteration scope for types of parameters in a function declaration: the parameter list.

16. Type: Argument formal constructor (iteration)

Iteration scope for types of parameters in a constructor declaration: the parameter list.

17. Type: Argument formal method (iteration)

Iteration scope for types of parameters in a method declaration: the parameter list.

18. Type: Type argument (iteration)

Iteration scope for type arguments to a generic / parametrized type: the type argument list.

Value

1. Value: Argument actual

Value of a (keyword) argument in a function call

2. Value: Argument formal

Default value of a parameter in a function declaration

3. Value: Argument formal constructor

Default value of a parameter in a constructor declaration

4. Value: Argument formal lambda

Default value of a parameter in an anonymous function

5. Value: Argument formal method

Default value of a parameter in a method declaration

6. Value: Assignment

Value (RHS) of an assignment statement

7. Value: Assignment compound

Value (RHS) of a compound assignment statement, eg +=/-=

8. Value: Assignment destructuring

Value (RHS) of an assignment statement using a destructuring pattern

9. Value: Field class

Value (RHS) of a field declaration in a class/struct

10. Value: Foreach

Iterable in a for-each loop

11. Value: Map pair

Value (RHS) of a key-value pair in a map

12. Value: Return

Return value of a function

13. Value: Return lambda

Implicit return value of an anonymous function

14. Value: Switch

Value / subject of a switch statement

15. Value: Throw

Value of a throw statement

16. Value: Variable

Value (RHS) of a variable declaration

17. Value: Variable destructuring

Value (RHS) of a variable declaration using a destructuring pattern

18. Value: Yield

Value of a yield statement

19. Value (iteration block)

Iteration scope for values: statement blocks (body of functions/if-statements/for-loops/etc).

20. Value (iteration class)

Iteration scope for values: class bodies.

21. Value (iteration document)

Iteration scope for values: the entire document including leading and trailing empty lines.

22. Value: Argument actual (iteration)

Iteration scope for values of (keyword) arguments in a function call: the argument list.

23. Value: Argument formal (iteration)

Iteration scope for default values of parameters in a function declaration: the parameter list.

24. Value: Argument formal constructor (iteration)

Iteration scope for default values of parameters in a constructor declaration: the parameter list.

25. Value: Argument formal lambda (iteration)

Iteration scope for default values of parameters in an anonymous function: the parameter list.

26. Value: Argument formal method (iteration)

Iteration scope for default values of parameters in a method declaration: the parameter list.

27. Value: Map pair (iteration)

Iteration scope for values of key-value pairs in a map: should be between the braces.

Internal scopes

The following are internal scopes. They are not intended for user interaction or spoken use. These scopes exist solely for internal Cursorless functionality.

Disqualify delimiter

1. Disqualify delimiter

Internally used to disqualify a token from being treated as a surrounding pair delimiter. This will usually be operators containing > or <, eg <, <=, ->, etc.

Pair delimiter

1. Pair delimiter

Internally used to add additional language specific surrounding pair delimiters in addition to the text based definitions. eg r".

String

1. String: Multi line

A multi-line string

2. String: Single line

A single-line string

Text fragment

1. Text fragment: Comment line

Internally used text fragment consisting of a line comment

2. Text fragment: String multi line

Internally used text fragment consisting of a multi-line string

3. Text fragment: String single line

Internally used text fragment consisting of a single-line string