yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'use pathlib everywhere' (#2023) from type-checking into main

Browse Source
This commit is contained in:
clan-bot
2024-09-02 16:33:46 +00:00
parent d16f5211c4 222da58d13
commit 52707d333d
28 changed files with 89 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
pkgs/clan-cli/clan_cli/config/__init__.py
View File

@@ -2,7 +2,6 @@
import argparse
import json
import logging
import os
import re
from pathlib import Path
from typing import Any, get_origin
@@ -285,8 +284,8 @@ def set_option(
current[option_path_store[-1]] = casted
# check if there is an existing config file
if os.path.exists(settings_file):
with open(settings_file) as f:
if settings_file.exists():
with settings_file.open() as f:
current_config = json.load(f)
else:
current_config = {}
@@ -294,7 +293,7 @@ def set_option(
# merge and save the new config file
new_config = merge(current_config, result)
settings_file.parent.mkdir(parents=True, exist_ok=True)
with open(settings_file, "w") as f:
with settings_file.open("w") as f:
json.dump(new_config, f, indent=2)
print(file=f) # add newline at the end of the file to make git happy

4
pkgs/clan-cli/clan_cli/config/machine.py
View File

@@ -82,7 +82,7 @@ def config_for_machine(flake_dir: Path, machine_name: str) -> dict:
settings_path = machine_settings_file(flake_dir, machine_name)
if not settings_path.exists():
return {}
with open(settings_path) as f:
with settings_path.open() as f:
return json.load(f)
@@ -102,7 +102,7 @@ def set_config_for_machine(flake_dir: Path, machine_name: str, config: dict) ->
# write the config to a json file located at {flake}/machines/{machine_name}/settings.json
settings_path = machine_settings_file(flake_dir, machine_name)
settings_path.parent.mkdir(parents=True, exist_ok=True)
with open(settings_path, "w") as f:
with settings_path.open("w") as f:
json.dump(config, f)
if flake_dir is not None:

20
pkgs/clan-cli/clan_cli/dirs.py
View File

@@ -34,7 +34,7 @@ def clan_key_safe(flake_url: str) -> str:
def find_toplevel(top_level_files: list[str]) -> Path | None:
"""Returns the path to the toplevel of the clan flake"""
for project_file in top_level_files:
initial_path = Path(os.getcwd())
initial_path = Path.cwd()
path = Path(initial_path)
while path.parent != path:
if (path / project_file).exists():
@@ -56,30 +56,30 @@ def clan_templates() -> Path:
def user_config_dir() -> Path:
if sys.platform == "win32":
return Path(os.getenv("APPDATA", os.path.expanduser("~\\AppData\\Roaming\\")))
return Path(os.getenv("APPDATA", Path("~\\AppData\\Roaming\\").expanduser()))
if sys.platform == "darwin":
return Path(os.path.expanduser("~/Library/Application Support/"))
return Path(os.getenv("XDG_CONFIG_HOME", os.path.expanduser("~/.config")))
return Path("~/Library/Application Support/").expanduser()
return Path(os.getenv("XDG_CONFIG_HOME", Path("~/.config").expanduser()))
def user_data_dir() -> Path:
if sys.platform == "win32":
return Path(
os.getenv("LOCALAPPDATA", os.path.expanduser("~\\AppData\\Local\\"))
Path(os.getenv("LOCALAPPDATA", Path("~\\AppData\\Local\\").expanduser()))
)
if sys.platform == "darwin":
return Path(os.path.expanduser("~/Library/Application Support/"))
return Path(os.getenv("XDG_DATA_HOME", os.path.expanduser("~/.local/share")))
return Path("~/Library/Application Support/").expanduser()
return Path(os.getenv("XDG_DATA_HOME", Path("~/.local/share").expanduser()))
def user_cache_dir() -> Path:
if sys.platform == "win32":
return Path(
os.getenv("LOCALAPPDATA", os.path.expanduser("~\\AppData\\Local\\"))
Path(os.getenv("LOCALAPPDATA", Path("~\\AppData\\Local\\").expanduser()))
)
if sys.platform == "darwin":
return Path(os.path.expanduser("~/Library/Caches/"))
return Path(os.getenv("XDG_CACHE_HOME", os.path.expanduser("~/.cache")))
return Path("~/Library/Caches/").expanduser()
return Path(os.getenv("XDG_CACHE_HOME", Path("~/.cache").expanduser()))
def user_gcroot_dir() -> Path:

3
pkgs/clan-cli/clan_cli/facts/secret_modules/vm.py
View File

@@ -1,4 +1,3 @@
import os
import shutil
from pathlib import Path
@@ -30,6 +29,6 @@ class SecretStore(SecretStoreBase):
return (self.dir / service / name).exists()
def upload(self, output_dir: Path) -> None:
if os.path.exists(output_dir):
if output_dir.exists():
shutil.rmtree(output_dir)
shutil.copytree(self.dir, output_dir)

4
pkgs/clan-cli/clan_cli/inventory/__init__.py
View File

@@ -130,7 +130,7 @@ def load_inventory_json(
inventory_file = get_path(flake_dir)
if inventory_file.exists():
with open(inventory_file) as f:
with inventory_file.open() as f:
try:
res = json.load(f)
inventory = from_dict(Inventory, res)
@@ -153,7 +153,7 @@ def save_inventory(inventory: Inventory, flake_dir: str | Path, message: str) ->
"""
inventory_file = get_path(flake_dir)
with open(inventory_file, "w") as f:
with inventory_file.open("w") as f:
json.dump(dataclass_to_dict(inventory), f, indent=2)
commit_file(inventory_file, Path(flake_dir), commit_message=message)

4
pkgs/clan-cli/clan_cli/locked_open.py
View File

@@ -10,11 +10,11 @@ from .jsonrpc import ClanJSONEncoder
@contextmanager
def locked_open(filename: str | Path, mode: str = "r") -> Generator:
def locked_open(filename: Path, mode: str = "r") -> Generator:
"""
This is a context manager that provides an advisory write lock on the file specified by `filename` when entering the context, and releases the lock when leaving the context. The lock is acquired using the `fcntl` module's `LOCK_EX` flag, which applies an exclusive write lock to the file.
"""
with open(filename, mode) as fd:
with filename.open(mode) as fd:
fcntl.flock(fd, fcntl.LOCK_EX)
yield fd
fcntl.flock(fd, fcntl.LOCK_UN)

2
pkgs/clan-cli/clan_cli/machines/hardware.py
View File

@@ -185,7 +185,7 @@ def generate_machine_hardware_info(
hw_file.replace(backup_file)
print(f"Backed up existing {hw_file} to {backup_file}")
with open(hw_file, "w") as f:
with hw_file.open("w") as f:
f.write(out.stdout)
print(f"Successfully generated: {hw_file}")

2
pkgs/clan-cli/clan_cli/nix/__init__.py
View File

@@ -122,7 +122,7 @@ class Programs:
@classmethod
def is_allowed(cls: type["Programs"], program: str) -> bool:
if cls.allowed_programs is None:
with open(Path(__file__).parent / "allowed-programs.json") as f:
with (Path(__file__).parent / "allowed-programs.json").open() as f:
cls.allowed_programs = json.load(f)
return program in cls.allowed_programs

2
pkgs/clan-cli/clan_cli/secrets/folders.py
View File

@@ -42,5 +42,5 @@ def remove_object(path: Path, name: str) -> list[Path]:
msg = f"{name} not found in {path}"
raise ClanError(msg) from e
if not os.listdir(path):
os.rmdir(path)
path.rmdir()
return paths_to_commit

8
pkgs/clan-cli/clan_cli/secrets/groups.py
View File

@@ -122,7 +122,7 @@ def add_member(
if not user_target.is_symlink():
msg = f"Cannot add user {name}. {user_target} exists but is not a symlink"
raise ClanError(msg)
os.remove(user_target)
user_target.unlink()
user_target.symlink_to(os.path.relpath(source, user_target.parent))
return update_group_keys(flake_dir, group_folder.parent.name)
@@ -133,16 +133,16 @@ def remove_member(flake_dir: Path, group_folder: Path, name: str) -> None:
msg = f"{name} does not exist in group in {group_folder}: "
msg += list_directory(group_folder)
raise ClanError(msg)
os.remove(target)
target.unlink()
if len(os.listdir(group_folder)) > 0:
update_group_keys(flake_dir, group_folder.parent.name)
if len(os.listdir(group_folder)) == 0:
os.rmdir(group_folder)
group_folder.rmdir()
if len(os.listdir(group_folder.parent)) == 0:
os.rmdir(group_folder.parent)
group_folder.parent.rmdir()
def add_user(flake_dir: Path, group: str, name: str) -> None:

2
pkgs/clan-cli/clan_cli/secrets/key.py
View File

@@ -16,7 +16,7 @@ def extract_public_key(filepath: Path) -> str:
Extracts the public key from a given text file.
"""
try:
with open(filepath) as file:
with filepath.open() as file:
for line in file:
# Check if the line contains the public key
if line.startswith("# public key:"):

10
pkgs/clan-cli/clan_cli/secrets/secrets.py
View File

@@ -218,7 +218,7 @@ def allow_member(
if not user_target.is_symlink():
msg = f"Cannot add user '{name}' to {group_folder.parent.name} secret. {user_target} exists but is not a symlink"
raise ClanError(msg)
os.remove(user_target)
user_target.unlink()
user_target.symlink_to(os.path.relpath(source, user_target.parent))
changed = [user_target]
@@ -244,13 +244,13 @@ def disallow_member(group_folder: Path, name: str) -> list[Path]:
if len(keys) < 2:
msg = f"Cannot remove {name} from {group_folder.parent.name}. No keys left. Use 'clan secrets remove {name}' to remove the secret."
raise ClanError(msg)
os.remove(target)
target.unlink()
if len(os.listdir(group_folder)) == 0:
os.rmdir(group_folder)
group_folder.rmdir()
if len(os.listdir(group_folder.parent)) == 0:
os.rmdir(group_folder.parent)
group_folder.parent.rmdir()
return update_keys(
target.parent.parent, sorted(collect_keys_for_path(group_folder.parent))
@@ -337,7 +337,7 @@ def rename_command(args: argparse.Namespace) -> None:
if new_path.exists():
msg = f"Secret '{args.new_name}' already exists"
raise ClanError(msg)
os.rename(old_path, new_path)
old_path.rename(new_path)
commit_files(
[old_path, new_path],
flake_dir,

18
pkgs/clan-cli/clan_cli/secrets/sops.py
View File

@@ -172,13 +172,11 @@ def encrypt_file(
with NamedTemporaryFile(delete=False) as f:
try:
if isinstance(content, str):
with open(f.name, "w") as fd:
fd.write(content)
Path(f.name).write_text(content)
elif isinstance(content, bytes):
with open(f.name, "wb") as fd:
fd.write(content)
Path(f.name).write_bytes(content)
elif isinstance(content, io.IOBase):
with open(f.name, "w") as fd:
with Path(f.name).open("w") as fd:
shutil.copyfileobj(content, fd)
else:
msg = f"Invalid content type: {type(content)}"
@@ -191,13 +189,13 @@ def encrypt_file(
# atomic copy of the encrypted file
with NamedTemporaryFile(dir=folder, delete=False) as f2:
shutil.copyfile(f.name, f2.name)
os.rename(f2.name, secret_path)
Path(f2.name).rename(secret_path)
meta_path = secret_path.parent / "meta.json"
with open(meta_path, "w") as f_meta:
with meta_path.open("w") as f_meta:
json.dump(meta, f_meta, indent=2)
finally:
with suppress(OSError):
os.remove(f.name)
Path(f.name).unlink()
def decrypt_file(secret_path: Path) -> str:
@@ -214,7 +212,7 @@ def get_meta(secret_path: Path) -> dict:
meta_path = secret_path.parent / "meta.json"
if not meta_path.exists():
return {}
with open(meta_path) as f:
with meta_path.open() as f:
return json.load(f)
@@ -233,7 +231,7 @@ def write_key(path: Path, publickey: str, overwrite: bool) -> None:
def read_key(path: Path) -> str:
with open(path / "key.json") as f:
with Path(path / "key.json").open() as f:
try:
key = json.load(f)
except json.JSONDecodeError as e:

3
pkgs/clan-cli/clan_cli/secrets/types.py
View File

@@ -1,5 +1,4 @@
import argparse
import os
import re
from collections.abc import Callable
from pathlib import Path
@@ -20,7 +19,7 @@ def secret_name_type(arg_value: str) -> str:
def public_or_private_age_key_type(arg_value: str) -> str:
if os.path.isfile(arg_value):
if Path(arg_value).is_file():
arg_value = Path(arg_value).read_text().strip()
if arg_value.startswith("age1"):
return arg_value.strip()

3
pkgs/clan-cli/clan_cli/vars/secret_modules/vm.py
View File

@@ -1,4 +1,3 @@
import os
import shutil
from pathlib import Path
@@ -36,6 +35,6 @@ class SecretStore(SecretStoreBase):
return (self.dir / service / name).exists()
def upload(self, output_dir: Path) -> None:
if os.path.exists(output_dir):
if output_dir.exists():
shutil.rmtree(output_dir)
shutil.copytree(self.dir, output_dir)

3
pkgs/clan-cli/clan_cli/vms/qemu.py
View File

@@ -1,4 +1,3 @@
import os
import random
from collections.abc import Generator
from contextlib import contextmanager
@@ -43,7 +42,7 @@ def graphics_options(vm: VmConfig) -> GraphicOptions:
#"-chardev", "socket,id=vgpu,path=/tmp/vgpu.sock",
], cid)
# fmt: on
if not os.path.exists("/run/opengl-driver"):
if not Path("/run/opengl-driver").exists():
display_options = [
"-vga",
"none",

4
pkgs/clan-cli/docs.py
View File

@@ -313,7 +313,7 @@ def build_command_reference() -> None:
markdown += "</div>"
markdown += "\n"
with open(folder / "index.md", "w") as f:
with (folder / "index.md").open("w") as f:
f.write(markdown)
# Each top level category is a separate file
@@ -374,7 +374,7 @@ def build_command_reference() -> None:
files[folder / f"{filename}.md"] = markdown
for fname, content in files.items():
with open(fname, "w") as f:
with fname.open("w") as f:
f.write(content)

15
pkgs/clan-cli/tests/test_api_dataclass_compat.py
View File

@@ -12,7 +12,7 @@ from clan_cli.errors import ClanError
def find_dataclasses_in_directory(
directory: Path, exclude_paths: list[str] | None = None
) -> list[tuple[str, str]]:
) -> list[tuple[Path, str]]:
"""
Find all dataclass classes in all Python files within a nested directory.
@@ -26,28 +26,27 @@ def find_dataclasses_in_directory(
exclude_paths = []
dataclass_files = []
excludes = [os.path.join(directory, d) for d in exclude_paths]
excludes = [directory / d for d in exclude_paths]
for root, _, files in os.walk(directory, topdown=False):
for file in files:
if not file.endswith(".py"):
continue
file_path = os.path.join(root, file)
file_path = Path(root) / file
if file_path in excludes:
print(f"Skipping dataclass check for file: {file_path}")
continue
with open(file_path, encoding="utf-8") as f:
python_code = file_path.read_text()
try:
tree = ast.parse(f.read(), filename=file_path)
tree = ast.parse(python_code, filename=file_path)
for node in ast.walk(tree):
if isinstance(node, ast.ClassDef):
for deco in node.decorator_list:
if (
isinstance(deco, ast.Name)
and deco.id == "dataclass"
isinstance(deco, ast.Name) and deco.id == "dataclass"
) or (
isinstance(deco, ast.Call)
and isinstance(deco.func, ast.Name)
@@ -61,7 +60,7 @@ def find_dataclasses_in_directory(
def load_dataclass_from_file(
file_path: str, class_name: str, root_dir: str
file_path: Path, class_name: str, root_dir: str
) -> type | None:
"""
Load a dataclass from a given file path.

7
pkgs/clan-cli/tests/test_create_flake.py
View File

@@ -33,10 +33,9 @@ def test_create_flake(
# create a hardware-configuration.nix that doesn't throw an eval error
for patch_machine in ["jon", "sara"]:
with open(
flake_dir / "machines" / f"{patch_machine}/hardware-configuration.nix", "w"
) as hw_config_nix:
hw_config_nix.write("{}")
(
flake_dir / "machines" / f"{patch_machine}/hardware-configuration.nix"
).write_text("{}")
with capture_output as output:
cli.run(["machines", "list"])

3
pkgs/clan-cli/tests/test_vms_cli.py
View File

@@ -1,4 +1,3 @@
import os
from pathlib import Path
from typing import TYPE_CHECKING
@@ -13,7 +12,7 @@ from stdout import CaptureOutput
if TYPE_CHECKING:
from age_keys import KeyPair
no_kvm = not os.path.exists("/dev/kvm")
no_kvm = not Path("/dev/kvm").exists()
@pytest.mark.impure

2
pkgs/clan-vm-manager/clan_vm_manager/components/executor.py
View File

@@ -64,7 +64,7 @@ def _init_proc(
os.setsid()
# Open stdout and stderr
with open(out_file, "w") as out_fd:
with out_file.open("w") as out_fd:
os.dup2(out_fd.fileno(), sys.stdout.fileno())
os.dup2(out_fd.fileno(), sys.stderr.fileno())

12
pkgs/clan-vm-manager/clan_vm_manager/components/trayicon.py
View File

@@ -21,6 +21,7 @@
import os
import sys
import tempfile
from collections.abc import Callable
from typing import Any, ClassVar
@@ -884,14 +885,8 @@ class Win32Implementation(BaseImplementation):
# No custom icons present, fall back to default icons
ico_buffer = self._load_ico_buffer(icon_name, icon_size)
try:
import tempfile
file_handle = tempfile.NamedTemporaryFile(delete=False)
with file_handle:
with tempfile.NamedTemporaryFile(delete=False) as file_handle:
file_handle.write(ico_buffer)
return windll.user32.LoadImageA(
0,
encode_path(file_handle.name),
@@ -901,9 +896,6 @@ class Win32Implementation(BaseImplementation):
self.LR_LOADFROMFILE,
)
finally:
os.remove(file_handle.name)
def _destroy_h_icon(self):
from ctypes import windll

2
pkgs/clan-vm-manager/clan_vm_manager/components/vmobj.py
View File

@@ -279,7 +279,7 @@ class VMObject(GObject.Object):
if not self._log_file:
try:
self._log_file = open(proc.out_file) # noqa: SIM115
self._log_file = Path(proc.out_file).open() # noqa: SIM115
except Exception as ex:
log.exception(ex)
self._log_file = None

3
pkgs/clan-vm-manager/clan_vm_manager/views/list.py
View File

@@ -273,8 +273,7 @@ class ClanList(Gtk.Box):
logs.set_title(f"""📄<span weight="normal"> {name}</span>""")
# initial message. Streaming happens automatically when the file is changed by the build process
with open(vm.build_process.out_file) as f:
logs.set_message(f.read())
logs.set_message(vm.build_process.out_file.read_text())
views.set_visible_child_name("logs")

9
pkgs/classgen/main.py
View File

@@ -3,6 +3,7 @@ import argparse
import json
from collections.abc import Callable
from functools import partial
from pathlib import Path
from typing import Any
@@ -309,11 +310,11 @@ def generate_dataclass(schema: dict[str, Any], class_name: str = root_class) ->
def run_gen(args: argparse.Namespace) -> None:
print(f"Converting {args.input} to {args.output}")
dataclass_code = ""
with open(args.input) as f:
with args.input.open() as f:
schema = json.load(f)
dataclass_code = generate_dataclass(schema)
with open(args.output, "w") as f:
with args.output.open("w") as f:
f.write(
"""# DON NOT EDIT THIS FILE MANUALLY. IT IS GENERATED.
#
@@ -330,8 +331,8 @@ from typing import Any\n\n
def main() -> None:
parser = argparse.ArgumentParser()
parser.add_argument("input", help="Input JSON schema file")
parser.add_argument("output", help="Output Python file")
parser.add_argument("input", help="Input JSON schema file", type=Path)
parser.add_argument("output", help="Output Python file", type=Path)
parser.set_defaults(func=run_gen)
args = parser.parse_args()

15
pkgs/moonlight-sunshine-accept/moonlight_sunshine_accept/moonlight/init_config.py
View File

@@ -1,22 +1,15 @@
import argparse
from pathlib import Path
from .state import init_state
def read_file(file_path: str) -> str:
with open(file_path) as file:
return file.read()
def init_config(args: argparse.Namespace) -> None:
key = read_file(args.key)
certificate = read_file(args.certificate)
init_state(certificate, key)
init_state(args.certificate.read_text(), args.key.read_text())
print("Finished initializing moonlight state.")
def register_config_initialization_parser(parser: argparse.ArgumentParser) -> None:
parser.add_argument("--certificate")
parser.add_argument("--key")
parser.add_argument("--certificate", type=Path)
parser.add_argument("--key", type=Path)
parser.set_defaults(func=init_config)

5
pkgs/moonlight-sunshine-accept/moonlight_sunshine_accept/moonlight/state.py
View File

@@ -1,5 +1,4 @@
import contextlib
import os
import random
import string
from configparser import ConfigParser, DuplicateSectionError, NoOptionError
@@ -45,12 +44,12 @@ def convert_bytearray_to_string(byte_array: str) -> str:
# this must be created before moonlight is first run
def init_state(certificate: str, key: str) -> None:
print("Initializing moonlight state.")
os.makedirs(moonlight_config_dir(), exist_ok=True)
moonlight_config_dir().mkdir(parents=True, exist_ok=True)
print("Initialized moonlight config directory.")
print("Writing moonlight state file.")
# write the initial bootstrap config file
with open(moonlight_state_file(), "w") as file:
with moonlight_state_file().open("w") as file:
config = ConfigParser()
# bytearray ojbects are not supported by ConfigParser,
# so we need to adjust them ourselves

3
pyproject.toml
View File

@@ -1,5 +1,5 @@
[tool.mypy]
python_version = "3.10"
python_version = "3.11"
pretty = true
warn_redundant_casts = true
disallow_untyped_calls = true
@@ -28,6 +28,7 @@ lint.select = [
"N",
"PIE",
"PT",
"PTH",
"PYI",
"Q",
"RET",