locust-cloud 1.19.1__py3-none-any.whl → 1.19.3__py3-none-any.whl

locust_cloud/__init__.py

@@ -14,5 +14,13 @@ def _(parser):
 Example: locust --cloud -f my_locustfile.py --users 1000 ...""",
     )
 
+    # This arguments is defined here because only makes sense when
+    # running from locust core
+    cloud_group.add_argument(
+        "--cloud",
+        action="store_true",
+        help="Run Locust in cloud mode.",
+    )
+
     for action in cloud_parser._actions:
         cloud_group._add_action(action)

locust_cloud/args.py

@@ -110,11 +110,6 @@ class MergeToTransferEncodedZip(argparse.Action):
 
 
 cloud_parser = configargparse.ArgumentParser(add_help=False)
-cloud_parser.add_argument(
-    "--cloud",
-    action="store_true",
-    help="Run Locust in cloud mode.",
-)
 cloud_parser.add_argument(
     "--login",
     action="store_true",
@@ -171,6 +166,7 @@ cloud_parser.add_argument(
 )
 
 combined_cloud_parser = configargparse.ArgumentParser(
+    parents=[cloud_parser],
     default_config_files=[
         "~/.cloud.conf",
         "cloud.conf",
@@ -183,12 +179,21 @@ combined_cloud_parser = configargparse.ArgumentParser(
             configargparse.DefaultConfigFileParser,
         ]
     ),
-    parents=[cloud_parser],
+    description="""Launches a distributed Locust runs on locust.cloud infrastructure.
+
+Example: locust-cloud -f my_locustfile.py --users 1000 ...""",
+    epilog="""Any parameters not listed here are forwarded to locust master unmodified, so go ahead and use things like --users, --host, --run-time, ...
+Locust config can also be set using config file (~/.locust.conf, locust.conf, pyproject.toml, ~/.cloud.conf or cloud.conf).
+Parameters specified on command line override env vars, which in turn override config files.""",
+    add_config_file_help=False,
+    add_env_var_help=False,
 )
 combined_cloud_parser.add_argument(
     "-f",
     "--locustfile",
+    metavar="<filename>",
     default="locustfile.py",
+    help="The Python file that contains your test. Defaults to 'locustfile.py'.",
     env_var="LOCUST_LOCUSTFILE",
     type=transfer_encoded_file,
 )
@@ -197,12 +202,14 @@ combined_cloud_parser.add_argument(
     "--users",
     type=int,
     default=1,
+    help="Number of users to launch. This is the same as the regular Locust argument, but also affects how many workers to launch.",
     env_var="LOCUST_USERS",
 )
 combined_cloud_parser.add_argument(
     "--loglevel",
     "-L",
     type=str.upper,
+    help="Set --loglevel DEBUG for extra info.",
     choices=["DEBUG", "INFO", "WARNING", "ERROR"],
     default="INFO",
 )

locust_cloud/cloud.py

@@ -65,21 +65,23 @@ def main():
             ]
         ]
 
+        locust_args = [
+            {"name": "LOCUST_USERS", "value": str(options.users)},
+            {"name": "LOCUST_FLAGS", "value": " ".join(locust_options)},
+            {"name": "LOCUSTCLOUD_DEPLOYER_URL", "value": session.api_url},
+            *locust_env_variables,
+        ]
+
+        if options.testrun_tags:
+            locust_args.append({"name": "LOCUSTCLOUD_TESTRUN_TAGS", "value": ",".join(options.testrun_tags)})
+
         payload = {
-            "locust_args": [
-                {"name": "LOCUST_USERS", "value": str(options.users)},
-                {"name": "LOCUST_FLAGS", "value": " ".join(locust_options)},
-                {"name": "LOCUSTCLOUD_DEPLOYER_URL", "value": session.api_url},
-                *locust_env_variables,
-            ],
+            "locust_args": locust_args,
             "locustfile": options.locustfile,
             "user_count": options.users,
             "mock_server": options.mock_server,
         }
 
-        if options.testrun_tags:
-            payload["LOCUSTCLOUD_TESTRUN_TAGS"] = " ".join(options.testrun_tags)
-
         if options.image_tag is not None:
             payload["image_tag"] = options.image_tag
 

{locust_cloud-1.19.1.dist-info → locust_cloud-1.19.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locust-cloud
-Version: 1.19.1
+Version: 1.19.3
 Summary: Locust Cloud
 Project-URL: Homepage, https://locust.cloud
 License-File: LICENSE

locust_cloud-1.19.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+locust_cloud/__init__.py,sha256=9USe4yHuvpP5xrXm0dVsi08pu2l5TcjxQl6Pei8w3lk,713
+locust_cloud/apisession.py,sha256=kCr271_l0IeMGw0L563mOecqPJj4OD9h2J3vxCM5zYQ,4015
+locust_cloud/args.py,sha256=6PLJYmy1lr1qYQR4elsIhws0wJwc4_heS_xbTibO4Yw,6970
+locust_cloud/cloud.py,sha256=Ox2BNQfeVSbLN67mp5yl4ZeSFqfEsPef0H5Jxy5QMU8,6071
+locust_cloud/common.py,sha256=cFrDVKpi9OEmH6giOuj9HoIUFSBArixNtNHzZIgDvPE,992
+locust_cloud/input_events.py,sha256=MyxccgboHByICuK6VpQCCJhZQqTZAacNmkSpw-gxBEw,3420
+locust_cloud/web_login.py,sha256=1j2AQoEM6XVSDtE1q0Ryrs4jFEx07r9IQfZCoFAQXJg,2400
+locust_cloud/websocket.py,sha256=9Q7nTFuAwVhgW74DlJNcHTZXOQ1drsXi8hX9ciZhWlQ,8998
+locust_cloud-1.19.3.dist-info/METADATA,sha256=SHRS98OvUn8mpIR81g5wGz2TddMi3Pk-vWV1n8V9MEE,633
+locust_cloud-1.19.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+locust_cloud-1.19.3.dist-info/entry_points.txt,sha256=PGyAb4e3aTsGS3N3VGShDl6VzJaXy7QwsEgsLOC7V00,57
+locust_cloud-1.19.3.dist-info/licenses/LICENSE,sha256=Ow6fY6ta4KIjdlWalmxGvRP8yLmetvkbkl-SdHMjPIs,1093
+locust_cloud-1.19.3.dist-info/RECORD,,

locust_cloud-1.19.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-locust_cloud/__init__.py,sha256=NPggKqjx13UKmmgoG6dpoXOyA1liGBAUP8pz6OSpBvI,488
-locust_cloud/apisession.py,sha256=kCr271_l0IeMGw0L563mOecqPJj4OD9h2J3vxCM5zYQ,4015
-locust_cloud/args.py,sha256=QRt1NoFwxTyj7147YF1_YN6u5V34qGBSNwgnl7nwZQ4,6203
-locust_cloud/cloud.py,sha256=9qKy60FwHCmkF4efZ1BH6D4AUwkBftre8ei2Dol5yk4,6027
-locust_cloud/common.py,sha256=cFrDVKpi9OEmH6giOuj9HoIUFSBArixNtNHzZIgDvPE,992
-locust_cloud/input_events.py,sha256=MyxccgboHByICuK6VpQCCJhZQqTZAacNmkSpw-gxBEw,3420
-locust_cloud/web_login.py,sha256=1j2AQoEM6XVSDtE1q0Ryrs4jFEx07r9IQfZCoFAQXJg,2400
-locust_cloud/websocket.py,sha256=9Q7nTFuAwVhgW74DlJNcHTZXOQ1drsXi8hX9ciZhWlQ,8998
-locust_cloud-1.19.1.dist-info/METADATA,sha256=PMKO_Zdoh9_eT8D5Rwpmzg26RSMPXk4fOXhBQVlPbcM,633
-locust_cloud-1.19.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-locust_cloud-1.19.1.dist-info/entry_points.txt,sha256=PGyAb4e3aTsGS3N3VGShDl6VzJaXy7QwsEgsLOC7V00,57
-locust_cloud-1.19.1.dist-info/licenses/LICENSE,sha256=Ow6fY6ta4KIjdlWalmxGvRP8yLmetvkbkl-SdHMjPIs,1093
-locust_cloud-1.19.1.dist-info/RECORD,,