diff --git a/pyproject.toml b/pyproject.toml index 06f8b3b..103539a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,6 +33,7 @@ path = "spcd/__init__.py" [tool.pydoclint] allow-init-docstring = true +quiet = true skip-checking-short-docstrings = false style = "sphinx" diff --git a/spcd/__init__.py b/spcd/__init__.py index 85fa914..0df38c4 100644 --- a/spcd/__init__.py +++ b/spcd/__init__.py @@ -26,10 +26,13 @@ def clone_project_branch() -> None: split() log.info(project) split() - log.info("""\ + log.info( + """\ %s ↓ -""", project.url) +""", + project.url, + ) run( "git", "clone", diff --git a/spcd/project.py b/spcd/project.py index c295d57..8cc8181 100644 --- a/spcd/project.py +++ b/spcd/project.py @@ -44,16 +44,3 @@ class Project: self.root = Path(value) # 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: - """List branch, name, root & url.""" - return f"""\ -branch = {self.branch} - name = {self.name} - root = {self.root} - url = {self.url} -""" diff --git a/spcd/projects.py b/spcd/projects.py index 5185feb..81627e6 100644 --- a/spcd/projects.py +++ b/spcd/projects.py @@ -33,15 +33,3 @@ class Projects: for variable in SERVER_URL: if value := self.environment.get(variable, None): self.url = add_url_path(value, self.group) - - def __repr__(self) -> str: - """Represent projects.""" - return "Projects()" - - def __str__(self) -> str: - """List group, name & url.""" - return f"""\ -group = {self.group} - name = {self.name} - url = {self.url} -""" diff --git a/spcd/util.py b/spcd/util.py index 66fd269..73a5309 100644 --- a/spcd/util.py +++ b/spcd/util.py @@ -12,14 +12,26 @@ from spcd.shell import env def add_url_path(url: str, extra_path: str) -> str: - """Append an extra segment to an existing URL.""" + """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 + """ 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.""" + """Frame the browsing of a root directory in the log output. + + :param root: directory to browse + :type root: Path + """ paths = [] for directory, _, files in os.walk(root): for file in files: @@ -34,7 +46,11 @@ def browse(root: Path) -> None: def cat(file: Path) -> None: - """Frame the content of a file in the log output.""" + """Frame the content of a file in the log output. + + :param file: file to read the content from + :type file: Path + """ text = str(file) frame(text) log.info(fs.read_file_text(file).rstrip()) @@ -42,12 +58,20 @@ def cat(file: Path) -> None: def frame(text: str) -> None: - """Open a new frame in the log output.""" + """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) def shut(text: str) -> None: - """Close current frame in the log output.""" + """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) @@ -57,7 +81,11 @@ def split() -> None: def step(text: str) -> None: - """Increment the step number of the current build process.""" + """Increment the step number of the current build process. + + :param text: text to display + :type text: str + """ shell.STEP += 1 log.info(env.SPCD_DOWN) log.info("%s %s %s", env.SPCD_VERT, shell.STEP, text)