xloft 0.1.9__py3-none-any.whl → 0.1.11__py3-none-any.whl

xloft/__init__.py

@@ -1,4 +1,9 @@
-"""(XLOFT) X-Library of tools."""
+"""(XLOFT) X-Library of tools.
+
+Modules exported by this package:
+
+- `NamedTuple`: Class imitates the behavior of the _named tuple_.
+"""
 
 __all__ = ("NamedTuple",)
 

xloft/namedtuple.py

@@ -1,4 +1,48 @@
-"""Named Tuple."""
+"""NamedTuple.
+
+This module contains the implementation of the `NamedTuple` class.
+`NamedTuple` class imitates the behavior of the _named tuple_.
+
+Examples:
+    >>> from xloft import NamedTuple
+    >>> nt = NamedTuple(x=10, y="Hello")
+    >>> nt.x
+    10
+    >>> nt.z
+    KeyError
+    >>> len(nt)
+    2
+    >>> nt.keys()
+    ["x", "y"]
+    >>> nt.values()
+    [10, "Hello"]
+    >>> nt.has_key("x")
+    True
+    >>> nt.has_key("z")
+    False
+    >>> nt.has_value(10)
+    True
+    >>> nt.has_value([1, 2, 3])
+    False
+    >>> nt.get("x")
+    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
+    >>> nt.x = 20
+    Error: AttributeDoesNotSetValue
+    >>> del nt.x
+    Error: AttributeCannotBeDelete
+"""
 
 from typing import Any
 
@@ -9,7 +53,7 @@ from xloft.errors import (
 
 
 class NamedTuple:
-    """Named Tuple."""
+    """This class imitates the behavior of the _named tuple_."""
 
     VAR_NAME_FOR_KEYS_LIST: str = "_jWjSaNy1RbtQinsN_keys"
 
@@ -21,32 +65,82 @@ class NamedTuple:
             self.__dict__[vnkl].append(name)
 
     def __len__(self) -> int:
-        """Get the number of elements."""
+        """Get the number of elements.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> len(nt)
+            2
+
+        Returns:
+            The number of elements in the tuple.
+        """
         return len(self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST])
 
     def __getattr__(self, name: str) -> Any:
-        """Getter."""
+        """Getter.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.x
+            10
+
+        Args:
+            name: Key name.
+
+        Returns:
+            Value of key.
+        """
         return self.__dict__[name]
 
     def __setattr__(self, name: str, value: Any) -> None:
-        """Fail Setter."""
+        """Blocked Setter."""
         raise AttributeDoesNotSetValue(name)
 
     def __delattr__(self, name: str) -> None:
-        """Fail Deleter."""
+        """Blocked Deleter."""
         raise AttributeCannotBeDelete(name)
 
     def get(self, key: str) -> Any:
-        """Return the value for key if key is in the dictionary, else `None`."""
+        """Return the value for key if key is in the dictionary, else `None`.
+
+        Args:
+            key: Key name.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.get("x")
+            10
+
+        Returns:
+            Value of key.
+        """
         value = self.__dict__.get(key)
         if value is not None:
             return value
         return None
 
-    def update(self, key: str, value: Any) -> Any:
+    def update(self, key: str, value: Any) -> None:
         """Update a value of key.
 
         Attention: This is an uncharacteristic action for the type `tuple`.
+
+        Args:
+            key: Key name.
+            value: Value of key.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.update("x", 20)
+            >>> nt.x
+            20
+
+        Returns:
+            None
         """
         keys: list[str] = self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST]
         if not key in keys:
@@ -55,30 +149,102 @@ class NamedTuple:
         self.__dict__[key] = value
 
     def to_dict(self) -> dict[str, Any]:
-        """Convert to the dictionary."""
-        keys: list[str] = self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST]
-        return {key: self.__dict__[key] for key in keys}
+        """Convert to the dictionary.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> d = nt.to_dict()
+            >>> d["x"]
+            10
+
+        Returns:
+            Dictionary with keys and values of the tuple.
+        """
+        attrs: dict[str, Any] = self.__dict__
+        keys: list[str] = attrs[self.__class__.VAR_NAME_FOR_KEYS_LIST]
+        return {key: attrs[key] for key in keys}
 
     def items(self) -> list[tuple[str, Any]]:
-        """Return a set-like object providing a view on the NamedTuple's items."""
-        keys: list[str] = self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST]
-        return [(key, self.__dict__[key]) for key in keys]
+        """Return a set-like object providing a view on the NamedTuple's items.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> for key, val in nt.items():
+            ...     print(f"Key: {key}, Value: {val}")
+            "Key: x, Value: 10"
+            "Key: y, Value: Hello"
+
+        Returns:
+            list[tuple[str, Any]]
+        """
+        attrs: dict[str, Any] = self.__dict__
+        keys: list[str] = attrs[self.__class__.VAR_NAME_FOR_KEYS_LIST]
+        return [(key, attrs[key]) for key in keys]
 
     def keys(self) -> list[str]:
-        """Get a list of keys."""
+        """Get a list of keys.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.keys()
+            ["x", "y"]
+
+        Returns:
+            List of keys.
+        """
         return self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST]
 
     def values(self) -> list[Any]:
-        """Get a list of values."""
-        keys: list[str] = self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST]
-        return [self.__dict__[key] for key in keys]
+        """Get a list of values.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.values()
+            [10, "Hello"]
+
+        Returns:
+            List of values.
+        """
+        attrs: dict[str, Any] = self.__dict__
+        keys: list[str] = attrs[self.__class__.VAR_NAME_FOR_KEYS_LIST]
+        return [attrs[key] for key in keys]
 
     def has_key(self, key: str) -> bool:
-        """Returns True if the key exists, otherwise False."""
+        """Returns True if the key exists, otherwise False.
+
+        Args:
+            key: Key name.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.has_key("x")
+            True
+
+        Returns:
+            True if the key exists, otherwise False.
+        """
         keys: list[str] = self.__dict__[self.__class__.VAR_NAME_FOR_KEYS_LIST]
         return key in keys
 
     def has_value(self, value: Any) -> bool:
-        """Returns True if the value exists, otherwise False."""
+        """Returns True if the value exists, otherwise False.
+
+        Args:
+            value: Value of key.
+
+        Examples:
+            >>> from xloft import NamedTuple
+            >>> nt = NamedTuple(x=10, y="Hello")
+            >>> nt.has_value(10)
+            True
+
+        Returns:
+            True if the value exists, otherwise False.
+        """
         values = self.values()
         return value in values

{xloft-0.1.9.dist-info → xloft-0.1.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xloft
-Version: 0.1.9
+Version: 0.1.11
 Summary: (XLOFT) X-Library of tools
 Project-URL: Homepage, https://github.com/kebasyaty/xloft
 Project-URL: Repository, https://github.com/kebasyaty/xloft
@@ -66,6 +66,10 @@ Description-Content-Type: text/markdown
 
 ##
 
+## Documentation
+
+Online browsable documentation is available at [https://kebasyaty.github.io/xloft/](https://kebasyaty.github.io/xloft/ "Documentation").
+
 ## Requirements
 
 [View the list of requirements.](https://github.com/kebasyaty/xloft/blob/main/REQUIREMENTS.md "View the list of requirements.")
@@ -107,12 +111,6 @@ nt.get("x")  # => 10
 nt.get("y")  # => "Hello"
 nt.get("z")  # => None
 
-nt.update("x", 20)
-nt.update("y", "Hi")
-nt.x  # => 20
-nt.y  # => "Hi"
-nt.update("z", [1, 2, 3])  # => raise: KeyError
-
 d = nt.to_dict()
 d["x"]  # => 10
 d["y"]  # => "Hello"
@@ -127,6 +125,12 @@ nt["x"] = 20  # => TypeError
 nt["y"] = "Hi"  # => TypeError
 nt["z"] = [1, 2, 3]  # => TypeError
 
+nt.update("x", 20)
+nt.update("y", "Hi")
+nt.x  # => 20
+nt.y  # => "Hi"
+nt.update("z", [1, 2, 3])  # => raise: KeyError
+
 nt.x = 20  # => raise: AttributeDoesNotSetValue
 nt.y = "Hi"  # => raise: AttributeDoesNotSetValue
 nt.z = [1, 2, 3]  # => raise: AttributeDoesNotSetValue

xloft-0.1.11.dist-info/RECORD

@@ -0,0 +1,8 @@
+xloft/__init__.py,sha256=YtzkovVqW8hLxBXxM0U7K_qqfU8XBJ1pzX6tAgTUNFw,215
+xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
+xloft/namedtuple.py,sha256=NT98kIuVoPf6LHHVaPAnveK9KdeBjxGlO_AZtpCnkWM,6745
+xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xloft-0.1.11.dist-info/METADATA,sha256=NAuMTBKl9QAEiTEv7WHzxl7wPASqLDYn_P5YSjHVhDg,5834
+xloft-0.1.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xloft-0.1.11.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
+xloft-0.1.11.dist-info/RECORD,,

xloft-0.1.9.dist-info/RECORD

@@ -1,8 +0,0 @@
-xloft/__init__.py,sha256=yV847dKh9ROtw1fX5NHvPaHN-9cHYOfu9URQ--OVKXw,107
-xloft/errors.py,sha256=GYXvi2l01VUDQSs6skiOfQsKLF6tFuUhJMqNkL7BJNI,857
-xloft/namedtuple.py,sha256=rUTa_9pwZUR3ISGDtTuOJ_ifdiqClNMOD0NSRlNkdyk,2953
-xloft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-xloft-0.1.9.dist-info/METADATA,sha256=BkI8nk28um9CQ0l1p6vqyzefT38sJsi9_Db05HeR7TI,5677
-xloft-0.1.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-xloft-0.1.9.dist-info/licenses/LICENSE,sha256=2zZINd6m_jNYlowdQImlEizyhSui5cBAJZRhWQURcEc,1095
-xloft-0.1.9.dist-info/RECORD,,