Skip to content

Commit a27b9d1

Browse files
authored
Update CLI.md
1 parent b11d81c commit a27b9d1

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

utbot-python/docs/CLI.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,61 +22,63 @@ Run generated tests:
2222

2323
- `-s, --sys-path <dir1>,<dir2>`
2424

25-
Directories to add to sys.path (required). One of directories must contain file with methods under test.
25+
(required) Directories to add to `sys.path`. One of directories must contain the file with the methods under test.
26+
27+
`sys.path` is a list of strings that specifies the search path for modules. It must include paths for all user modules that are used in imports.
2628

2729
- `-p, --python-path <path>`
2830

29-
Path to Python interpreter (required)
31+
(required) Path to Python interpreter.
3032

3133
- `-o, --output <filename>`
3234

33-
File for generated tests (required)
35+
(required) File for generated tests.
3436

3537
- `--coverage <filename>`
3638

37-
File to write coverage report
39+
File to write coverage report.
3840

3941
- `-c, --class <class>`
4042

41-
Specify top-level class under test
43+
Specify top-level class under test. Without this option tests will be generated for top-level functions.
4244

4345
- `-m, --methods <method1>,<method2>`
4446

45-
Specify methods under test
47+
Specify methods under test.
4648

4749
- `--install-requirements`
4850

49-
Install Python requirements if missing
51+
Install Python requirements if missing.
5052

5153
- `--do-not-minimize`
5254

53-
Turn off minimization of number of generated tests
55+
Turn off minimization of number of generated tests.
5456

5557
- `--do-not-check-requirements`
5658

57-
Turn off Python requirements check (to speed up)
59+
Turn off Python requirements check (to speed up).
5860

5961
- `--visit-only-specified-source`
6062

61-
Do not search for classes and imported modules in other Python files from sys.path
63+
Do not search for classes and imported modules in other Python files from `--sys-path` option.
6264

6365
- `-t, --timeout INT`
6466

65-
Specify the maximum time in milliseconds to spend on generating tests (60000 by default)
67+
Specify the maximum time in milliseconds to spend on generating tests (60000 by default).
6668

6769
- `--timeout-for-run INT`
6870

69-
Specify the maximum time in milliseconds to spend on one function run (2000 by default)
71+
Specify the maximum time in milliseconds to spend on one function run (2000 by default).
7072

7173
- `--test-framework [pytest|Unittest]`
7274

73-
Test framework to be used
75+
Test framework to be used.
7476

7577
## `run_python` options
7678

7779
- `-p, --python-path <path>`
7880

79-
Path to Python interpreter (required)
81+
(required) Path to Python interpreter.
8082

8183
- `--test-framework [pytest|Unittest]`
8284

0 commit comments

Comments
 (0)