xloft 0.1.20__py3-none-any.whl → 0.1.22__py3-none-any.whl

xloft/__init__.py

@@ -4,12 +4,9 @@ Modules exported by this package:
 
 - `namedtuple`: Class imitates the behavior of the _named tuple_.
 - `humanism` - A collection of instruments for converting data to format is convenient for humans.
+- `quantum` - A set of tools for quantum calculations.
 """
 
-__all__ = (
-    "to_human_size",
-    "NamedTuple",
-)
+__all__ = ("NamedTuple",)
 
-from xloft.humanism import to_human_size
 from xloft.namedtuple import NamedTuple

xloft/quantum.py

@@ -0,0 +1,117 @@
+"""A set of tools for quantum calculations.
+
+The module contains the following tools:
+
+- `count_qubits()` - Counting the number of qubits of your computer.
+- `LoopMode` - Quantum loop mode.
+- `QuantumLoop` - Separation of the cycle into quantums.
+"""
+
+import concurrent.futures
+import multiprocessing
+from enum import Enum
+from typing import Any, Callable, Iterable, Never, assert_never
+
+
+def count_qubits() -> int:
+    """Counting the number of qubits of your computer.
+
+    A qubit in a regular computer is quantum of algorithm that is executed in
+    one iteration of a cycle in a separate processor thread.
+
+    Quantum is a function with an algorithm of task for data processing.
+
+    Examples:
+        >>> from xloft.quantum import count_qubits
+        >>> count_qubits()
+        16
+
+    Returns:
+        The number of qubits.
+    """
+    return multiprocessing.cpu_count()
+
+
+class LoopMode(Enum):
+    """Quantum loop mode."""
+
+    PROCESS_POOL = 1
+    THREAD_POOL = 2
+
+
+class QuantumLoop:
+    """Separation of the cycle into quantums.
+
+    Args:
+        quantum: A function that describes the task.
+        data: The data that needs to be processed.
+        timeout: The maximum number of seconds to wait. If None, then there
+                 is no limit on the wait time.
+        chunksize: The size of the chunks the iterable will be broken into
+                   before being passed to a child process. This argument is only
+                   used by ProcessPoolExecutor; it is ignored by ThreadPoolExecutor.
+        mode: The operating mode for a quantum loop: LoopMode.PROCESS_POOL | LoopMode.THREAD_POOL.
+
+    Examples:
+        >>> from xloft.quantum import LoopMode, QuantumLoop, count_qubits
+        >>> def quantum(self, item):
+        ... return item * item
+        >>> data = range(10)
+        >>> qloop = QuantumLoop(quantum, data, mode=LoopMode.PROCESS_POOL)
+        >>> qloop.run()
+        [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
+    """
+
+    def __init__(  # noqa: D107
+        self,
+        quantum: Callable,
+        data: Iterable[Any],
+        timeout: float | None = None,
+        chunksize: int = 1,
+        mode: LoopMode = LoopMode.PROCESS_POOL,
+    ) -> None:
+        self.quantum = quantum
+        self.data = data
+        self.timeout = timeout
+        self.chunksize = chunksize
+        self.mode = mode
+
+    def process_pool(self) -> list[Any]:
+        """Better suitable for operations for which large processor resources are required."""
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            results = list(
+                executor.map(
+                    self.quantum,
+                    self.data,
+                    timeout=self.timeout,
+                    chunksize=self.chunksize,
+                ),
+            )
+        return results
+
+    def thread_pool(self) -> list[Any]:
+        """More suitable for tasks related to input-output
+        (for example, network queries, file operations),
+        where GIL is freed during input-output operations."""  # noqa: D205, D209
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            results = list(
+                executor.map(
+                    self.quantum,
+                    self.data,
+                    timeout=self.timeout,
+                    chunksize=self.chunksize,
+                ),
+            )
+        return results
+
+    def run(self) -> list[Any]:
+        """Run the quantum loop."""
+        results: list[Any] = []
+        match self.mode.value:
+            case 1:
+                results = self.process_pool()
+            case 2:
+                results = self.thread_pool()
+            case _ as unreachable:
+                assert_never(Never(unreachable))
+        return results

{xloft-0.1.20.dist-info → xloft-0.1.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xloft
-Version: 0.1.20
+Version: 0.1.22
 Summary: (XLOFT) X-Library of tools
 Project-URL: Homepage, https://github.com/kebasyaty/xloft
 Project-URL: Repository, https://github.com/kebasyaty/xloft
@@ -60,7 +60,7 @@ Description-Content-Type: text/markdown
       <a href="https://github.com/kebasyaty/xloft/releases/" alt="GitHub release"><img src="https://img.shields.io/github/release/kebasyaty/xloft" alt="GitHub release"></a>
     </p>
     <p align="center">
-      Currently, the collection is represented by two elements of `NamedTuple` and `to_human_size`.
+      Currently, the collection is represented by three modules of `NamedTuple`, `Humanism` and `Quantum`.
     </p>
   </p>
 </div>
@@ -153,10 +153,10 @@ del nt.y # => raise: AttributeCannotBeDelete
 del nt._id # => raise: AttributeCannotBeDelete
 ```
 
-- **to_human_size**
+- **Humanism**
 
 ```python
-from xloft import to_human_size
+from xloft.humanism import to_human_size
 
 
 s = to_human_size(200)
@@ -169,6 +169,25 @@ s = to_human_size(1048575)
 print(s)  # => 1023.999 KB
 ```
 
+- **Quantum**
+
+```python
+from xloft.quantum import LoopMode, QuantumLoop, count_qubits
+
+num = count_qubits()
+print(num)  # => 16
+
+def quantum(item):
+    """Task."""
+    return item * item
+
+data = range(10)
+
+qloop = QuantumLoop(quantum, data, mode=LoopMode.PROCESS_POOL)
+results = qloop.run()
+print(results)  # => [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
+```
+
 ## Changelog
 
 [View the change history.](https://github.com/kebasyaty/xloft/blob/main/CHANGELOG.md "Changelog")

xloft-0.1.22.dist-info/RECORD

@@ -0,0 +1,10 @@
+xloft/__init__.py,sha256=FZ2m329mXkIm4ETgl0ERwEzRzsFvd-_1ug2Eo1kSVo0,371
+xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
+xloft/humanism.py,sha256=I6q56MhviapBSWF4B_1xd77TDwQMM1jrkbl1N-fOURc,1068
+xloft/namedtuple.py,sha256=OkAHqMaV4hN6Qj_oaOYQ9-y9x4Muv4mNrBn48T6RpiI,6818
+xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xloft/quantum.py,sha256=jkDo4mMTy2FXzeYWRDMG_iQ6DjixdeO1ujPNUIZF688,3867
+xloft-0.1.22.dist-info/METADATA,sha256=6qB7pAWa-hf7XygBqewmZZERodNsQXYQbCVzFcyz-Xs,7116
+xloft-0.1.22.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xloft-0.1.22.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+xloft-0.1.22.dist-info/RECORD,,

xloft-0.1.20.dist-info/RECORD

@@ -1,9 +0,0 @@
-xloft/__init__.py,sha256=1gISK3F9XZoQH08YjP0YN5HPUxRgpEe8qih1To2cLT8,387
-xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
-xloft/humanism.py,sha256=I6q56MhviapBSWF4B_1xd77TDwQMM1jrkbl1N-fOURc,1068
-xloft/namedtuple.py,sha256=OkAHqMaV4hN6Qj_oaOYQ9-y9x4Muv4mNrBn48T6RpiI,6818
-xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-xloft-0.1.20.dist-info/METADATA,sha256=mQrIKVa1QnRhYXDyzaOnAEl6gryQHEOIgzFtx58GbBQ,6750
-xloft-0.1.20.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-xloft-0.1.20.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-xloft-0.1.20.dist-info/RECORD,,