vortex-cli 4.10.1__tar.gz → 4.11.1__tar.gz

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.10.1
+Version: 4.11.1
 Summary: Vortex CLI
 Home-page: https://github.com/jordanamos/vortex-cli
 Author: Jordan Amos

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = vortex_cli
-version = 4.10.1
+version = 4.11.1
 description = Vortex CLI
 long_description = file: README.md
 long_description_content_type = text/markdown

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/cli.py

@@ -248,6 +248,16 @@ def add_clone_parser(
         ),
         type=Path,
     )
+    clone_parser.add_argument(
+        "--timeout",
+        "-t",
+        type=int,
+        default=100,
+        help=(
+            "Set the timeout duration in seconds when using --export. "
+            "Default is %(default)s."
+        ),
+    )
     _add_server_option(clone_parser)
     return clone_parser
 

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/commands/clone.py

@@ -25,13 +25,16 @@ async def _aexport_pmx(
     server: PuakmaServer,
     app_ids: list[int],
     output_dir: Path,
+    timeout: int,  # noqa: ASYNC109
 ) -> int:
     tasks = []
 
     async with server as s:
         await s.server_designer.ainitiate_connection()
         for app_id in app_ids:
-            task = asyncio.create_task(_aexport_app_pmx(server, app_id, output_dir))
+            task = asyncio.create_task(
+                _aexport_app_pmx(server, app_id, output_dir, timeout)
+            )
             tasks.append(task)
 
         ret = 0
@@ -55,8 +58,9 @@ async def _aexport_app_pmx(
     server: PuakmaServer,
     app_id: int,
     output_dir: Path,
+    timeout: int,  # noqa: ASYNC109
 ) -> int:
-    ret_bytes = await server.download_designer.adownload_pmx(app_id, True)
+    ret_bytes = await server.download_designer.adownload_pmx(app_id, True, timeout)
     now = datetime.datetime.now().strftime("%Y%m%d%H%M%S")
     output_path = output_dir / f"{now}_{server.host}_{app_id}.pmx"
 
@@ -268,6 +272,7 @@ def clone(
     server: PuakmaServer,
     app_ids: list[int],
     *,
+    timeout: int,
     get_resources: bool = False,
     open_urls: bool = False,
     reclone: bool = False,
@@ -289,7 +294,7 @@ def clone(
             elif not export_path.is_dir():
                 logger.error(f"'{export_path}' is not a directory.")
                 return 1
-            ret = asyncio.run(_aexport_pmx(server, app_ids, export_path))
+            ret = asyncio.run(_aexport_pmx(server, app_ids, export_path, timeout))
         else:
             ret = asyncio.run(
                 _aclone_apps(workspace, server, app_ids, get_resources, open_urls)

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/commands/copy.py

@@ -75,7 +75,7 @@ async def _acopy_obj(
         spinner.stop()
         print(f"Design Object {obj} already exists in {obj.app}.")
         print("Only the Design data/source will be updated.")
-        if input("[Y/y] to continue:") not in ["Y", "y"]:
+        if input("[Y/y] to continue:") not in ["Y", "y"]:  # noqa: ASYNC250
             logger.error("Operation Cancelled")
             spinner.start()
             return 1

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/main.py

@@ -81,6 +81,11 @@ def main(argv: Sequence[str] | None = None) -> int:
         action="store_true",
         help="Initialise the workspace and config files, if they don't already exist",
     )
+    parser.add_argument(
+        "--no-spin",
+        action="store_true",
+        help="Disable the spinner",
+    )
 
     command_parser = parser.add_subparsers(dest="command")
     cli.add_list_parser(command_parser)
@@ -173,6 +178,7 @@ def main(argv: Sequence[str] | None = None) -> int:
                 open_urls=args.open_urls,
                 reclone=args.reclone,
                 export_path=args.export_path,
+                timeout=args.timeout,
             )
         elif args.command == "watch":
             return watch(workspace, server)

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/models.py

@@ -140,9 +140,14 @@ class PuakmaServer:
         self.soap_path = soap_path
         self.webdesign_path = webdesign_path
         self.puakma_db_conn_id = puakma_db_conn_id
-        self.username = username or input("Enter your Username: ")
-        self.password = password or getpass.getpass("Enter your Password: ")
-
+        self.username = (
+            username or os.getenv("VORTEX_USERNAME") or input("Enter your Username: ")
+        )
+        self.password = (
+            password
+            or os.getenv("VORTEX_PASSWORD")
+            or getpass.getpass("Enter your Password: ")
+        )
         self._aclient = httpx.AsyncClient(auth=self.auth)
         self._client = httpx.Client(auth=self.auth)
         self.app_designer = AppDesigner(self)
@@ -322,8 +327,9 @@ class PuakmaApplication:
         return hash((self.host, self.id))
 
     @property
-    def dir_name(self) -> str:
-        return f"{self.host}_{self.group}_{self.name}"
+    def path(self) -> Path:
+        # the 'puakma' application doesn't have a group
+        return Path(self.host, self.group or "_", self.name)
 
     @property
     def url(self) -> str:
@@ -520,7 +526,7 @@ class DesignObject:
     def design_path(self, workspace: Workspace) -> DesignPath:
         return DesignPath(
             workspace,
-            workspace.path / self.app.dir_name / self.design_dir / self.file_name,
+            workspace.path / self.app.path / self.design_dir / self.file_name,
         )
 
     async def aupload(
@@ -630,7 +636,7 @@ class InvalidDesignPathError(Exception):
 class DesignPath:
     """
     Represents a path to a Design Object. Expects format:
-    /path/to/workspace/app_dir/design_dir/.../obj
+    /path/to/workspace/server/group/app_dir/design_dir/.../obj
     otherwise a InvalidDesignPathError is raised
     """
 
@@ -639,8 +645,10 @@ class DesignPath:
     ) -> None:
         try:
             rel_path = path.relative_to(workspace.path)
-            app_dir, design_dir, _rem = str(rel_path).split(os.path.sep, maxsplit=2)
-            app_dir_path = workspace.path / app_dir
+            server_dir, group_dir, app_dir, design_dir, _rem = str(rel_path).split(
+                os.path.sep, maxsplit=4
+            )
+            app_dir_path = workspace.path / server_dir / group_dir / app_dir
             self.app = PuakmaApplication.from_dir(app_dir_path)
             if must_exist and not path.exists():
                 raise ValueError(f"Design Object '{path}' does not exist")

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/soap.py

@@ -33,13 +33,16 @@ _XSI_NULL: Literal["xsi:null"] = "xsi:null"
 class _SOAPParam(NamedTuple):
     name: str
     value: Any
-    xsi_type: Literal[
-        "xsd:integer",
-        "xsd:string",
-        "xsd:boolean",
-        "xsd:base64Binary",
-        "xsd:int",
-    ] | None = None
+    xsi_type: (
+        Literal[
+            "xsd:integer",
+            "xsd:string",
+            "xsd:boolean",
+            "xsd:base64Binary",
+            "xsd:int",
+        ]
+        | None
+    ) = None
     array_type: Literal["xsd:string"] | None = None
 
 
@@ -179,7 +182,7 @@ class _PuakmaSOAPService(ABC):
         operation: str,
         params: list[_SOAPParam] | None = None,
         *,
-        timeout: int = 20,
+        timeout: int = 20,  # noqa: ASYNC109
     ) -> ET.Element:
         """
         Builds and sends a SOAP envelope to the service endpoint and returns the parsed
@@ -343,9 +346,9 @@ class DatabaseDesigner(_PuakmaSOAPService):
         for row in resp.findall(".//row"):
             ret.append(
                 {
-                    col_lookup[int(col.attrib["index"]) - 1]: col.text
-                    if col.text
-                    else ""
+                    col_lookup[int(col.attrib["index"]) - 1]: (
+                        col.text if col.text else ""
+                    )
                     for col in row
                 }
             )
@@ -400,6 +403,7 @@ class DownloadDesigner(_PuakmaSOAPService):
         self,
         app_id: int,
         include_source: bool = False,
+        timeout: int = 100,  # noqa: ASYNC109
     ) -> bytes:
         """Returns bytes xml"""
         operation = "downloadPmx"
@@ -408,9 +412,9 @@ class DownloadDesigner(_PuakmaSOAPService):
             _SOAPParam("p2", include_source, _XSD_BOOLEAN),
         ]
         # This operation takes a while for big applications, set timeout to 100
-        resp = await self._apost(operation, params, timeout=100)
+        resp = await self._apost(operation, params, timeout=timeout)
         if resp.text is not None:
-            return base64.b64decode(resp.text)
+            return base64.b64decode(resp.text, validate=True)
         else:
             return b""
 

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/spinner.py

@@ -17,6 +17,7 @@ class Spinner:
         self.delay = 0.1
         self.running = False
         self.thread: threading.Thread | None = None
+        self.disabled = not sys.stdout.isatty()
 
     def _spin(self) -> None:
         while self.running:
@@ -25,6 +26,8 @@ class Spinner:
             time.sleep(0.1)
 
     def start(self) -> None:
+        if self.disabled:
+            return
         self.running = True
         self.thread = threading.Thread(target=self._spin)
         self.thread.start()
@@ -34,6 +37,8 @@ class Spinner:
         sys.stdout.flush()
 
     def stop(self) -> None:
+        if self.disabled:
+            return
         self.running = False
         if self.thread:
             self.thread.join()

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex/workspace.py

@@ -141,16 +141,16 @@ class Workspace:
     def mkdir(self, app: PuakmaApplication, force_recreate: bool = False) -> Path:
         """
         Creates a .PuakmaApplication.pickle file within a newly created app directory
-        with the format 'host_group_name' inside the workspace.
+        with the format 'host/group/name' inside the workspace.
         Returns the full path to the new app directory
         """
-        app_path = self.path / app.dir_name
-        if app_path.exists() and force_recreate:
-            shutil.rmtree(app_path)
-        app_path.mkdir(exist_ok=True)
-        with open(app_path / app.MANIFEST_FILE, "wb") as f:
+        full_path = self.path / app.path
+        if full_path.exists() and force_recreate:
+            shutil.rmtree(full_path)
+        full_path.mkdir(exist_ok=True, parents=True)
+        with open(full_path / app.MANIFEST_FILE, "wb") as f:
             pickle.dump(app, f)
-        return app_path
+        return full_path
 
     def listdir(
         self, server: PuakmaServer | None = None, *, strict: bool = True
@@ -163,20 +163,17 @@ class Workspace:
         contain a .PuakmaApplication.pickle file.
         """
         ret = []
-        for sub_dir in self.path.iterdir():
-            if sub_dir.is_dir():
-                if strict:
-                    try:
-                        app = PuakmaApplication.from_dir(sub_dir)
-                        if server and app.host != server.host:
-                            continue
-                    except ValueError:
-                        continue
-                else:
-                    MANIFEST_FILE = sub_dir / PuakmaApplication.MANIFEST_FILE
-                    if not MANIFEST_FILE.exists():
-                        continue
-                ret.append(sub_dir)
+        pattern = "**/.pma"
+        if server:
+            pattern = f"{server.host}/**/.pma"
+        for app_file in self.path.glob(pattern):
+            app_dir = app_file.parent
+            if strict:
+                try:
+                    PuakmaApplication.from_dir(app_dir)
+                except ValueError:
+                    continue
+            ret.append(app_dir)
         return ret
 
     def lookup_design_obj(

{vortex_cli-4.10.1 → vortex_cli-4.11.1}/vortex_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.10.1
+Version: 4.11.1
 Summary: Vortex CLI
 Home-page: https://github.com/jordanamos/vortex-cli
 Author: Jordan Amos