diff --git a/pyproject.toml b/pyproject.toml index 103539a..3e5d6d7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,12 +31,6 @@ requires-python = ">= 3.11" [tool.hatch.version] path = "spcd/__init__.py" -[tool.pydoclint] -allow-init-docstring = true -quiet = true -skip-checking-short-docstrings = false -style = "sphinx" - [tool.ruff] line-length = 80 diff --git a/readme.md b/readme.md index bee7dab..df9ea36 100644 --- a/readme.md +++ b/readme.md @@ -286,7 +286,6 @@ Handle project workflows in a unified way: * automate versions fetching * gource, xvfb, xauth * handle openh264 repositories -* link from workspace to actions root * rpm fusion * tex * translate to french diff --git a/spcd/__init__.py b/spcd/__init__.py index 0df38c4..fbb64e7 100644 --- a/spcd/__init__.py +++ b/spcd/__init__.py @@ -26,13 +26,10 @@ def clone_project_branch() -> None: split() log.info(project) split() - log.info( - """\ -%s + log.info(f"""\ +{project.url} ↓ -""", - project.url, - ) +""") run( "git", "clone", @@ -69,8 +66,6 @@ def install_python_packages() -> None: "hatch", "mypy", "pelican", - "pydoclint", - "pylint", "pytest", "ruff", "sphinx", @@ -87,12 +82,12 @@ def list_environment_variables() -> None: step("List environment variables") for variable, value in sorted(projects.environment.items()): if variable not in ["SPCD", "SPCD_SSH_KEY"]: - log.info("%s = %s", variable, value) + log.info(f"{variable} = {value}") else: - log.info("%s", variable) + log.info(f"{variable}") -def main(main_file: str) -> None: +def main(main: str) -> None: """Entry point to initialize environment or run a specific command.""" paths = environ["PATH"].split(pathsep) if env.SPCD_PYTHON_VENV_BINARIES not in paths: @@ -103,7 +98,7 @@ def main(main_file: str) -> None: list_environment_variables() clone_project_branch() set_ssh() - install_commands(main_file) + install_commands(main) install_python_packages() else: f = getattr(cmd, name.replace("-", "_")) diff --git a/spcd/project.py b/spcd/project.py index c295d57..709d554 100644 --- a/spcd/project.py +++ b/spcd/project.py @@ -27,7 +27,7 @@ ROOT = [ class Project: """Current project.""" - def __init__(self, projects: Projects) -> None: + def __init__(self: Project, projects: Projects) -> None: """Set projects, branch, name, root & url.""" self.projects = projects # branch @@ -45,11 +45,7 @@ class Project: # url self.url = add_url_path(projects.url, self.name) - def __repr__(self) -> str: - """Represent project.""" - return f"Project(projects={self.projects!r})" - - def __str__(self) -> str: + def __str__(self: Project) -> str: """List branch, name, root & url.""" return f"""\ branch = {self.branch} diff --git a/spcd/projects.py b/spcd/projects.py index c64e3b3..c1f2403 100644 --- a/spcd/projects.py +++ b/spcd/projects.py @@ -20,7 +20,7 @@ SERVER_URL = [ class Projects: """Other projects.""" - def __init__(self) -> None: + def __init__(self: Projects) -> None: """Set environment, group, name & url.""" self.environment = os.environ # group, name @@ -34,20 +34,8 @@ class Projects: if value := self.environment.get(variable, None): self.url = add_url_path(value, self.group) - def __repr__(self) -> str: - """Represent projects. - - :return: representation - :rtype: str - """ - return "Projects()" - - def __str__(self) -> str: - """List group, name & url. - - :return: string - :rtype: str - """ + def __str__(self: Projects) -> str: + """List group, name & url.""" return f"""\ group = {self.group} name = {self.name} diff --git a/spcd/shell.py b/spcd/shell.py index 0a587e7..f9f9b33 100644 --- a/spcd/shell.py +++ b/spcd/shell.py @@ -3,8 +3,3 @@ import importlib env = importlib.import_module("env") - -try: - STEP = int(env.SPCD_STEP) -except AttributeError: - STEP = 1 diff --git a/spcd/util.py b/spcd/util.py index 73a5309..a77691a 100644 --- a/spcd/util.py +++ b/spcd/util.py @@ -7,31 +7,18 @@ from urllib.parse import urlparse, urlunparse from rwx import fs from rwx.log import stream as log -from spcd import shell from spcd.shell import env def add_url_path(url: str, extra_path: str) -> str: - """Append an extra segment to an existing URL. - - :param url: base URL - :type url: str - :param extra_path: path to append - :type extra_path: str - :return: new URL - :rtype: str - """ + """Append an extra segment to an existing URL.""" parts = urlparse(url) parts = parts._replace(path=str(Path(parts.path) / extra_path)) return urlunparse(parts) def browse(root: Path) -> None: - """Frame the browsing of a root directory in the log output. - - :param root: directory to browse - :type root: Path - """ + """Frame the browsing of a root directory in the log output.""" paths = [] for directory, _, files in os.walk(root): for file in files: @@ -46,11 +33,7 @@ def browse(root: Path) -> None: def cat(file: Path) -> None: - """Frame the content of a file in the log output. - - :param file: file to read the content from - :type file: Path - """ + """Frame the content of a file in the log output.""" text = str(file) frame(text) log.info(fs.read_file_text(file).rstrip()) @@ -58,21 +41,13 @@ def cat(file: Path) -> None: def frame(text: str) -> None: - """Open a new frame in the log output. - - :param text: text to start the frame with - :type text: str - """ - log.info("%s%s", env.SPCD_OPEN, text) + """Open a new frame in the log output.""" + log.info(f"{env.SPCD_OPEN}{text}") def shut(text: str) -> None: - """Close current frame in the log output. - - :param text: text to shut the frame with - :type text: str - """ - log.info("%s%s", env.SPCD_SHUT, text) + """Close current frame in the log output.""" + log.info(f"{env.SPCD_SHUT}{text}") def split() -> None: @@ -81,12 +56,8 @@ def split() -> None: def step(text: str) -> None: - """Increment the step number of the current build process. - - :param text: text to display - :type text: str - """ - shell.STEP += 1 + """Increment the step number of the current build process.""" + env.SPCD_STEP += 1 log.info(env.SPCD_DOWN) - log.info("%s %s %s", env.SPCD_VERT, shell.STEP, text) + log.info(f"{env.SPCD_VERT} {env.SPCD_STEP} {text}") log.info(env.SPCD___UP)