Commit Graph

63 Commits

Author SHA1 Message Date
Lars Holmberg 1fc3143f1f move note to correct place in docs 2024-06-16 19:51:16 +02:00
Lars Holmberg 048240ac84 Document events.request.measure() better. 2023-12-18 21:00:05 +01:00
Evgeni Golov 487b3b49f8
update links to requests homepage
the old dot org has been gone for some while, and everything links to readthedocs these days.

also, the library is called requests, not python-requests.
2023-07-25 08:37:24 +02:00
Lars Holmberg d4804422d1 Move the rest method into FastHttpUser instead of RestUser. Remove RestUser. Update docs accordingly. 2022-12-13 10:03:00 +01:00
Lars Holmberg a34b772133 docs 2022-12-13 00:15:58 +01:00
Lars Holmberg f00ce66402 Docs: Add LoadTestShape to api page. Fix comment. Fixes #2232 2022-10-19 18:28:52 +02:00
gdm85 e9790547b0 feat: Master sends a worker index on ACK
Master will provide on ACK an ordinal identifier to each connected worker;
these are deterministic (same id for same client id) and guaranteed to not
change as far as the Master is alive.
LocalRunner has its worker_index always set to 0.
2022-08-10 13:01:06 -07:00
Lars Holmberg be1096815f Fix documentation of RequestStats 2022-05-19 19:32:53 +02:00
Lars Holmberg fb994e5e09 doc update 2022-05-19 19:19:41 +02:00
Lars Holmberg 2a251f87e2 Add run_single_user and debugging example 2022-01-27 08:25:28 +01:00
Alexander Nyurenberg 5b4c673ffa Added the description of the 'fixed_count' property into the documentation. 2022-01-21 01:28:11 +03:00
Lars Holmberg 5d84379a6e Stop declaring "fake" class level variables in Environment, User and stats. Do it in constructor/instance level, where they belong instead.
The only benefit to having them on class level was so that they got documented properly, but it works as long as they are definied in __init__ as well.

While this shouldnt be a breaking change for any "normal" usage of Locust, I think we need to do some testing to ensure that we dont need to bump major version.

Added some type hints as well.
2021-11-29 20:06:45 +01:00
Lars Holmberg bd193df307 Add constant_throughput wait time (just the inverse of constant_pacing) 2021-08-23 12:57:38 +02:00
Lars Holmberg 94694864b0 various documentation updats 2021-08-08 14:04:11 +02:00
Nathan Beam 3099dbbd7d Docs 2021-06-07 13:22:51 -04:00
Dennis Kroné 74d89a3f52 Update documentation regarding request context 2021-05-03 15:48:04 +02:00
Lars Holmberg 00e59351fd doc fix for exceptions (no need for a heading for every type) 2020-08-19 16:20:17 +02:00
Lars Holmberg 660a7b9d6b Add documentation for more exceptions, add example of how to use exceptions to interrupt logging a request. 2020-08-19 16:16:15 +02:00
Phil Davis 9c0387274e
Doc review changes 2020-08-19 10:10:02 +05:45
TLovell 10380081fe Fixed documentation links, tag no longer has 'tagged' default, @tag takes arbitrary number of tags 2020-05-02 14:02:36 -06:00
TLovell 4a0ce4eca6 Fixed merge conflicts 2020-05-01 20:20:03 -06:00
Jonatan Heyman 265a3bfce9 Update python references in documentation and docstrings after code restructuring of core.py (#1361).
Change so that we refer to classes/functions through the `locust.*` namespace, since this will allow us to do other code restructuring changes without having to update docstrings and docs.
2020-05-01 12:27:54 +02:00
TLovell 4a988c13b0 Changed mark to tag 2020-04-30 19:51:09 -06:00
TLovell 224d8d0979 Added documentation for marks 2020-04-30 01:04:21 -06:00
Jonatan Heyman 36673979db Rename locust attribute on TaskSet to user 2020-04-22 17:19:47 +02:00
anuj_ de53ef8cf7 documentation updated 2020-04-20 14:54:28 +12:00
Jonatan Heyman ad82e84c67 Add documentation for different Runner classes.
Add documentation for WebUI class.
Add documentation on how to use Locust as a library.
2020-04-14 16:32:47 +02:00
Jonatan Heyman 1fe947a112 Add Locust.wait method in order to have the same API between TaskSet and Locust
Add both Locust.wait and TaskSet.wait to API docs
2020-04-09 12:15:34 +02:00
Jonatan Heyman 223680ff1f Merge branch 'master' into sequential-taskset 2020-04-05 22:31:07 +02:00
Jonatan Heyman 13d7c3a2fb Update documentation on test_start/test_stop hooks and removal of setup/teardown 2020-04-05 22:30:00 +02:00
Jonatan Heyman 6727a3152e Update documentation and examples
(Replace TaskSequence and @seq_task with SequentialTaskSet class that executes tasks in order of declaration)
2020-04-05 22:03:01 +02:00
Jonatan Heyman bbd73cd47b Add abstract attribute to API docs for Locust and HttpLocust 2020-04-03 10:04:10 +02:00
Jonatan Heyman 02ce1665b4 Change how tasks and TaskSets are declared on Locust classes.
* Let users specify tasks directly under a Locust class, just as one would do it on a TaskSet class. These tasks will get the Locust instance as argument when executed.
* Removed Locust.task_set from the public API, and instead let users use either the tasks attribute or the @task decorator.
* Introduce a Locust.abstract boolean attribute. If it's set to True the Locust class is meant to be used as a base class, and users of that type can not be spawned directly from it.
2020-04-01 01:08:07 +02:00
Jonatan Heyman f6715f5562 Rename locust.events module to locust.event
Introduce global instance of Events() stored in locust.events which can be used to register event listeners at the module level of locustfiles.
Remove some unused imports.
2020-03-03 19:43:34 +01:00
Jonatan Heyman c12f615dab Update extending-locust and API documentation page for the new API 2020-02-27 16:58:07 +01:00
Jonatan Heyman 5500f03404 Bump version & update changelog 2019-11-16 13:34:09 +01:00
Jonatan Heyman 2f67b24a7e Add note about wildcard keyword arguments to events API docs 2019-11-14 13:21:42 +01:00
Jonatan Heyman 9d2b0af2f3 Documentation changes for the wait time API 2019-10-24 17:50:19 +02:00
Jon Dufresne 5f29cd5e38 Fix Sphinx build warnings (#875)
WARNING: Title underline too short.
WARNING: Title overline too short.
2018-09-05 10:36:53 -04:00
Ramshell 30275af9f2 Add tasks sequence support (#827)
* Add support for tasks sequence

* Add TaskSequence documentation

* Add TaskSequence and seq_task to the __init__.py
2018-06-28 11:48:48 -04:00
g.punter df89db25a3 Added user-defined wait_function to locust and TaskSet 2018-04-27 10:41:18 +01:00
Tim Sampson dd1aebbae7 document locust.weight 2014-01-15 07:22:46 +00:00
Jonatan Heyman a58c4695af Convert to Unix line endings 2013-12-02 22:16:30 +01:00
Jonatan Heyman 7ed9f5f215 Moved HttpSession instantiation into new HttpLocust class
As discussed in #83, removed HttpSession instantiation on the Locust.client attribute from base Locust class, and introduced new HttpLocust class with this functionality. 

Added warning when trying to access the client attribute on a "bare" Locust instance. Updated documentation.
2013-12-02 08:48:52 +01:00
Djoume Salvetti 53b45b20cf Removes duplicate attribute documentation 2013-10-29 16:00:13 -04:00
cbrinley 90e99771a6 Update docs/api.rst
world's most challenging fix. Line 71 currently reads "The `wollowing` event hooks..."
Changing to read "The following event hooks...."
2013-01-26 15:32:43 -06:00
Jonatan Heyman 0e3782aed4 Added TaskSet.parent attribute to API docs, and an entry in the changelog 2012-12-21 00:37:14 +01:00
Jonatan Heyman 00c25802ac Updated API docs "imports" 2012-11-16 00:19:08 +01:00
Jonatan Heyman c2245a4587 Updated documentation to reflect Locust class/TaskSet API changes (#43). Improved docs in general. 2012-11-15 01:13:58 +01:00
Jonatan Heyman 28da8e2a7a Described Locust/TaskSet API changes in changelog and improved documentation #43 2012-11-07 12:54:47 +01:00