How do I add a custom command-line argument to Python Locust?

Question

How do I add a custom command-line argument to Python Locust 0.7.2, then retrieve its value?

I want to specify a number:

locust --my-argument 6

Then in my script, I want to retrieve the value, with something like:

my_argument = ??.options.my_argument

I have found this in locust/main.py

def main():
    parser, options, arguments = parse_options()

But it appears that the parse_options() function doesn't look externally for any additional arguments.

Is this possible?

Thanks.

Possible duplicate of [how to pass custom parameters to a locust test class?](https://stackoverflow.com/questions/28951458/how-to-pass-custom-parameters-to-a-locust-test-class) — Yushin Washio, May 14 '19 at 13:37

score 0 · Answer 1 · edited Nov 17 '20 at 11:28

0

You can use Environment.

c:\locust>set env_test = ekomut
c:\locust>locust ...

import os
....
 def on_start(self):
        print("Variable:"+os.environ.get("env_test "))

edited Nov 17 '20 at 11:28

Ruli

answered Nov 16 '20 at 17:51

Ertuğrul KOMUT

score -1 · Answer 2 · answered Jul 21 '15 at 20:44

-1

You could edit the file (or fork the project) to enable additional optional arguments. It is open source and has a permissive license, after all.

answered Jul 21 '15 at 20:44

jheld

2 Answers2