xloft 0.1.17__py3-none-any.whl → 0.1.18__py3-none-any.whl

xloft/__init__.py

@@ -5,6 +5,10 @@ Modules exported by this package:
 - `NamedTuple`: Class imitates the behavior of the _named tuple_.
 """
 
-__all__ = ("NamedTuple",)
+__all__ = (
+    "to_human_size",
+    "NamedTuple",
+)
 
+from xloft.humanism import to_human_size
 from xloft.namedtuple import NamedTuple

xloft/humanism.py

@@ -0,0 +1,30 @@
+"""Humanism.
+
+The module contains the following functions:
+
+- `to_human_size(size)` - Returns a humanized string: 200 bytes | 1 KB | 1.5 MB etc.
+"""
+
+import math
+
+
+def to_human_size(size: int) -> str:
+    """Convert number of bytes to readable format.
+
+    Examples:
+        >>> from xloft import to_human_size
+        >>> to_human_size(200)
+        200 bytes
+        >>> to_human_size(1048576)
+        1 MB
+
+    Args:
+        size: The number of bytes.
+
+    Returns:
+        Returns a humanized string: 200 bytes | 1 KB | 1.5 MB etc.
+    """
+    idx: int = math.floor(math.log(size) / math.log(1024))
+    human_size: int | float = size if size < 1024 else abs(round(size / pow(1024, idx), 2))
+    order = ["bytes", "KB", "MB", "GB", "TB"][idx]
+    return "{:g} {}".format(human_size, order)

{xloft-0.1.17.dist-info → xloft-0.1.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xloft
-Version: 0.1.17
+Version: 0.1.18
 Summary: (XLOFT) X-Library of tools
 Project-URL: Homepage, https://github.com/kebasyaty/xloft
 Project-URL: Repository, https://github.com/kebasyaty/xloft
@@ -52,7 +52,6 @@ Description-Content-Type: text/markdown
       <a href="https://mypy-lang.org/" alt="Types: Mypy"><img src="https://img.shields.io/badge/types-Mypy-202235.svg?color=0c7ebf" alt="Types: Mypy"></a>
       <a href="https://docs.astral.sh/ruff/" alt="Code style: Ruff"><img src="https://img.shields.io/badge/code%20style-Ruff-FDD835.svg" alt="Code style: Ruff"></a>
       <a href="https://github.com/kebasyaty/xloft" alt="PyPI implementation"><img src="https://img.shields.io/pypi/implementation/xloft" alt="PyPI implementation"></a>
-      <a href="https://github.com/kebasyaty/xloft" alt="GitHub repository"><img src="https://img.shields.io/badge/--ecebeb?logo=github&logoColor=000000" alt="GitHub repository"></a>
       <br>
       <a href="https://pypi.org/project/xloft"><img src="https://img.shields.io/pypi/format/xloft" alt="Format"></a>
       <a href="https://github.com/kebasyaty/xloft"><img src="https://img.shields.io/github/languages/top/kebasyaty/xloft" alt="Top"></a>
@@ -61,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 one element `NamedTuple`.
+      Currently, the collection is represented by two elements of `ТameЕuple` and `to_human_size`.
     </p>
   </p>
 </div>
@@ -84,6 +83,8 @@ uv add xloft
 
 ## Usage
 
+- **NamedTuple**
+
 ```python
 from xloft import NamedTuple
 
@@ -152,6 +153,19 @@ del nt.y # => raise: AttributeCannotBeDelete
 del nt._id # => raise: AttributeCannotBeDelete
 ```
 
+- **to_human_size**
+
+```python
+from xloft import to_human_size
+
+
+s = to_human_size(200)
+print(s)  # => 200 bytes
+
+s = to_human_size(1048576)
+print(s)  # => 1 MB
+```
+
 ## Changelog
 
 [View the change history.](https://github.com/kebasyaty/xloft/blob/main/CHANGELOG.md "Changelog")

xloft-0.1.18.dist-info/RECORD

@@ -0,0 +1,9 @@
+xloft/__init__.py,sha256=zvpDtBWkgaj3oTMsDSWw2SLl7LMy7zO2SyvEhiKwzmg,287
+xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
+xloft/humanism.py,sha256=KQ-bIQJrVUZ3Xc5mVRQ07bvjq1LJzROr8tTV3RJWC0o,822
+xloft/namedtuple.py,sha256=OkAHqMaV4hN6Qj_oaOYQ9-y9x4Muv4mNrBn48T6RpiI,6818
+xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xloft-0.1.18.dist-info/METADATA,sha256=rewzGpwSxU4oT0xru5xSdQq0cxpgLyyApmSILBTPe-s,6696
+xloft-0.1.18.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xloft-0.1.18.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+xloft-0.1.18.dist-info/RECORD,,

xloft-0.1.17.dist-info/RECORD

@@ -1,8 +0,0 @@
-xloft/__init__.py,sha256=YtzkovVqW8hLxBXxM0U7K_qqfU8XBJ1pzX6tAgTUNFw,215
-xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
-xloft/namedtuple.py,sha256=OkAHqMaV4hN6Qj_oaOYQ9-y9x4Muv4mNrBn48T6RpiI,6818
-xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-xloft-0.1.17.dist-info/METADATA,sha256=o1sR41EDgbhanFcbH42an3NfaGClZW2ZsQz9tu-CDQw,6669
-xloft-0.1.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-xloft-0.1.17.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-xloft-0.1.17.dist-info/RECORD,,