qlever 0.5.31__py3-none-any.whl → 0.5.32__py3-none-any.whl

qlever/commands/settings.py

@@ -6,6 +6,7 @@ from termcolor import colored
 
 from qlever.command import QleverCommand
 from qlever.log import log
+from qlever.qleverfile import Qleverfile
 from qlever.util import run_command
 
 
@@ -27,39 +28,15 @@ class SettingsCommand(QleverCommand):
         return {"server": ["port", "host_name", "access_token"]}
 
     def additional_arguments(self, subparser) -> None:
-        all_keys = [
-            "always-multiply-unions",
-            "cache-max-num-entries",
-            "cache-max-size",
-            "cache-max-size-single-entry",
-            "cache-service-results",
-            "default-query-timeout",
-            "division-by-zero-is-undef",
-            "enable-prefilter-on-index-scans",
-            "group-by-disable-index-scan-optimizations",
-            "group-by-hash-map-enabled",
-            "lazy-index-scan-max-size-materialization",
-            "lazy-index-scan-num-threads",
-            "lazy-index-scan-queue-size",
-            "lazy-result-max-cache-size",
-            "query-planning-budget",
-            "request-body-limit",
-            "service-max-redirects",
-            "service-max-value-rows",
-            "sort-estimate-cancellation-factor",
-            "spatial-join-prefilter-max-size",
-            "spatial-join-max-num-threads",
-            "syntax-test-mode",
-            "throw-on-unbound-variables",
-            "treat-default-graph-as-named-graph",
-            "use-binsearch-transitive-path",
-        ]
         subparser.add_argument(
-            "runtime_parameter",
-            nargs="?",
-            help="Set the given runtime parameter (key=value)"
-            "; if no argument is given, show all settings",
-        ).completer = lambda **kwargs: [f"{key}=" for key in all_keys]
+            "runtime_parameters",
+            nargs="*",
+            help="Space-separated list of runtime parameters to set "
+            "in the form `key=value`; afterwards shows all settings, "
+            "with the changed ones highlighted",
+        ).completer = lambda **kwargs: [
+            f"{key}=" for key in Qleverfile.SERVER_RUNTIME_PARAMETERS
+        ]
         subparser.add_argument(
             "--endpoint_url",
             type=str,
@@ -74,48 +51,65 @@ class SettingsCommand(QleverCommand):
         else:
             endpoint_url = f"http://{args.host_name}:{args.port}"
 
-        # Construct the `curl` command for getting or setting.
-        if args.runtime_parameter:
-            try:
-                parameter_key, parameter_value = args.runtime_parameter.split(
-                    "="
+        # Construct the `curl` commands for setting and getting.
+        curl_cmds_setting = []
+        keys_set = set()
+        if args.runtime_parameters:
+            for key_value_pair in args.runtime_parameters:
+                try:
+                    key, value = key_value_pair.split("=")
+                except ValueError:
+                    log.error("Runtime parameter must be given as `key=value`")
+                    return False
+                curl_cmds_setting.append(
+                    f"curl -s {endpoint_url} -w %{{http_code}}"
+                    f' --data-urlencode "{key}={value}"'
+                    f' --data-urlencode "access-token={args.access_token}"'
                 )
-            except ValueError:
-                log.error("Runtime parameter must be given as `key=value`")
-                return False
-
-            curl_cmd = (
-                f"curl -s {endpoint_url}"
-                f' --data-urlencode "{parameter_key}={parameter_value}"'
-                f' --data-urlencode "access-token={args.access_token}"'
-            )
-        else:
-            curl_cmd = (
-                f"curl -s {endpoint_url}" f" --data-urlencode cmd=get-settings"
-            )
-            parameter_key, parameter_value = None, None
-        self.show(curl_cmd, only_show=args.show)
+                keys_set.add(key)
+        curl_cmd_getting = (
+            f"curl -s {endpoint_url} -w %{{http_code}}"
+            f" --data-urlencode cmd=get-settings"
+        )
+        self.show(
+            "\n".join(curl_cmds_setting + [curl_cmd_getting]),
+            only_show=args.show,
+        )
         if args.show:
             return True
 
-        # Execute the `curl` command. Note that the `get-settings` command
-        # returns all settings in both scencarios (that is, also when setting a
-        # parameter).
+        # Execute the `curl` commands for setting the key-value pairs if any.
+        for curl_cmd in curl_cmds_setting:
+            try:
+                curl_result = run_command(curl_cmd, return_output=True)
+                body, http_code = curl_result[:-3], curl_result[-3:]
+                if http_code != "200":
+                    raise Exception(body)
+            except Exception as e:
+                log.error(
+                    f"curl command for setting key-value pair failed: {e}"
+                )
+                return False
+
+        # Execute the `curl` commands for getting the settings.
         try:
-            settings_json = run_command(curl_cmd, return_output=True)
-            settings_dict = json.loads(settings_json)
+            curl_result = run_command(curl_cmd_getting, return_output=True)
+            body, http_code = curl_result[:-3], curl_result[-3:]
+            if http_code != "200":
+                raise Exception(body)
+            settings_dict = json.loads(body)
             if isinstance(settings_dict, list):
                 settings_dict = settings_dict[0]
         except Exception as e:
-            log.error(f"setting command failed: {e}")
+            log.error(f"curl command for getting settings failed: {e}")
             return False
         for key, value in settings_dict.items():
             print(
                 colored(
                     f"{key:<45}: {value}",
-                    "blue"
-                    if parameter_key and key == parameter_key
-                    else None,
+                    "blue" if key in keys_set else None,
                 )
             )
+
+        # That's it.
         return True

qlever/commands/start.py

@@ -5,11 +5,13 @@ import time
 
 from qlever.command import QleverCommand
 from qlever.commands.cache_stats import CacheStatsCommand
+from qlever.commands.settings import SettingsCommand
 from qlever.commands.status import StatusCommand
 from qlever.commands.stop import StopCommand
 from qlever.commands.warmup import WarmupCommand
 from qlever.containerize import Containerize
 from qlever.log import log
+from qlever.qleverfile import Qleverfile
 from qlever.util import binary_exists, is_qlever_server_alive, run_command
 
 
@@ -165,8 +167,19 @@ class StartCommand(QleverCommand):
             help="Run the server in the foreground "
             "(default: run in the background with `nohup`)",
         )
+        subparser.add_argument(
+            "runtime_parameters",
+            nargs="*",
+            help="Space-separated list of runtime parameters to set "
+            "(in the form `key=value`) once the server is running",
+        ).completer = lambda **kwargs: [
+            f"{key}=" for key in Qleverfile.SERVER_RUNTIME_PARAMETERS
+        ]
 
     def execute(self, args) -> bool:
+        # Set the endpoint URL.
+        args.endpoint_url = f"http://{args.host_name}:{args.port}"
+
         # Kill existing server with the same name if so desired.
         #
         # TODO: This is currently disabled because I never used it once over
@@ -200,6 +213,9 @@ class StartCommand(QleverCommand):
         # Show the command line.
         self.show(start_cmd, only_show=args.show)
         if args.show:
+            if args.runtime_parameters:
+                log.info("")
+                SettingsCommand().execute(args)
             return True
 
         # When running natively, check if the binary exists and works.
@@ -208,9 +224,8 @@ class StartCommand(QleverCommand):
                 return False
 
         # Check if a QLever server is already running on this port.
-        endpoint_url = f"http://{args.host_name}:{args.port}"
-        if is_qlever_server_alive(endpoint_url):
-            log.error(f"QLever server already running on {endpoint_url}")
+        if is_qlever_server_alive(args.endpoint_url):
+            log.error(f"QLever server already running on {args.endpoint_url}")
             log.info("")
             log.info(
                 "To kill the existing server, use `qlever stop` "
@@ -269,7 +284,7 @@ class StartCommand(QleverCommand):
         log.info("")
         tail_cmd = f"exec tail -f {args.name}.server-log.txt"
         tail_proc = subprocess.Popen(tail_cmd, shell=True)
-        while not is_qlever_server_alive(endpoint_url):
+        while not is_qlever_server_alive(args.endpoint_url):
             time.sleep(1)
 
         # Set the description for the index and text.
@@ -305,6 +320,11 @@ class StartCommand(QleverCommand):
             args.server_url = None
             CacheStatsCommand().execute(args)
 
+        # Apply settings if any.
+        if args.runtime_parameters:
+            log.info("")
+            SettingsCommand().execute(args)
+
         # With `--run-in-foreground`, wait until the server is stopped.
         if args.run_in_foreground:
             try:

qlever/qleverfile.py

@@ -21,6 +21,35 @@ class Qleverfile:
     Qleverfile + functions for parsing.
     """
 
+    # Runtime parameters (for `settings` and `start` commands).
+    SERVER_RUNTIME_PARAMETERS = [
+        "always-multiply-unions",
+        "cache-max-num-entries",
+        "cache-max-size",
+        "cache-max-size-single-entry",
+        "cache-service-results",
+        "default-query-timeout",
+        "division-by-zero-is-undef",
+        "enable-prefilter-on-index-scans",
+        "group-by-disable-index-scan-optimizations",
+        "group-by-hash-map-enabled",
+        "lazy-index-scan-max-size-materialization",
+        "lazy-index-scan-num-threads",
+        "lazy-index-scan-queue-size",
+        "lazy-result-max-cache-size",
+        "query-planning-budget",
+        "request-body-limit",
+        "service-max-redirects",
+        "service-max-value-rows",
+        "sort-estimate-cancellation-factor",
+        "spatial-join-prefilter-max-size",
+        "spatial-join-max-num-threads",
+        "syntax-test-mode",
+        "throw-on-unbound-variables",
+        "treat-default-graph-as-named-graph",
+        "use-binsearch-transitive-path",
+    ]
+
     @staticmethod
     def all_arguments():
         """

{qlever-0.5.31.dist-info → qlever-0.5.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qlever
-Version: 0.5.31
+Version: 0.5.32
 Summary: Command-line tool for using the QLever graph database
 Author-email: Hannah Bast <bast@cs.uni-freiburg.de>
 License: Apache-2.0

{qlever-0.5.31.dist-info → qlever-0.5.32.dist-info}/RECORD

@@ -4,7 +4,7 @@ qlever/config.py,sha256=gNw2_-jj1TjzhzqLOuUI_Dh19q_ViCiArrtrgXL2F4E,10354
 qlever/containerize.py,sha256=G1_ei9nBnYl5-7miiy0eWjb9HMnt06X21P7iU8bm6A0,5369
 qlever/log.py,sha256=WLscWV4fFF_w_uXSOfvWzhyzRM7t_61inE2ks3zf6Gw,1317
 qlever/qlever_main.py,sha256=QlVXq7azyuAG0QhH_pER2fdZL8el2mG0I6d9r0dGgOA,2593
-qlever/qleverfile.py,sha256=PMH8Bta6g1106na3FkTO27YDx-NscUNfQkjmf6Me7ts,18593
+qlever/qleverfile.py,sha256=l8zySDMdUcYf80e8iXr7JMtre0_tvBDAtZIzCyPqSNs,19644
 qlever/util.py,sha256=n4sJoBCrCSVaDS20z5B5tfa5GMqo3vGOdn5D1efjkmY,10940
 qlever/Qleverfiles/Qleverfile.dblp,sha256=G-sus-3SKHxXU1ZwevjzAXmosdJfLeOSb4SYmkjHY4o,1247
 qlever/Qleverfiles/Qleverfile.dblp-plus,sha256=TJHxp8I1P6JKJjbuAllEpB32-huuY1gH0FlenqPVJ5g,1334
@@ -38,18 +38,18 @@ qlever/commands/index.py,sha256=f1mZ9QNJwmjPa0KGAPghrj4L5XnY1TAcgoZ2wWj-n3Y,1332
 qlever/commands/index_stats.py,sha256=9EBo1Oq5PGjajrvWJNafJ-Wg_d90DaO5AGq9a5plSRM,11720
 qlever/commands/log.py,sha256=vLqkgtx1udnQqoUBMWB5G9rwr-l7UKrDpyFYSMuoXWw,1987
 qlever/commands/query.py,sha256=rRiR4TFRZixLfBmITAvKVtWHn6mhOiboGG8a_Jcwc8k,4653
-qlever/commands/settings.py,sha256=thD3_-PV57cuM0aXDNhFiLKIcdfchTo2gF4Jmk12Hww,4208
+qlever/commands/settings.py,sha256=wG2M2U6xoxQTnvgEIPfmw-sP7LwLR0Ut--Yi1uCjE68,4002
 qlever/commands/setup_config.py,sha256=wEy1LAunpOnqrUCbazMpt1u9HJCKgXJEMxF3zjh0jb0,3344
-qlever/commands/start.py,sha256=BHXkrL2vUkTBieNzcJAUvAH6z5hpd2MbtDhu_hhLWa8,10858
+qlever/commands/start.py,sha256=ELNaZ1RtfLo0cwSxqjzyECFvFgETI8_psJO9hwFmVT8,11609
 qlever/commands/status.py,sha256=TtnBqcdkF3zTDKft07zpVcIX7kFu7d_nOy9b6Ohh9vQ,1650
 qlever/commands/stop.py,sha256=5BNKArOzoJ8kYiTVAmtN81w7nQ42fkxISgsxL-qJpO0,3463
 qlever/commands/system_info.py,sha256=I84EKgMO5J8pvsTDhkVKHzsRLtPajNg9KTQN5kWjqLU,4660
 qlever/commands/ui.py,sha256=Kjv5FKN0pjMCpJS6otbrczs364x24FAnsJjtnc98mJQ,9811
 qlever/commands/update_wikidata.py,sha256=MQWNTe7KtadlTAsxCsntKYWZLSoX6H8l6WI4s6UfFqY,24484
 qlever/commands/warmup.py,sha256=kJHzS7HJo8pD2CphJuaXDj_CYP02YDo2DVM-pun3A80,1029
-qlever-0.5.31.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-qlever-0.5.31.dist-info/METADATA,sha256=LQxxOUmh0vTIFbvKWHUi7HrgMvopwIpHHWFcC-iBiB8,5151
-qlever-0.5.31.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-qlever-0.5.31.dist-info/entry_points.txt,sha256=U_1U6SFIEZ-AnNlvk2nzcL0e4jnjEpuSbxYZ_E0XpEg,51
-qlever-0.5.31.dist-info/top_level.txt,sha256=kd3zsYqiFd0--Czh5XTVkfEq6XR-XgRFW35X0v0GT-c,7
-qlever-0.5.31.dist-info/RECORD,,
+qlever-0.5.32.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+qlever-0.5.32.dist-info/METADATA,sha256=jecvG6GmRKCOUmvTT3OOJd_ZwlhqymyLFdzbmIDCr_8,5151
+qlever-0.5.32.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+qlever-0.5.32.dist-info/entry_points.txt,sha256=U_1U6SFIEZ-AnNlvk2nzcL0e4jnjEpuSbxYZ_E0XpEg,51
+qlever-0.5.32.dist-info/top_level.txt,sha256=kd3zsYqiFd0--Czh5XTVkfEq6XR-XgRFW35X0v0GT-c,7
+qlever-0.5.32.dist-info/RECORD,,