mirror of https://github.com/locustio/locust.git
182 lines
4.1 KiB
ReStructuredText
182 lines
4.1 KiB
ReStructuredText
###
|
|
API
|
|
###
|
|
|
|
|
|
User class
|
|
============
|
|
|
|
.. autoclass:: locust.User
|
|
:members: wait_time, tasks, weight, fixed_count, abstract, on_start, on_stop, wait, context, environment
|
|
|
|
HttpUser class
|
|
================
|
|
|
|
.. autoclass:: locust.HttpUser
|
|
:members: wait_time, tasks, client, abstract
|
|
|
|
HttpSession class
|
|
=================
|
|
|
|
.. autoclass:: locust.clients.HttpSession
|
|
:members: __init__, request, get, post, delete, put, head, options, patch
|
|
|
|
FastHttpUser class
|
|
==================
|
|
|
|
.. autoclass:: locust.contrib.fasthttp.FastHttpUser
|
|
:members: wait_time, tasks, client, abstract, rest
|
|
:noindex:
|
|
|
|
FastHttpSession class
|
|
=====================
|
|
|
|
.. autoclass:: locust.contrib.fasthttp.FastHttpSession
|
|
:members: __init__, request, get, post, delete, put, head, options, patch, iter_lines
|
|
|
|
PostgresUser class
|
|
==================
|
|
|
|
.. autoclass:: locust.contrib.postgres.PostgresUser
|
|
:members: wait_time, tasks, client, abstract
|
|
:noindex:
|
|
|
|
MongoDBUser class
|
|
=================
|
|
|
|
.. autoclass:: locust.contrib.mongodb.MongoDBUser
|
|
:members: wait_time, tasks, client, abstract
|
|
:noindex:
|
|
|
|
TaskSet class
|
|
=============
|
|
|
|
.. autoclass:: locust.TaskSet
|
|
:members: user, parent, wait_time, client, tasks, interrupt, schedule_task, on_start, on_stop, wait
|
|
|
|
task decorator
|
|
==============
|
|
|
|
.. autofunction:: locust.task
|
|
|
|
tag decorator
|
|
==============
|
|
|
|
.. autofunction:: locust.tag
|
|
|
|
SequentialTaskSet class
|
|
=======================
|
|
|
|
.. autoclass:: locust.SequentialTaskSet
|
|
:members: user, parent, wait_time, client, tasks, interrupt, schedule_task, on_start, on_stop
|
|
|
|
|
|
.. _wait_time_functions:
|
|
|
|
Built in wait_time functions
|
|
============================
|
|
|
|
.. automodule:: locust.wait_time
|
|
:members: between, constant, constant_pacing, constant_throughput
|
|
|
|
Response class
|
|
==============
|
|
|
|
This class actually resides in the `requests <https://requests.readthedocs.io/>`_ library,
|
|
since that's what Locust is using to make HTTP requests, but it's included in the API docs
|
|
for locust since it's so central when writing locust load tests. You can also look at the
|
|
:py:class:`Response <requests.Response>` class at the
|
|
`requests documentation <https://requests.readthedocs.io/>`_.
|
|
|
|
.. autoclass:: requests.Response
|
|
:inherited-members:
|
|
:noindex:
|
|
|
|
ResponseContextManager class
|
|
============================
|
|
|
|
.. autoclass:: locust.clients.ResponseContextManager
|
|
:members: success, failure
|
|
|
|
|
|
.. _exceptions:
|
|
|
|
Exceptions
|
|
==========
|
|
|
|
.. autoexception:: locust.exception.InterruptTaskSet
|
|
|
|
|
|
.. autoexception:: locust.exception.RescheduleTask
|
|
|
|
|
|
.. autoexception:: locust.exception.RescheduleTaskImmediately
|
|
|
|
|
|
Environment class
|
|
=================
|
|
.. autoclass:: locust.env.Environment
|
|
:members:
|
|
|
|
|
|
.. _events:
|
|
|
|
Event hooks
|
|
===========
|
|
|
|
Locust provides event hooks that can be used to extend Locust in various ways.
|
|
|
|
The following event hooks are available under :py:attr:`Environment.events <locust.env.Environment.events>`,
|
|
and there's also a reference to these events under ``locust.events`` that can be used at the module level
|
|
of locust scripts (since the Environment instance hasn't been created when the locustfile is imported).
|
|
|
|
.. autoclass:: locust.event.Events
|
|
:members:
|
|
|
|
|
|
.. note::
|
|
|
|
It's highly recommended that you add a wildcard keyword argument in your event listeners
|
|
to prevent your code from breaking if new arguments are added in a future version.
|
|
|
|
EventHook class
|
|
---------------
|
|
|
|
The event hooks are instances of the **locust.events.EventHook** class:
|
|
|
|
.. autoclass:: locust.event.EventHook
|
|
:members:
|
|
|
|
Runner classes
|
|
=====================
|
|
|
|
.. autoclass:: locust.runners.Runner
|
|
:members: start, stop, quit, user_count
|
|
|
|
.. autoclass:: locust.runners.LocalRunner
|
|
|
|
.. autoclass:: locust.runners.MasterRunner
|
|
:members: register_message, send_message
|
|
|
|
.. autoclass:: locust.runners.WorkerRunner
|
|
:members: register_message, send_message, client_id, worker_index
|
|
|
|
Web UI class
|
|
============
|
|
|
|
.. autoclass:: locust.web.WebUI
|
|
:members:
|
|
|
|
Other
|
|
=====
|
|
|
|
.. autoclass:: locust.shape.LoadTestShape
|
|
:members:
|
|
|
|
.. autoclass:: locust.stats.RequestStats
|
|
:members: get
|
|
|
|
.. autoclass:: locust.stats.StatsEntry
|
|
|
|
.. autofunction:: locust.debug.run_single_user
|