xloft 0.1.16__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/namedtuple.py

@@ -4,17 +4,21 @@
 
 Examples:
     >>> from xloft import NamedTuple
-    >>> nt = NamedTuple(x=10, y="Hello")
+    >>> nt = NamedTuple(x=10, y="Hello", _id="507c7f79bcf86cd7994f6c0e")
     >>> nt.x
     10
+    >>> nt.y
+    Hello
+    >>> nt._id
+    507c7f79bcf86cd7994f6c0e
     >>> nt.z
     KeyError
     >>> len(nt)
-    2
+    3
     >>> nt.keys()
-    ["x", "y"]
+    ["x", "y", "_id"]
     >>> nt.values()
-    [10, "Hello"]
+    [10, "Hello", "507c7f79bcf86cd7994f6c0e"]
     >>> nt.has_key("x")
     True
     >>> nt.has_key("z")
@@ -27,20 +31,21 @@ Examples:
     10
     >>> nt.get("z")
     None
-    >>> nt.update("z", [1, 2, 3])
-    KeyError
     >>> d = nt.to_dict()
     >>> d["x"]
     10
-    >>> nt["z"] = [1, 2, 3]
-    TypeError
-    >>> nt.update("x", 20)
-    >>> nt.x
-    20
     >>> for key, val in nt.items():
     ...     print(f"Key: {key}, Value: {val}")
     "Key: x, Value: 10"
     "Key: y, Value: Hello"
+    "Key: _id, value: 507c7f79bcf86cd7994f6c0e"
+    >>> nt.update("x", 20)
+    >>> nt.x
+    20
+    >>> nt.update("z", [1, 2, 3])
+    KeyError
+    >>> nt["z"] = [1, 2, 3]
+    TypeError
     >>> nt.x = 20
     Error: AttributeDoesNotSetValue
     >>> del nt.x

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xloft
-Version: 0.1.16
+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
@@ -49,9 +49,9 @@ Description-Content-Type: text/markdown
       <a href="https://github.com/kebasyaty/xloft/issues"><img src="https://img.shields.io/github/issues/kebasyaty/xloft.svg" alt="GitHub issues"></a>
       <a href="https://pepy.tech/projects/xloft"><img src="https://static.pepy.tech/badge/xloft" alt="PyPI Downloads"></a>
       <a href="https://github.com/kebasyaty/xloft/blob/main/LICENSE" alt="GitHub license"><img src="https://img.shields.io/github/license/kebasyaty/xloft" alt="GitHub license"></a>
+      <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>
@@ -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 one element `NamedTuple`.
+      Currently, the collection is represented by two elements of `ТameЕuple` and `to_human_size`.
     </p>
   </p>
 </div>
@@ -83,38 +83,44 @@ uv add xloft
 
 ## Usage
 
+- **NamedTuple**
+
 ```python
 from xloft import NamedTuple
 
 
-nt = NamedTuple(x=10, y="Hello")
+nt = NamedTuple(x=10, y="Hello", _id="507c7f79bcf86cd7994f6c0e")
 # or
-d = {"x": 10, "y": "Hello"}
+d = {"x": 10, "y": "Hello", "_id": "507c7f79bcf86cd7994f6c0e"}
 nt = NamedTuple(**d)
 
 nt.x  # => 10
-nt.y  # => "Hello"
+nt.y  # => Hello
+nt._id  # => 507c7f79bcf86cd7994f6c0e
 nt.z  # => raise: KeyError
 
-len(nt)  # => 2
-nt.keys()  # => ["x", "y"]
-nt.values()  # => [10, "Hello"]
+len(nt)  # => 3
+nt.keys()  # => ["x", "y", "_id"]
+nt.values()  # => [10, "Hello", "507c7f79bcf86cd7994f6c0e"]
 
 nt.has_key("x")  # => True
 nt.has_key("y")  # => True
+nt.hsa_key("_id")  # => True
 nt.has_key("z")  # => False
 
 nt.has_value(10)  # => True
 nt.has_value("Hello")  # => True
+nt.has_value("507c7f79bcf86cd7994f6c0e")  # => True
 nt.has_value([1, 2, 3])  # => False
 
 nt.get("x")  # => 10
-nt.get("y")  # => "Hello"
+nt.get("y")  # => Hello
+nt.get("_id")  # => 507c7f79bcf86cd7994f6c0e
 nt.get("z")  # => None
 
 d = nt.to_dict()
 d["x"]  # => 10
-d.get("y")  # => "Hello"
+d.get("y")  # => Hello
 d.get("z") # => None
 
 for key, val in nt.items():
@@ -122,23 +128,42 @@ for key, val in nt.items():
 
 nt.update("x", 20)
 nt.update("y", "Hi")
+nt.update("_id", "new_id")
 nt.x  # => 20
-nt.y  # => "Hi"
+nt.y  # => Hi
+nt._id  # => new_id
 nt.update("z", [1, 2, 3])  # => raise: KeyError
 
 nt["x"]  # => raise: KeyError
 nt["y"]  # => raise: KeyError
+nt["_id"]  # => raise: KeyError
 nt["z"]  # => raise: KeyError
 nt["x"] = 20  # => TypeError
 nt["y"] = "Hi"  # => TypeError
+nt["_id"] = "new_id"  # => TypeError
 nt["z"] = [1, 2, 3]  # => TypeError
 
 nt.x = 20  # => raise: AttributeDoesNotSetValue
 nt.y = "Hi"  # => raise: AttributeDoesNotSetValue
+nt._id = "new_id"  # => raise: AttributeDoesNotSetValue
 nt.z = [1, 2, 3]  # => raise: AttributeDoesNotSetValue
 
 del nt.x  # => raise: AttributeCannotBeDelete
 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

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.16.dist-info/RECORD

@@ -1,8 +0,0 @@
-xloft/__init__.py,sha256=YtzkovVqW8hLxBXxM0U7K_qqfU8XBJ1pzX6tAgTUNFw,215
-xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
-xloft/namedtuple.py,sha256=3ua0zTh9aAk7pucr6Mxrn6l-vRs_Jj0LdYwhij8PFsg,6631
-xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-xloft-0.1.16.dist-info/METADATA,sha256=9kqznL4M1xNoZB4POK4vkFiVeJp39L61OnLPY-E_OVk,6037
-xloft-0.1.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-xloft-0.1.16.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-xloft-0.1.16.dist-info/RECORD,,