winipedia-utils 0.2.63__py3-none-any.whl → 0.6.6__py3-none-any.whl

winipedia_utils/artifacts/build.py

@@ -0,0 +1,78 @@
+"""Build utilities for creating and managing project builds.
+
+This module provides functions for building and managing project artifacts,
+including creating build scripts, configuring build environments, and
+handling build dependencies. These utilities help with the packaging and
+distribution of project code.
+"""
+
+import platform
+from abc import abstractmethod
+from pathlib import Path
+
+from winipedia_utils.git.github.workflows.base.base import Workflow
+from winipedia_utils.oop.mixins.mixin import ABCLoggingMixin
+
+
+class Build(ABCLoggingMixin):
+    """Base class for build scripts.
+
+    Subclass this class and implement the get_artifacts method to create
+    a build script for your project. The build method will be called
+    automatically when the class is initialized. At the end of the file add
+    if __name__ == "__main__":
+        YourBuildClass()
+    """
+
+    ARTIFACTS_PATH = Workflow.ARTIFACTS_PATH
+
+    @classmethod
+    @abstractmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Build the project.
+
+        Returns:
+            list[Path]: List of paths to the built artifacts
+        """
+
+    @classmethod
+    def __init__(cls) -> None:
+        """Initialize the build script."""
+        cls.build()
+
+    @classmethod
+    def build(cls) -> None:
+        """Build the project.
+
+        This method is called by the __init__ method.
+        It takes all the files and renames them with -platform.system()
+        and puts them in the artifacts folder.
+        """
+        cls.ARTIFACTS_PATH.mkdir(parents=True, exist_ok=True)
+        artifacts = cls.get_artifacts()
+        for artifact in artifacts:
+            parent = artifact.parent
+            if parent != cls.ARTIFACTS_PATH:
+                msg = f"You must create {artifact} in {cls.ARTIFACTS_PATH}"
+                raise FileNotFoundError(msg)
+
+            # rename the files with -platform.system()
+            new_name = f"{artifact.stem}-{platform.system()}{artifact.suffix}"
+            new_path = cls.ARTIFACTS_PATH / new_name
+            artifact.rename(new_path)
+
+
+class WinipediaUtilsBuild(Build):
+    """Build script for winipedia_utils."""
+
+    @classmethod
+    def get_artifacts(cls) -> list[Path]:
+        """Build the project."""
+        paths = [cls.ARTIFACTS_PATH / "build.txt"]
+        for path in paths:
+            path.write_text("Hello World!")
+        return paths
+
+
+if __name__ == "__main__":
+    WinipediaUtilsBuild()

winipedia_utils/concurrent/concurrent.py

@@ -20,8 +20,6 @@ from typing import TYPE_CHECKING, Any, cast
 
 from tqdm import tqdm
 
-from winipedia_utils.concurrent.multiprocessing import get_spwan_pool
-from winipedia_utils.concurrent.multithreading import imap_unordered
 from winipedia_utils.iterating.iterate import get_len_with_default
 from winipedia_utils.logging.logger import get_logger
 
@@ -210,6 +208,13 @@ def concurrent_loop(  # noqa: PLR0913
     Returns:
         list[Any]: Results from the process_function executions
     """
+    from winipedia_utils.concurrent.multiprocessing import (  # noqa: PLC0415  # avoid circular import
+        get_spwan_pool,
+    )
+    from winipedia_utils.concurrent.multithreading import (  # noqa: PLC0415  # avoid circular import
+        imap_unordered,
+    )
+
     process_args_len = get_len_with_default(process_args, process_args_len)
     process_args = generate_process_args(
         process_function=process_function,

winipedia_utils/concurrent/multiprocessing.py

@@ -15,6 +15,7 @@ from functools import wraps
 from multiprocessing.pool import Pool
 from typing import Any
 
+from winipedia_utils.concurrent.concurrent import concurrent_loop
 from winipedia_utils.logging.logger import get_logger
 
 logger = get_logger(__name__)
@@ -118,8 +119,6 @@ def multiprocess_loop(
         Also given functions must be pickle-able.
 
     """
-    from winipedia_utils.concurrent.concurrent import concurrent_loop
-
     return concurrent_loop(
         threading=False,
         process_function=process_function,

winipedia_utils/concurrent/multithreading.py

@@ -15,6 +15,8 @@ from collections.abc import Callable, Generator, Iterable
 from concurrent.futures import Future, ThreadPoolExecutor, as_completed
 from typing import Any
 
+from winipedia_utils.concurrent.concurrent import concurrent_loop
+
 
 def get_future_results_as_completed(
     futures: Iterable[Future[Any]],
@@ -62,8 +64,6 @@ def multithread_loop(
         ThreadPoolExecutor is used for I/O-bound tasks, not for CPU-bound tasks.
 
     """
-    from winipedia_utils.concurrent.concurrent import concurrent_loop
-
     return concurrent_loop(
         threading=True,
         process_function=process_function,