gamspy 1.18.3__py3-none-any.whl → 1.19.0__py3-none-any.whl

gamspy/_cli/retrieve.py

@@ -1,79 +1,79 @@
-from __future__ import annotations
-
-import os
-import subprocess
-
-import certifi
-import typer
-
-import gamspy.utils as utils
-from gamspy.exceptions import ValidationError
-
-app = typer.Typer(
-    rich_markup_mode="rich",
-    short_help="To retrieve a license with another node's information.",
-    help="[bold][yellow]Examples[/yellow][/bold]: gamspy retrieve license <access_code> [--input <input_path>.json] [--output <output_path>.json]",
-    context_settings={"help_option_names": ["-h", "--help"]},
-)
-
-
-@app.command(
-    short_help="Retrives the license with the given node information.",
-    help="[bold][yellow]Examples[/yellow][/bold]: gamspy retrieve license <access_code> [--input <input_path>.json] [--output <output_path>.json]",
-)
-def license(
-    access_code: str = typer.Argument(..., help="Access code of the license."),
-    input: str = typer.Option(
-        None,
-        "--input",
-        "-i",
-        help="Input json file path to retrieve the license based on the node information.",
-    ),
-    output: str = typer.Option(
-        None, "--output", "-o", help="Output path for the license file."
-    ),
-    checkout_duration: int | None = typer.Option(
-        None,
-        "--checkout-duration",
-        "-c",
-        help="Specifies a duration in hours to checkout a session.",
-    ),
-) -> None:
-    if input is None or not os.path.isfile(input):
-        raise ValidationError(
-            f"Given path `{input}` is not a json file. Please use `gamspy retrieve license <access_code> -i <json_file_path>`"
-        )
-
-    if access_code is None:
-        raise ValidationError(f"Given licence id `{access_code}` is not valid!")
-
-    environment_variables = os.environ.copy()
-    if "CURL_CA_BUNDLE" not in environment_variables:
-        environment_variables["CURL_CA_BUNDLE"] = certifi.where()
-
-    gamspy_base_dir = utils._get_gamspy_base_directory()
-    command = [
-        os.path.join(gamspy_base_dir, "gamsgetkey"),
-        access_code,
-        "-i",
-        input,
-    ]
-    if checkout_duration:
-        command.append("-c")
-        command.append(str(checkout_duration))
-
-    process = subprocess.run(
-        command, text=True, capture_output=True, env=environment_variables
-    )
-
-    if process.returncode:
-        raise ValidationError(process.stderr)
-
-    print(process.stdout)
-    if output:
-        with open(output, "w") as file:
-            file.write(process.stdout)
-
-
-if __name__ == "__main__":
-    app()
+from __future__ import annotations
+
+import os
+import subprocess
+
+import certifi
+import typer
+
+import gamspy.utils as utils
+from gamspy.exceptions import ValidationError
+
+app = typer.Typer(
+    rich_markup_mode="rich",
+    short_help="To retrieve a license with another node's information.",
+    help="[bold][yellow]Examples[/yellow][/bold]: gamspy retrieve license <access_code> [--input <input_path>.json] [--output <output_path>.json]",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+@app.command(
+    short_help="Retrives the license with the given node information.",
+    help="[bold][yellow]Examples[/yellow][/bold]: gamspy retrieve license <access_code> [--input <input_path>.json] [--output <output_path>.json]",
+)
+def license(
+    access_code: str = typer.Argument(..., help="Access code of the license."),
+    input: str = typer.Option(
+        None,
+        "--input",
+        "-i",
+        help="Input json file path to retrieve the license based on the node information.",
+    ),
+    output: str = typer.Option(
+        None, "--output", "-o", help="Output path for the license file."
+    ),
+    checkout_duration: int | None = typer.Option(
+        None,
+        "--checkout-duration",
+        "-c",
+        help="Specifies a duration in hours to checkout a session.",
+    ),
+) -> None:
+    if input is None or not os.path.isfile(input):
+        raise ValidationError(
+            f"Given path `{input}` is not a json file. Please use `gamspy retrieve license <access_code> -i <json_file_path>`"
+        )
+
+    if access_code is None:
+        raise ValidationError(f"Given licence id `{access_code}` is not valid!")
+
+    environment_variables = os.environ.copy()
+    if "CURL_CA_BUNDLE" not in environment_variables:
+        environment_variables["CURL_CA_BUNDLE"] = certifi.where()
+
+    gamspy_base_dir = utils._get_gamspy_base_directory()
+    command = [
+        os.path.join(gamspy_base_dir, "gamsgetkey"),
+        access_code,
+        "-i",
+        input,
+    ]
+    if checkout_duration:
+        command.append("-c")
+        command.append(str(checkout_duration))
+
+    process = subprocess.run(
+        command, text=True, capture_output=True, env=environment_variables
+    )
+
+    if process.returncode:
+        raise ValidationError(process.stderr)
+
+    print(process.stdout)
+    if output:
+        with open(output, "w") as file:
+            file.write(process.stdout)
+
+
+if __name__ == "__main__":
+    app()

gamspy/_cli/run.py

@@ -1,158 +1,158 @@
-from __future__ import annotations
-
-import os
-import platform
-import subprocess
-import sys
-from enum import Enum
-from pathlib import Path  # noqa: TC003
-from typing import Annotated, Optional
-
-import typer
-
-from gamspy.exceptions import ValidationError
-
-app = typer.Typer(
-    rich_markup_mode="rich",
-    short_help="To run your model with GAMS MIRO.",
-    help="[bold][yellow]Examples[/yellow][/bold]: gamspy run miro [--path <path_to_miro>] [--model <path_to_model>]",
-    context_settings={"help_option_names": ["-h", "--help"]},
-)
-
-
-class ModeEnum(str, Enum):
-    config = "config"
-    base = "base"
-    deploy = "deploy"
-
-
-@app.command(
-    help="[bold][yellow]Examples[/yellow][/bold]: gamspy run miro [--path <path_to_miro>] [--model <path_to_model>]",
-    short_help="Runs a GAMSPY model with GAMS MIRO app.",
-)
-def miro(
-    mode: Annotated[
-        ModeEnum,
-        typer.Option("--mode", "-m", help="Execution mode of MIRO"),
-    ] = ModeEnum.base,  # type: ignore
-    path: Annotated[
-        Optional[Path],  # noqa: UP045
-        typer.Option(
-            "--path",
-            "-p",
-            exists=True,
-            help="Path to the MIRO executable (.exe, .app, or .AppImage)",
-        ),
-    ] = None,
-    skip_execution: Annotated[
-        bool,
-        typer.Option("--skip-execution", help="Whether to skip model execution."),
-    ] = False,
-    model: Annotated[
-        Optional[Path],  # noqa: UP045,
-        typer.Option("--model", "-g", exists=True, help="Path to the GAMSPy model."),
-    ] = None,
-    args: Annotated[
-        list[str] | None,
-        typer.Argument(help="Arguments to the GAMSPy model."),
-    ] = None,
-) -> None:
-    if model is None:
-        typer.echo("--model must be provided to run MIRO", file=sys.stderr)
-        sys.exit(1)
-
-    model = os.path.abspath(model)
-    execution_mode = mode.value
-    path = os.getenv("MIRO_PATH", path)
-
-    if path is None:
-        path = path if path is not None else discover_miro()
-
-    if path is None:
-        raise ValidationError("--path must be provided to run MIRO")
-
-    if platform.system() == "Darwin" and os.path.splitext(path)[1] == ".app":
-        path = os.path.join(path, "Contents", "MacOS", "GAMS MIRO")
-
-    # Initialize MIRO
-    if not skip_execution:
-        subprocess_env = os.environ.copy()
-        subprocess_env["MIRO"] = "1"
-        command = [sys.executable, model]
-        if args is not None:
-            command += args
-
-        process = subprocess.run(
-            command,
-            env=subprocess_env,
-            capture_output=True,
-            text=True,
-            encoding="utf-8",
-        )
-        if process.returncode != 0:
-            typer.echo(process.stderr, file=sys.stderr)
-            sys.exit(process.returncode)
-
-    # Run MIRO
-    subprocess_env = os.environ.copy()
-    if execution_mode == "deploy":
-        subprocess_env["MIRO_BUILD"] = "true"
-        execution_mode = "base"
-
-    subprocess_env["MIRO_MODEL_PATH"] = model
-    subprocess_env["MIRO_MODE"] = execution_mode
-    subprocess_env["MIRO_DEV_MODE"] = "true"
-    subprocess_env["MIRO_USE_TMP"] = "false"
-    subprocess_env["PYTHON_EXEC_PATH"] = sys.executable
-
-    subprocess.run([path], env=subprocess_env, check=True)
-
-
-def discover_miro():
-    system = platform.system()
-    if system == "Linux":
-        return None
-
-    home = os.path.expanduser("~")
-    standard_locations = {
-        "Darwin": [
-            os.path.join(
-                "/",
-                "Applications",
-                "GAMS MIRO.app",
-                "Contents",
-                "MacOS",
-                "GAMS MIRO",
-            ),
-            os.path.join(
-                home,
-                "Applications",
-                "GAMS MIRO.app",
-                "Contents",
-                "MacOS",
-                "GAMS MIRO",
-            ),
-        ],
-        "Windows": [
-            os.path.join("C:\\", "Program Files", "GAMS MIRO", "GAMS MIRO.exe"),
-            os.path.join(
-                home,
-                "AppData",
-                "Local",
-                "Programs",
-                "GAMS MIRO",
-                "GAMS MIRO.exe",
-            ),
-        ],
-    }
-
-    if system in ("Darwin", "Windows"):
-        for location in standard_locations[system]:
-            if os.path.isfile(location):
-                return location
-
-    return None
-
-
-if __name__ == "__main__":
-    app()
+from __future__ import annotations
+
+import os
+import platform
+import subprocess
+import sys
+from enum import Enum
+from pathlib import Path  # noqa: TC003
+from typing import Annotated, Optional
+
+import typer
+
+from gamspy.exceptions import ValidationError
+
+app = typer.Typer(
+    rich_markup_mode="rich",
+    short_help="To run your model with GAMS MIRO.",
+    help="[bold][yellow]Examples[/yellow][/bold]: gamspy run miro [--path <path_to_miro>] [--model <path_to_model>]",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+class ModeEnum(str, Enum):
+    config = "config"
+    base = "base"
+    deploy = "deploy"
+
+
+@app.command(
+    help="[bold][yellow]Examples[/yellow][/bold]: gamspy run miro [--path <path_to_miro>] [--model <path_to_model>]",
+    short_help="Runs a GAMSPY model with GAMS MIRO app.",
+)
+def miro(
+    mode: Annotated[
+        ModeEnum,
+        typer.Option("--mode", "-m", help="Execution mode of MIRO"),
+    ] = ModeEnum.base,  # type: ignore
+    path: Annotated[
+        Optional[Path],  # noqa: UP045
+        typer.Option(
+            "--path",
+            "-p",
+            exists=True,
+            help="Path to the MIRO executable (.exe, .app, or .AppImage)",
+        ),
+    ] = None,
+    skip_execution: Annotated[
+        bool,
+        typer.Option("--skip-execution", help="Whether to skip model execution."),
+    ] = False,
+    model: Annotated[
+        Optional[Path],  # noqa: UP045,
+        typer.Option("--model", "-g", exists=True, help="Path to the GAMSPy model."),
+    ] = None,
+    args: Annotated[
+        list[str] | None,
+        typer.Argument(help="Arguments to the GAMSPy model."),
+    ] = None,
+) -> None:
+    if model is None:
+        typer.echo("--model must be provided to run MIRO", file=sys.stderr)
+        sys.exit(1)
+
+    model = os.path.abspath(model)
+    execution_mode = mode.value
+    path = os.getenv("MIRO_PATH", path)
+
+    if path is None:
+        path = path if path is not None else discover_miro()
+
+    if path is None:
+        raise ValidationError("--path must be provided to run MIRO")
+
+    if platform.system() == "Darwin" and os.path.splitext(path)[1] == ".app":
+        path = os.path.join(path, "Contents", "MacOS", "GAMS MIRO")
+
+    # Initialize MIRO
+    if not skip_execution:
+        subprocess_env = os.environ.copy()
+        subprocess_env["MIRO"] = "1"
+        command = [sys.executable, model]
+        if args is not None:
+            command += args
+
+        process = subprocess.run(
+            command,
+            env=subprocess_env,
+            capture_output=True,
+            text=True,
+            encoding="utf-8",
+        )
+        if process.returncode != 0:
+            typer.echo(process.stderr, file=sys.stderr)
+            sys.exit(process.returncode)
+
+    # Run MIRO
+    subprocess_env = os.environ.copy()
+    if execution_mode == "deploy":
+        subprocess_env["MIRO_BUILD"] = "true"
+        execution_mode = "base"
+
+    subprocess_env["MIRO_MODEL_PATH"] = model
+    subprocess_env["MIRO_MODE"] = execution_mode
+    subprocess_env["MIRO_DEV_MODE"] = "true"
+    subprocess_env["MIRO_USE_TMP"] = "false"
+    subprocess_env["PYTHON_EXEC_PATH"] = sys.executable
+
+    subprocess.run([path], env=subprocess_env, check=True)
+
+
+def discover_miro():
+    system = platform.system()
+    if system == "Linux":
+        return None
+
+    home = os.path.expanduser("~")
+    standard_locations = {
+        "Darwin": [
+            os.path.join(
+                "/",
+                "Applications",
+                "GAMS MIRO.app",
+                "Contents",
+                "MacOS",
+                "GAMS MIRO",
+            ),
+            os.path.join(
+                home,
+                "Applications",
+                "GAMS MIRO.app",
+                "Contents",
+                "MacOS",
+                "GAMS MIRO",
+            ),
+        ],
+        "Windows": [
+            os.path.join("C:\\", "Program Files", "GAMS MIRO", "GAMS MIRO.exe"),
+            os.path.join(
+                home,
+                "AppData",
+                "Local",
+                "Programs",
+                "GAMS MIRO",
+                "GAMS MIRO.exe",
+            ),
+        ],
+    }
+
+    if system in ("Darwin", "Windows"):
+        for location in standard_locations[system]:
+            if os.path.isfile(location):
+                return location
+
+    return None
+
+
+if __name__ == "__main__":
+    app()