lacus.utils 1.0.0__py3-none-any.whl

lacus/utils/__init__.py

@@ -0,0 +1,11 @@
+from .describe_type import describe_type
+from .generate_random_sequence import generate_random_sequence
+from .types import SequenceType
+
+__all__ = [
+    "SequenceType",
+    "describe_type",
+    "generate_random_sequence",
+]
+
+__version__ = "1.0.0"

lacus/utils/describe_type.py

@@ -0,0 +1,150 @@
+import math
+from collections.abc import Callable
+from typing import Any
+
+
+def _describe_item(item: Any) -> str:
+    """Return a type label for an element inside a list or tuple."""
+    if item is None:
+        return "NoneType"
+
+    if isinstance(item, bool):
+        return "boolean"
+
+    if isinstance(item, int):
+        return "number"
+
+    if isinstance(item, float):
+        if math.isnan(item):
+            return "NaN"
+
+        if math.isinf(item):
+            return "Infinity"
+
+        return "number"
+
+    if isinstance(item, str):
+        return "string"
+
+    return _describe_type(item)
+
+
+def _describe_sequence(
+    items: list[Any] | tuple[Any, ...],
+    empty_label: str,
+    suffix: str,
+) -> str:
+    if not items:
+        return empty_label
+
+    unique_types: dict[str, None] = {}
+
+    for item in items:
+        label = _describe_item(item)
+
+        if label not in unique_types:
+            unique_types[label] = None
+
+    type_labels = list(unique_types.keys())
+
+    if len(type_labels) == 1:
+        return f"{type_labels[0]}{suffix}"
+
+    return f"({' | '.join(type_labels)}){suffix}"
+
+
+def _describe_type(value: Any) -> str:
+    if isinstance(value, list):
+        return _describe_sequence(value, "Array (empty)", "[]")
+
+    if isinstance(value, tuple):
+        return _describe_sequence(value, "tuple (empty)", " tuple")
+
+    if value is None:
+        return "NoneType"
+
+    if isinstance(value, bool):
+        return "boolean"
+
+    if isinstance(value, int):
+        return "integer number"
+
+    if isinstance(value, float):
+        if math.isnan(value):
+            return "NaN"
+
+        if math.isinf(value):
+            return "Infinity"
+
+        return "float number"
+
+    if isinstance(value, complex):
+        return "complex number"
+
+    if isinstance(value, str):
+        return "string"
+
+    if isinstance(value, dict):
+        return "dict"
+
+    if isinstance(value, set):
+        return "set"
+
+    if isinstance(value, frozenset):
+        return "frozenset"
+
+    if isinstance(value, bytes):
+        return "bytes"
+
+    if isinstance(value, bytearray):
+        return "bytearray"
+
+    if isinstance(value, type):
+        return "type"
+
+    if isinstance(value, Callable):
+        return "function"
+
+    return "object"
+
+
+def describe_type(value: Any) -> str:
+    """Describe the type of a value for error messages.
+
+    Args:
+        value: Any value to describe.
+
+    Returns:
+        A human-readable type label. For example, ``None`` returns ``"NoneType"``,
+        ``42`` returns ``"integer number"``, ``[1, 2, 3]`` returns ``"number[]"``,
+        and ``(1, "a")`` returns ``"(number | string) tuple"``.
+
+    Examples:
+        >>> describe_type(None)
+        'NoneType'
+        >>> describe_type("hello")
+        'string'
+        >>> describe_type(True)
+        'boolean'
+        >>> describe_type(42)
+        'integer number'
+        >>> describe_type(3.14)
+        'float number'
+        >>> describe_type(float("nan"))
+        'NaN'
+        >>> describe_type(float("inf"))
+        'Infinity'
+        >>> describe_type([])
+        'Array (empty)'
+        >>> describe_type([1, 2, 3])
+        'number[]'
+        >>> describe_type([1, "a", 2])
+        '(number | string)[]'
+        >>> describe_type({})
+        'dict'
+        >>> describe_type(())
+        'tuple (empty)'
+        >>> describe_type((1, 2))
+        'number tuple'
+    """
+    return _describe_type(value)

lacus/utils/generate_random_sequence.py

@@ -0,0 +1,40 @@
+import secrets
+
+from .types import SequenceType
+
+_NUMERIC = "0123456789"
+_ALPHABETIC = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+_ALPHANUMERIC = _NUMERIC + _ALPHABETIC
+
+
+def generate_random_sequence(size: int, sequence_type: SequenceType) -> str:
+    """Generate a random character sequence of the given length and type.
+
+    Args:
+        size: Length of the sequence.
+        sequence_type: Character set to draw from. One of ``"numeric"`` (``0-9``),
+            ``"alphabetic"`` (``A-Z``), or ``"alphanumeric"`` (``0-9A-Z``).
+
+    Returns:
+        A random string of the requested length using uppercase letters and/or
+        digits, depending on ``sequence_type``.
+
+    Examples:
+        >>> generate_random_sequence(10, "numeric")  # doctest: +SKIP
+        '9956000611'
+        >>> generate_random_sequence(6, "alphabetic")  # doctest: +SKIP
+        'AXQMZB'
+        >>> generate_random_sequence(8, "alphanumeric")  # doctest: +SKIP
+        '8ZFB2K09'
+    """
+    if size < 0:
+        raise ValueError(f"size must be non-negative, got {size}")
+
+    if sequence_type == "numeric":
+        chars = _NUMERIC
+    elif sequence_type == "alphabetic":
+        chars = _ALPHABETIC
+    else:
+        chars = _ALPHANUMERIC
+
+    return "".join(secrets.choice(chars) for _ in range(size))

lacus/utils/types.py

@@ -0,0 +1,9 @@
+from typing import Literal
+
+SequenceType = Literal["alphabetic", "alphanumeric", "numeric"]
+"""Character type for random sequence generation.
+
+- ``"alphanumeric"``: digits and uppercase letters (``0-9A-Z``).
+- ``"numeric"``: digits only (``0-9``).
+- ``"alphabetic"``: uppercase letters only (``A-Z``).
+"""

lacus_utils-1.0.0.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: lacus.utils
+Version: 1.0.0
+Summary: Reusable utilities for Lacus Solutions Python packages
+Author: Julio L. Muller
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/LacusSolutions/br-utils-py
+Project-URL: Source, https://github.com/LacusSolutions/br-utils-py
+Project-URL: Tracker, https://github.com/LacusSolutions/br-utils-py/issues
+Keywords: utils,utilities,helpers,random,sequence,type
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Lacus Solutions' Utils
+
+[![PyPI Version](https://img.shields.io/pypi/v/lacus.utils)](https://pypi.org/project/lacus.utils)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/lacus.utils)](https://pypi.org/project/lacus.utils)
+[![Python Version](https://img.shields.io/pypi/pyversions/lacus.utils)](https://www.python.org/)
+[![Test Status](https://img.shields.io/github/actions/workflow/status/LacusSolutions/br-utils-py/ci.yml?label=ci/cd)](https://github.com/LacusSolutions/br-utils-py/actions)
+[![Last Update Date](https://img.shields.io/github/last-commit/LacusSolutions/br-utils-py)](https://github.com/LacusSolutions/br-utils-py)
+[![Project License](https://img.shields.io/github/license/LacusSolutions/br-utils-py)](https://github.com/LacusSolutions/br-utils-py/blob/main/LICENSE)
+
+Reusable utilities library for Lacus Solutions' Python packages.
+
+## Python Support
+
+| ![Python 3.10](https://img.shields.io/badge/Python-3.10-3776AB?logo=python&logoColor=white) | ![Python 3.11](https://img.shields.io/badge/Python-3.11-3776AB?logo=python&logoColor=white) | ![Python 3.12](https://img.shields.io/badge/Python-3.12-3776AB?logo=python&logoColor=white) | ![Python 3.13](https://img.shields.io/badge/Python-3.13-3776AB?logo=python&logoColor=white) | ![Python 3.14](https://img.shields.io/badge/Python-3.14-3776AB?logo=python&logoColor=white) |
+|--- | --- | --- | --- | --- |
+| Passing ✔ | Passing ✔ | Passing ✔ | Passing ✔ | Passing ✔ |
+
+## Features
+
+- **Type description**: Python-native type labels for error messages (`NoneType`, `dict`, `tuple`, built-ins, lists)
+- **Random sequences**: Generate numeric, alphabetic, or alphanumeric sequences of any length
+- **Zero dependencies**: No external runtime packages required
+
+## Installation
+
+```bash
+$ pip install lacus.utils
+```
+
+## Import
+
+```python
+from lacus.utils import describe_type, generate_random_sequence, SequenceType
+```
+
+## Quick Start
+
+```python
+describe_type(None)           # 'NoneType'
+describe_type("hello")        # 'string'
+describe_type(42)             # 'integer number'
+describe_type(3.14)           # 'float number'
+describe_type(float("nan"))   # 'NaN'
+describe_type({})             # 'dict'
+describe_type([1, 2, 3])      # 'number[]'
+describe_type([1, "a", 2])    # '(number | string)[]'
+describe_type((1, 2))         # 'number tuple'
+
+generate_random_sequence(10, "numeric")       # e.g. '9956000611'
+generate_random_sequence(6, "alphabetic")   # e.g. 'AXQMZB'
+generate_random_sequence(8, "alphanumeric") # e.g. '8ZFB2K09'
+```
+
+## API
+
+All functions are implemented in [`src/lacus/utils/`](src/lacus/utils/) and covered by tests in [`tests/`](tests/).
+
+### `describe_type(value) -> str`
+
+Describes the type of a value for error messages.
+
+| Input | Result |
+|--------|--------|
+| `None` | `'NoneType'` |
+| `str` | `'string'` |
+| `bool` | `'boolean'` |
+| `int` | `'integer number'` |
+| `float` (finite) | `'float number'` |
+| `float('nan')` | `'NaN'` |
+| `float('inf')` / `float('-inf')` | `'Infinity'` |
+| `complex` | `'complex number'` |
+| `dict` | `'dict'` |
+| `set` / `frozenset` | `'set'` / `'frozenset'` |
+| `bytes` / `bytearray` | `'bytes'` / `'bytearray'` |
+| callable | `'function'` |
+| class (`int`, `str`, …) | `'type'` |
+| custom class instance | `'object'` |
+| `[]` | `'Array (empty)'` |
+| `[1, 2, 3]` | `'number[]'` |
+| `[1, 'a', 2]` | `'(number | string)[]'` |
+| `()` | `'tuple (empty)'` |
+| `(1, 2)` | `'number tuple'` |
+
+### `generate_random_sequence(size: int, sequence_type: SequenceType) -> str`
+
+Generates a random character sequence of the given length and type.
+
+- **`size`**: Length of the sequence (e.g. `10`).
+- **`sequence_type`**: One of:
+  - **`'numeric'`**: digits `0-9`
+  - **`'alphabetic'`**: uppercase letters `A-Z`
+  - **`'alphanumeric'`**: digits and uppercase letters `0-9A-Z`
+
+### Exports summary
+
+| Export | Description |
+|--------|-------------|
+| `describe_type` | Type description for error messages |
+| `generate_random_sequence` | Random sequence generation |
+| `SequenceType` | Literal type: `'alphabetic' \| 'alphanumeric' \| 'numeric'` |
+
+## Contribution & Support
+
+We welcome contributions! Please see our [Contributing Guidelines](https://github.com/LacusSolutions/br-utils-py/blob/main/CONTRIBUTING.md) for details. If you find this project helpful, please consider:
+
+- Starring the repository
+- Contributing to the codebase
+- [Suggesting new features](https://github.com/LacusSolutions/br-utils-py/issues)
+- [Reporting bugs](https://github.com/LacusSolutions/br-utils-py/issues)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/LacusSolutions/br-utils-py/blob/main/LICENSE) file for details.
+
+## Changelog
+
+See [CHANGELOG](./CHANGELOG.md) for a list of changes and version history.
+
+---
+
+Made with ❤️ by [Lacus Solutions](https://github.com/LacusSolutions)

lacus_utils-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+lacus/utils/__init__.py,sha256=sj-DwiPX_PiXur1AY5Ml9_9ShJmq4FuzhM8ZRdvddc8,247
+lacus/utils/describe_type.py,sha256=4DSLuwQr583vY9JDTK3kBffCtipWgf1Fys9KlqAxjho,3414
+lacus/utils/generate_random_sequence.py,sha256=pXp-BSIyyuCgFGwEf8tR3agqVyiUZ3QRQhEtCkyOdFg,1270
+lacus/utils/types.py,sha256=VGlc6TeuPCPG-NNN0yZGGWaW-MHHWCg5eFHr6S0gLso,306
+lacus_utils-1.0.0.dist-info/licenses/LICENSE,sha256=Ul6ngVvCBnV8xCk721l1FrGjZWMR6NKP8BTKOiCKNio,1072
+lacus_utils-1.0.0.dist-info/METADATA,sha256=yZjC0R7d-_El2EoavdGOuD6BpbpvzZYXE6PjBDRi_gQ,6109
+lacus_utils-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+lacus_utils-1.0.0.dist-info/top_level.txt,sha256=jyR9rnFUDV4mjHwJG6gkGAUI5LBKynvDIGXBoenli7o,6
+lacus_utils-1.0.0.dist-info/RECORD,,

lacus_utils-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lacus_utils-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Julio L. Muller
+
+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.

lacus_utils-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+lacus