From 285a83ec974795ca6bc05b207b9fc4afcd603029 Mon Sep 17 00:00:00 2001 From: Qubasa Date: Fri, 8 Mar 2024 23:47:27 +0700 Subject: [PATCH] clan_cli: Renamed ClanUrl to FlakeId --- pkgs/clan-cli/clan_cli/clan_uri.py | 58 +++++++++---------- pkgs/clan-cli/clan_cli/machines/machines.py | 16 ++--- pkgs/clan-cli/tests/test_clan_uri.py | 55 ++++-------------- .../clan_vm_manager/components/vmobj.py | 8 +-- .../clan_vm_manager/singletons/use_vms.py | 2 +- 5 files changed, 52 insertions(+), 87 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/clan_uri.py b/pkgs/clan-cli/clan_cli/clan_uri.py index 203c8a6de..9cb387cb8 100644 --- a/pkgs/clan-cli/clan_cli/clan_uri.py +++ b/pkgs/clan-cli/clan_cli/clan_uri.py @@ -10,22 +10,30 @@ from .errors import ClanError @dataclass -class ClanUrl: - value: str | Path +class FlakeId: + _value: str | Path def __str__(self) -> str: - return ( - f"{self.value}" # The __str__ method returns a custom string representation - ) + return f"{self._value}" # The __str__ method returns a custom string representation + + @property + def path(self) -> Path: + assert isinstance(self._value, Path) + return self._value + + @property + def url(self) -> str: + assert isinstance(self._value, str) + return self._value def __repr__(self) -> str: - return f"ClanUrl({self.value})" + return f"ClanUrl({self._value})" def is_local(self) -> bool: - return isinstance(self.value, Path) + return isinstance(self._value, Path) def is_remote(self) -> bool: - return isinstance(self.value, str) + return isinstance(self._value, str) # Parameters defined here will be DELETED from the nested uri @@ -37,19 +45,19 @@ class MachineParams: @dataclass class MachineData: - url: ClanUrl + flake_id: FlakeId name: str = "defaultVM" params: MachineParams = dataclasses.field(default_factory=MachineParams) def get_id(self) -> str: - return f"{self.url}#{self.name}" + return f"{self.flake_id}#{self.name}" # Define the ClanURI class class ClanURI: _orig_uri: str _components: urllib.parse.ParseResult - url: ClanUrl + flake_id: FlakeId _machines: list[MachineData] # Initialize the class with a clan:// URI @@ -77,7 +85,7 @@ class ClanURI: ) # Parse the URL into a ClanUrl object - self.url = self._parse_url(clean_comps) + self.flake_id = self._parse_url(clean_comps) # Parse the fragment into a list of machine queries # Then parse every machine query into a MachineParameters object @@ -90,10 +98,10 @@ class ClanURI: # If there are no machine fragments, add a default machine if len(machine_frags) == 0: - default_machine = MachineData(url=self.url) + default_machine = MachineData(flake_id=self.flake_id) self._machines.append(default_machine) - def _parse_url(self, comps: urllib.parse.ParseResult) -> ClanUrl: + def _parse_url(self, comps: urllib.parse.ParseResult) -> FlakeId: comb = ( comps.scheme, comps.netloc, @@ -104,11 +112,11 @@ class ClanURI: ) match comb: case ("file", "", path, "", "", _) | ("", "", path, "", "", _): # type: ignore - url = ClanUrl(Path(path).expanduser().resolve()) + flake_id = FlakeId(Path(path).expanduser().resolve()) case _: - url = ClanUrl(comps.geturl()) + flake_id = FlakeId(comps.geturl()) - return url + return flake_id def _parse_machine_query(self, machine_frag: str) -> MachineData: comp = urllib.parse.urlparse(machine_frag) @@ -128,7 +136,7 @@ class ClanURI: # we need to make sure there are no conflicts del query[dfield.name] params = MachineParams(**machine_params) - machine = MachineData(url=self.url, name=machine_name, params=params) + machine = MachineData(flake_id=self.flake_id, name=machine_name, params=params) return machine @property @@ -139,19 +147,7 @@ class ClanURI: return self._orig_uri def get_url(self) -> str: - return str(self.url) - - def to_json(self) -> dict[str, Any]: - return { - "_orig_uri": self._orig_uri, - "url": str(self.url), - "machines": [dataclasses.asdict(m) for m in self._machines], - } - - def from_json(self, data: dict[str, Any]) -> None: - self._orig_uri = data["_orig_uri"] - self.url = data["url"] - self._machines = [MachineData(**m) for m in data["machines"]] + return str(self.flake_id) @classmethod def from_str( diff --git a/pkgs/clan-cli/clan_cli/machines/machines.py b/pkgs/clan-cli/clan_cli/machines/machines.py index 7b572dc86..72e4b9f99 100644 --- a/pkgs/clan-cli/clan_cli/machines/machines.py +++ b/pkgs/clan-cli/clan_cli/machines/machines.py @@ -66,7 +66,7 @@ class Machine: if machine is None: uri = ClanURI.from_str(str(flake), name) machine = uri.machine - self.flake: str | Path = machine.url.value + self.flake: str | Path = machine.flake_id._value self.name: str = machine.name self.data: MachineData = machine else: @@ -77,12 +77,12 @@ class Machine: self._flake_path: Path | None = None self._deployment_info: None | dict[str, str] = deployment_info - state_dir = vm_state_dir(flake_url=str(self.data.url), vm_name=self.data.name) + state_dir = vm_state_dir(flake_url=str(self.flake), vm_name=self.data.name) self.vm: QMPWrapper = QMPWrapper(state_dir) def __str__(self) -> str: - return f"Machine(name={self.data.name}, flake={self.data.url})" + return f"Machine(name={self.data.name}, flake={self.data.flake_id})" def __repr__(self) -> str: return str(self) @@ -139,12 +139,12 @@ class Machine: if self._flake_path: return self._flake_path - if self.data.url.is_local(): - self._flake_path = Path(str(self.data.url)) - elif self.data.url.is_remote(): - self._flake_path = Path(nix_metadata(str(self.data.url))["path"]) + if self.data.flake_id.is_local(): + self._flake_path = self.data.flake_id.path + elif self.data.flake_id.is_remote(): + self._flake_path = Path(nix_metadata(self.data.flake_id.url)["path"]) else: - raise ClanError(f"Unsupported flake url: {self.data.url}") + raise ClanError(f"Unsupported flake url: {self.data.flake_id}") assert self._flake_path is not None return self._flake_path diff --git a/pkgs/clan-cli/tests/test_clan_uri.py b/pkgs/clan-cli/tests/test_clan_uri.py index f8c09cb7a..efddafa64 100644 --- a/pkgs/clan-cli/tests/test_clan_uri.py +++ b/pkgs/clan-cli/tests/test_clan_uri.py @@ -1,6 +1,6 @@ from pathlib import Path -from clan_cli.clan_uri import ClanURI, ClanUrl +from clan_cli.clan_uri import ClanURI def test_get_url() -> None: @@ -21,22 +21,13 @@ def test_get_url() -> None: def test_local_uri() -> None: # Create a ClanURI object from a local URI uri = ClanURI("clan://file:///home/user/Downloads") - match uri.url: - case ClanUrl.LOCAL.value(path): - assert path == Path("/home/user/Downloads") # type: ignore - case _: - assert False + assert uri.flake_id.path == Path("/home/user/Downloads") def test_is_remote() -> None: # Create a ClanURI object from a remote URI uri = ClanURI("clan://https://example.com") - - match uri.url: - case ClanUrl.REMOTE.value(url): - assert url == "https://example.com" # type: ignore - case _: - assert False + assert uri.flake_id.url == "https://example.com" def test_direct_local_path() -> None: @@ -56,12 +47,7 @@ def test_remote_with_clanparams() -> None: uri = ClanURI("clan://https://example.com") assert uri.machine.name == "defaultVM" - - match uri.url: - case ClanUrl.REMOTE.value(url): - assert url == "https://example.com" # type: ignore - case _: - assert False + assert uri.flake_id.url == "https://example.com" def test_remote_with_all_params() -> None: @@ -69,11 +55,7 @@ def test_remote_with_all_params() -> None: assert uri.machine.name == "myVM" assert uri._machines[1].name == "secondVM" assert uri._machines[1].params.dummy_opt == "1" - match uri.url: - case ClanUrl.REMOTE.value(url): - assert url == "https://example.com?password=12345" # type: ignore - case _: - assert False + assert uri.flake_id.url == "https://example.com?password=12345" def test_from_str_remote() -> None: @@ -82,11 +64,7 @@ def test_from_str_remote() -> None: assert uri.get_orig_uri() == "clan://https://example.com#myVM" assert uri.machine.name == "myVM" assert len(uri._machines) == 1 - match uri.url: - case ClanUrl.REMOTE.value(url): - assert url == "https://example.com" # type: ignore - case _: - assert False + assert uri.flake_id.url == "https://example.com" def test_from_str_local() -> None: @@ -95,11 +73,8 @@ def test_from_str_local() -> None: assert uri.get_orig_uri() == "clan://~/Projects/democlan#myVM" assert uri.machine.name == "myVM" assert len(uri._machines) == 1 - match uri.url: - case ClanUrl.LOCAL.value(path): - assert str(path).endswith("/Projects/democlan") # type: ignore - case _: - assert False + assert uri.flake_id.is_local() + assert str(uri.flake_id).endswith("/Projects/democlan") # type: ignore def test_from_str_local_no_machine() -> None: @@ -108,11 +83,8 @@ def test_from_str_local_no_machine() -> None: assert uri.get_orig_uri() == "clan://~/Projects/democlan" assert uri.machine.name == "defaultVM" assert len(uri._machines) == 1 - match uri.url: - case ClanUrl.LOCAL.value(path): - assert str(path).endswith("/Projects/democlan") # type: ignore - case _: - assert False + assert uri.flake_id.is_local() + assert str(uri.flake_id).endswith("/Projects/democlan") # type: ignore def test_from_str_local_no_machine2() -> None: @@ -121,8 +93,5 @@ def test_from_str_local_no_machine2() -> None: assert uri.get_orig_uri() == "clan://~/Projects/democlan#syncthing-peer1" assert uri.machine.name == "syncthing-peer1" assert len(uri._machines) == 1 - match uri.url: - case ClanUrl.LOCAL.value(path): - assert str(path).endswith("/Projects/democlan") # type: ignore - case _: - assert False + assert uri.flake_id.is_local() + assert str(uri.flake_id).endswith("/Projects/democlan") # type: ignore diff --git a/pkgs/clan-vm-manager/clan_vm_manager/components/vmobj.py b/pkgs/clan-vm-manager/clan_vm_manager/components/vmobj.py index 7b47cdaa8..02a7ada31 100644 --- a/pkgs/clan-vm-manager/clan_vm_manager/components/vmobj.py +++ b/pkgs/clan-vm-manager/clan_vm_manager/components/vmobj.py @@ -115,15 +115,15 @@ class VMObject(GObject.Object): uri = ClanURI.from_str( url=self.data.flake.flake_url, machine_name=self.data.flake.flake_attr ) - if uri.url.is_local(): + if uri.flake_id.is_local(): self.machine = Machine( name=self.data.flake.flake_attr, - flake=Path(str(uri.url)), + flake=uri.flake_id.path, ) - if uri.url.is_remote(): + if uri.flake_id.is_remote(): self.machine = Machine( name=self.data.flake.flake_attr, - flake=str(uri.url), + flake=uri.flake_id.url, ) yield self.machine self.machine = None diff --git a/pkgs/clan-vm-manager/clan_vm_manager/singletons/use_vms.py b/pkgs/clan-vm-manager/clan_vm_manager/singletons/use_vms.py index 50072c59a..71854844d 100644 --- a/pkgs/clan-vm-manager/clan_vm_manager/singletons/use_vms.py +++ b/pkgs/clan-vm-manager/clan_vm_manager/singletons/use_vms.py @@ -111,7 +111,7 @@ class ClanStore: del self.clan_store[vm.data.flake.flake_url][vm.data.flake.flake_attr] def get_vm(self, uri: ClanURI) -> None | VMObject: - vm_store = self.clan_store.get(str(uri.url)) + vm_store = self.clan_store.get(str(uri.flake_id)) if vm_store is None: return None machine = vm_store.get(uri.machine.name, None)