xloft 0.1.0__py3-none-any.whl

xloft/__init__.py

@@ -0,0 +1,5 @@
+"""(XLOFT) X-Library of tools."""
+
+__all__ = ("NamedTuple",)
+
+from xloft.namedtuple import NamedTuple

xloft/errors.py

@@ -0,0 +1,24 @@
+"""XLOT Exceptions."""
+
+
+class XLOTException(Exception):
+    """Root Custom Exception."""
+
+    def __init__(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]# noqa: D107
+        super().__init__(*args, **kwargs)
+
+
+class AttributeDoesNotSetValue(XLOTException):
+    """Exception is raised if the attribute does not setting value."""
+
+    def __init__(self, attribute_name: str) -> None:  # noqa: D107
+        self.message = f"The attribute `{attribute_name}` does not setting value!"
+        super().__init__(self.message)
+
+
+class AttributeCannotBeDelete(XLOTException):
+    """Exception is raised if the attribute cannot be delete."""
+
+    def __init__(self, attribute_name: str) -> None:  # noqa: D107
+        self.message = f"The attribute `{attribute_name}` cannot be delete!"
+        super().__init__(self.message)

xloft/namedtuple.py

@@ -0,0 +1,54 @@
+"""Named Tuple."""
+
+from typing import Any
+
+from xloft.errors import (
+    AttributeCannotBeDelete,
+    AttributeDoesNotSetValue,
+)
+
+
+class NamedTuple:
+    """Named Tuple."""
+
+    def __init__(self, **kwargs: dict[str, Any]) -> None:  # noqa: D107
+        for name, value in kwargs.items():
+            self.__dict__[name] = value
+
+    def __getattr__(self, name: str) -> Any:
+        """Getter."""
+        return self.__dict__[name]
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """Setter."""
+        raise AttributeDoesNotSetValue(name)
+
+    def __delattr__(self, name: str) -> None:
+        """Deleter."""
+        raise AttributeCannotBeDelete(name)
+
+    def __getitem__(self, key: str) -> Any:
+        """Access by  name of key."""
+        return self.__dict__[key]
+
+    def get(self, key: str, default: Any | None = None) -> Any | None:
+        """Return the value for key if key is in the dictionary, else default."""
+        value = self.__dict__.get(key)
+        if value is not None:
+            return value
+        return default
+
+    def update(self, key: str, value: Any) -> Any:
+        """Update a value of key.
+
+        Attention: This is an uncharacteristic action for the type `tuple`.
+        """
+        self.__dict__[key] = value
+
+    def to_dict(self) -> dict[str, Any]:
+        """Convert to the dictionary."""
+        return {key: value for key, value in self.__dict__.items() if not callable(value)}
+
+    def items(self) -> list[tuple[str, Any]]:
+        """Return a set-like object providing a view on the NamedTuple's items."""
+        return [(key, value) for key, value in self.__dict__.items() if not callable(value)]

xloft-0.1.0.dist-info/METADATA

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: xloft
+Version: 0.1.0
+Summary: (XLOFT) X-Library of tools
+Project-URL: Homepage, https://github.com/kebasyaty/xloft
+Project-URL: Repository, https://github.com/kebasyaty/xloft
+Project-URL: Source, https://github.com/kebasyaty/xloft
+Project-URL: Bug Tracker, https://github.com/kebasyaty/xloft/issues
+Project-URL: Changelog, https://github.com/kebasyaty/xloft/blob/v0/CHANGELOG.md
+Author-email: kebasyaty <kebasyaty@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: collection,namedtuple,tools,xloft
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.12
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <p align="center">
+    <a href="https://github.com/kebasyaty/xloft">
+      <img
+        height="90"
+        alt="Logo"
+        src="https://raw.githubusercontent.com/kebasyaty/xloft/main/assets/logo.svg">
+    </a>
+  </p>
+  <p>
+    <h1>XLOFT</h1>
+    <h3>(XLOFT) X-Library of tools.</h3>
+    <p align="center">
+      <a href="https://github.com/kebasyaty/xloft/actions/workflows/test.yml" alt="Build Status"><img src="https://github.com/kebasyaty/xloft/actions/workflows/specs.yml/badge.svg" alt="Build Status"></a>
+      <a href="https://kebasyaty.github.io/xloft/" alt="Docs"><img src="https://img.shields.io/badge/docs-available-brightgreen.svg" alt="Docs"></a>
+      <a href="https://pypi.python.org/pypi/xloft/" alt="PyPI pyversions"><img src="https://img.shields.io/pypi/pyversions/xloft.svg" alt="PyPI pyversions"></a>
+      <a href="https://pypi.python.org/pypi/xloft/" alt="PyPI status"><img src="https://img.shields.io/pypi/status/xloft.svg" alt="PyPI status"></a>
+      <a href="https://pypi.python.org/pypi/xloft/" alt="PyPI version fury.io"><img src="https://badge.fury.io/py/xloft.svg" alt="PyPI version fury.io"></a>
+      <br>
+      <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://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>
+      <a href="https://github.com/kebasyaty/xloft"><img src="https://img.shields.io/github/repo-size/kebasyaty/xloft" alt="Size"></a>
+      <a href="https://github.com/kebasyaty/xloft"><img src="https://img.shields.io/github/last-commit/kebasyaty/xloft/main" alt="Last commit"></a>
+    </p>
+    <p align="center">
+      Currently, the collection is represented by one element `NamedTuple`.
+    </p>
+  </p>
+</div>
+
+##
+
+## Requirements
+
+[View the list of requirements.](https://github.com/kebasyaty/xloft/blob/main/REQUIREMENTS.md "View the list of requirements.")
+
+## Installation
+
+```shell
+uv add xloft
+```
+
+## Usage
+
+```python
+from xloft import NamedTuple
+
+
+nt = NamedTuple(x=10, y="Hello")
+# or
+d = {"x": 10, "y": "Hello"}
+nt = NamedTuple(**d)
+
+nt.x  # => 10
+nt.y  # => "Hello"
+nt.z  # => raise: KeyError
+
+nt["x"]  # => 10
+nt["y"]  # => "Hello"
+nt["z"]  # => raise: KeyError
+
+nt.get("x")  # => 10
+nt.get("y")  # => "Hello"
+nt.get("z")  # => None
+nt.get("z", [1, 2, 3] )  # => [1, 2, 3]
+
+nt.x = 20  # => raise: AttributeDoesNotSetValue
+nt.y = "Hi"  # => raise: AttributeDoesNotSetValue
+nt.z = [1, 2, 3]  # => raise: AttributeDoesNotSetValue
+
+nt.update("x", 20)
+nt.update("y", "Hi")
+nt["x"]  # => 20
+nt["y"]  # => "Hi"
+
+d = nt.to_dict()
+d["x"]  # => 10
+d["y"]  # => "Hello"
+
+for key, val in nt.items():
+    print(f"Key: {key}, Value: {val}")
+
+del nt.x  # => raise: AttributeCannotBeDelete
+del nt.y # => raise: AttributeCannotBeDelete
+```
+
+### [See more examples here.](https://github.com/kebasyaty/xloft/tree/main/examples "See more examples here.")
+
+## Changelog
+
+[View the change history.](https://github.com/kebasyaty/xloft/blob/main/CHANGELOG.md "Changelog")
+
+## License
+
+**This project is licensed under the** [MIT](https://github.com/kebasyaty/xloft/blob/main/LICENSE "MIT")**.**

xloft-0.1.0.dist-info/RECORD

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

xloft-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

xloft-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gennady Kostyunin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.