qlever 0.5.31__tar.gz → 0.5.33__tar.gz

{qlever-0.5.31/src/qlever.egg-info → qlever-0.5.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qlever
-Version: 0.5.31
+Version: 0.5.33
 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 → qlever-0.5.33}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "qlever"
 description = "Command-line tool for using the QLever graph database"
-version = "0.5.31"
+version = "0.5.33"
 authors = [
     { name = "Hannah Bast", email = "bast@cs.uni-freiburg.de" }
 ]

qlever-0.5.33/src/qlever/commands/settings.py

@@ -0,0 +1,115 @@
+from __future__ import annotations
+
+import json
+
+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
+
+
+class SettingsCommand(QleverCommand):
+    """
+    Class for executing the `settings` command.
+    """
+
+    def __init__(self):
+        pass
+
+    def description(self) -> str:
+        return "Show or set server settings (after `qlever start`)"
+
+    def should_have_qleverfile(self) -> bool:
+        return True
+
+    def relevant_qleverfile_arguments(self) -> dict[str : list[str]]:
+        return {"server": ["port", "host_name", "access_token"]}
+
+    def additional_arguments(self, subparser) -> None:
+        subparser.add_argument(
+            "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,
+            help="An arbitrary endpoint URL "
+            "(overriding the one in the Qleverfile)",
+        )
+
+    def execute(self, args) -> bool:
+        # Get endpoint URL from command line or Qleverfile.
+        if args.endpoint_url:
+            endpoint_url = args.endpoint_url
+        else:
+            endpoint_url = f"http://{args.host_name}:{args.port}"
+
+        # 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}"'
+                )
+                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` 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:
+            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"curl command for getting settings failed: {e}")
+            return False
+        for key, value in settings_dict.items():
+            print(
+                colored(
+                    f"{key:<45}: {value}",
+                    "blue" if key in keys_set else None,
+                )
+            )
+
+        # That's it.
+        return True

{qlever-0.5.31 → qlever-0.5.33}/src/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-0.5.31 → qlever-0.5.33}/src/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 → qlever-0.5.33}/src/qlever/util.py

@@ -287,8 +287,9 @@ def stop_process_with_regex(cmdline_regex: str) -> list[bool] | None:
             )
             cmdline = " ".join(pinfo["cmdline"])
         except Exception as e:
+            # For some processes (e.g., zombies), getting info may fail.
             log.debug(f"Error getting process info: {e}")
-            return None
+            continue
         if re.search(cmdline_regex, cmdline):
             log.info(
                 f"Found process {pinfo['pid']} from user "

{qlever-0.5.31 → qlever-0.5.33/src/qlever.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qlever
-Version: 0.5.31
+Version: 0.5.33
 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/src/qlever/commands/settings.py

@@ -1,121 +0,0 @@
-from __future__ import annotations
-
-import json
-
-from termcolor import colored
-
-from qlever.command import QleverCommand
-from qlever.log import log
-from qlever.util import run_command
-
-
-class SettingsCommand(QleverCommand):
-    """
-    Class for executing the `settings` command.
-    """
-
-    def __init__(self):
-        pass
-
-    def description(self) -> str:
-        return "Show or set server settings (after `qlever start`)"
-
-    def should_have_qleverfile(self) -> bool:
-        return True
-
-    def relevant_qleverfile_arguments(self) -> dict[str : list[str]]:
-        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]
-        subparser.add_argument(
-            "--endpoint_url",
-            type=str,
-            help="An arbitrary endpoint URL "
-            "(overriding the one in the Qleverfile)",
-        )
-
-    def execute(self, args) -> bool:
-        # Get endpoint URL from command line or Qleverfile.
-        if args.endpoint_url:
-            endpoint_url = args.endpoint_url
-        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(
-                    "="
-                )
-            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)
-        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).
-        try:
-            settings_json = run_command(curl_cmd, return_output=True)
-            settings_dict = json.loads(settings_json)
-            if isinstance(settings_dict, list):
-                settings_dict = settings_dict[0]
-        except Exception as e:
-            log.error(f"setting command 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,
-                )
-            )
-        return True