microconst 0.1.0__tar.gz

microconst-0.1.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: microconst
+Version: 0.1.0
+Summary: Library for optimizing enum constant values
+Author-email: triple-raze <weebucks2@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/triple-raze/microconst
+Project-URL: Repository, https://github.com/triple-raze/microconst.git
+Project-URL: Issues, https://github.com/triple-raze/microconst/issues
+Keywords: enum,compact
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# microconst
+[![pypi](https://img.shields.io/pypi/v/microconst)](https://pypi.org/project/microconst/)
+![python](https://img.shields.io/badge/python-3.12+-blue?logo=python)
+![typed](https://img.shields.io/badge/typed-yes-blue)
+![tests](https://img.shields.io/badge/tests-manual-green) 
+![license](https://img.shields.io/badge/license-MIT-blue)
+
+Replace long constant names with 2 ASCII keys
+
+## Installation
+pip: 
+```
+pip install microconst
+```
+poetry:
+```
+poetry add microconst
+```
+
+## Features
+#### Constants
+Every call of `flag` or `key` generates 2-character key. This key is represented as left and right indexes of `f"{ascii_letters}{digits}"` str. Each time the left index reaches cap, it resets to 0 and right index increments.<br>
+After reaching both of caps, next call of function will throw `OverflowError`. Current maximum count of keys is 3844.
+
+#### Typing
+`key` function requires `value_type` argument, such as `str`, `int` etc. This type used in both static analysis and type convertion with `Key.parse_entry(data)` function. 
+
+## Examples
+Main purpose of this library is making telegram bot's "callback_data" much more compact because of 64-byte limit. You can see more realistic example [here](example)<br><br>
+#### Flag usage:
+```python
+from microconst import flag
+
+# Autogenerates unique pairs of characters
+class Status:
+    PENDING = flag()
+    APPROVED = flag()
+    REJECTED = flag()
+
+assert Status.PENDING == "aa"
+assert Status.APPROVED == "ba"
+assert Status.REJECTED == "ca"
+```
+
+#### Key usage:
+```python
+from microconst import key, parse_entry
+
+USER = key(str)
+
+# You can call keys to create key-value pair (acts same as concat)
+username = USER("name") 
+# Getting value
+value = USER.parse_entry(username) 
+
+assert username == "aaname"
+assert value == "name"
+
+# You can use seperate function or method. Method doesnt require type argument
+assert parse_entry(username, str) == value
+```
+
+## License
+MIT

microconst-0.1.0/README.md

@@ -0,0 +1,64 @@
+# microconst
+[![pypi](https://img.shields.io/pypi/v/microconst)](https://pypi.org/project/microconst/)
+![python](https://img.shields.io/badge/python-3.12+-blue?logo=python)
+![typed](https://img.shields.io/badge/typed-yes-blue)
+![tests](https://img.shields.io/badge/tests-manual-green) 
+![license](https://img.shields.io/badge/license-MIT-blue)
+
+Replace long constant names with 2 ASCII keys
+
+## Installation
+pip: 
+```
+pip install microconst
+```
+poetry:
+```
+poetry add microconst
+```
+
+## Features
+#### Constants
+Every call of `flag` or `key` generates 2-character key. This key is represented as left and right indexes of `f"{ascii_letters}{digits}"` str. Each time the left index reaches cap, it resets to 0 and right index increments.<br>
+After reaching both of caps, next call of function will throw `OverflowError`. Current maximum count of keys is 3844.
+
+#### Typing
+`key` function requires `value_type` argument, such as `str`, `int` etc. This type used in both static analysis and type convertion with `Key.parse_entry(data)` function. 
+
+## Examples
+Main purpose of this library is making telegram bot's "callback_data" much more compact because of 64-byte limit. You can see more realistic example [here](example)<br><br>
+#### Flag usage:
+```python
+from microconst import flag
+
+# Autogenerates unique pairs of characters
+class Status:
+    PENDING = flag()
+    APPROVED = flag()
+    REJECTED = flag()
+
+assert Status.PENDING == "aa"
+assert Status.APPROVED == "ba"
+assert Status.REJECTED == "ca"
+```
+
+#### Key usage:
+```python
+from microconst import key, parse_entry
+
+USER = key(str)
+
+# You can call keys to create key-value pair (acts same as concat)
+username = USER("name") 
+# Getting value
+value = USER.parse_entry(username) 
+
+assert username == "aaname"
+assert value == "name"
+
+# You can use seperate function or method. Method doesnt require type argument
+assert parse_entry(username, str) == value
+```
+
+## License
+MIT

microconst-0.1.0/microconst/__init__.py

@@ -0,0 +1,6 @@
+from microconst.entry import parse_entry
+from microconst.members import Key
+from microconst.members import create_flag as flag
+from microconst.members import create_key as key
+
+__all__ = ["Key", "flag", "key", "parse_entry"]

microconst-0.1.0/microconst/entry.py

@@ -0,0 +1,6 @@
+from collections.abc import Callable
+
+
+def parse_entry[T](data: str, value_type: Callable[[str], T]) -> T:
+    str_value = data[2:]
+    return value_type(str_value)

microconst-0.1.0/microconst/key.py

@@ -0,0 +1,29 @@
+from collections.abc import Generator
+from string import ascii_letters, digits
+
+CHARACTERS = f"{ascii_letters}{digits}"
+
+MAX_IDX = len(CHARACTERS) - 1
+MAX_KEYS = len(CHARACTERS) ** 2
+
+
+def create_unique_key_generator() -> Generator[str, None, None]:
+    left_idx: int = 0
+    right_idx: int = 0
+
+    while right_idx != MAX_IDX + 1:
+        pair: str = CHARACTERS[left_idx] + CHARACTERS[right_idx]
+
+        if left_idx == MAX_IDX:
+            left_idx = 0
+            right_idx += 1
+        else:
+            left_idx += 1
+
+        yield pair
+
+    msg = f"cannot create more than {MAX_KEYS} keys"
+    raise OverflowError(msg)
+
+
+unique_key_generator = create_unique_key_generator()

microconst-0.1.0/microconst/members.py

@@ -0,0 +1,32 @@
+from collections.abc import Callable
+from typing import Self
+
+from microconst.entry import parse_entry
+from microconst.key import unique_key_generator
+
+
+class Key[T](str):
+    # Subclasses of str should define __slots__
+    __slots__ = ("type",)
+    # We'll assign to this in __new__
+    type: Callable[[str], T]
+
+    def __new__(cls, name: str, value_type: Callable[[str], T]) -> Self:
+        instance = super().__new__(cls, name)
+        instance.type = value_type
+        return instance
+
+    def __call__(self, value: T) -> str:
+        return f"{self}{value}"
+
+    def parse_entry(self, data: str) -> T:
+        return parse_entry(data, self.type)
+
+
+def create_flag() -> str:
+    return next(unique_key_generator)
+
+
+def create_key[T](value_type: type[T]) -> Key[T]:
+    name = next(unique_key_generator)
+    return Key(name, value_type)

microconst-0.1.0/microconst/py.typed

@@ -0,0 +1 @@
+This file serves as a type annotation marker.

microconst-0.1.0/microconst.egg-info/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: microconst
+Version: 0.1.0
+Summary: Library for optimizing enum constant values
+Author-email: triple-raze <weebucks2@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/triple-raze/microconst
+Project-URL: Repository, https://github.com/triple-raze/microconst.git
+Project-URL: Issues, https://github.com/triple-raze/microconst/issues
+Keywords: enum,compact
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# microconst
+[![pypi](https://img.shields.io/pypi/v/microconst)](https://pypi.org/project/microconst/)
+![python](https://img.shields.io/badge/python-3.12+-blue?logo=python)
+![typed](https://img.shields.io/badge/typed-yes-blue)
+![tests](https://img.shields.io/badge/tests-manual-green) 
+![license](https://img.shields.io/badge/license-MIT-blue)
+
+Replace long constant names with 2 ASCII keys
+
+## Installation
+pip: 
+```
+pip install microconst
+```
+poetry:
+```
+poetry add microconst
+```
+
+## Features
+#### Constants
+Every call of `flag` or `key` generates 2-character key. This key is represented as left and right indexes of `f"{ascii_letters}{digits}"` str. Each time the left index reaches cap, it resets to 0 and right index increments.<br>
+After reaching both of caps, next call of function will throw `OverflowError`. Current maximum count of keys is 3844.
+
+#### Typing
+`key` function requires `value_type` argument, such as `str`, `int` etc. This type used in both static analysis and type convertion with `Key.parse_entry(data)` function. 
+
+## Examples
+Main purpose of this library is making telegram bot's "callback_data" much more compact because of 64-byte limit. You can see more realistic example [here](example)<br><br>
+#### Flag usage:
+```python
+from microconst import flag
+
+# Autogenerates unique pairs of characters
+class Status:
+    PENDING = flag()
+    APPROVED = flag()
+    REJECTED = flag()
+
+assert Status.PENDING == "aa"
+assert Status.APPROVED == "ba"
+assert Status.REJECTED == "ca"
+```
+
+#### Key usage:
+```python
+from microconst import key, parse_entry
+
+USER = key(str)
+
+# You can call keys to create key-value pair (acts same as concat)
+username = USER("name") 
+# Getting value
+value = USER.parse_entry(username) 
+
+assert username == "aaname"
+assert value == "name"
+
+# You can use seperate function or method. Method doesnt require type argument
+assert parse_entry(username, str) == value
+```
+
+## License
+MIT

microconst-0.1.0/microconst.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+microconst/__init__.py
+microconst/entry.py
+microconst/key.py
+microconst/members.py
+microconst/py.typed
+microconst.egg-info/PKG-INFO
+microconst.egg-info/SOURCES.txt
+microconst.egg-info/dependency_links.txt
+microconst.egg-info/top_level.txt
+tests/test_all.py

microconst-0.1.0/microconst.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

microconst-0.1.0/microconst.egg-info/top_level.txt

@@ -0,0 +1 @@
+microconst

microconst-0.1.0/pyproject.toml

@@ -0,0 +1,75 @@
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D",     # Docstring warnings
+    "INP001" # Implicit namespace package 
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "S101",    # Assert used
+    "PLR2004", # Magic value
+]   
+
+
+[tool.mypy]
+exclude = ["example/"]
+strict = true
+
+disallow_untyped_defs = true 
+disallow_untyped_calls = true
+check_untyped_defs = true    
+
+warn_return_any = true              
+disallow_any_explicit = true       
+disallow_any_unimported = true      
+disallow_any_decorated = true       
+disallow_any_expr = true            
+disallow_any_generics = true
+
+no_implicit_optional = true       
+strict_equality = true            
+strict_concatenate = true         
+local_partial_types = true        
+
+no_implicit_reexport = true          
+
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "microconst"      
+version = "0.1.0"               
+description = "Library for optimizing enum constant values"             
+
+requires-python = ">=3.12"  
+
+readme = "README.md"
+license = {text = "MIT"}        
+authors = [{name = "triple-raze", email = "weebucks2@gmail.com"}]                    
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+    "Typing :: Typed"
+]
+keywords = ["enum", "compact"]
+
+
+[project.urls]
+"Homepage" = "https://github.com/triple-raze/microconst"
+"Repository" = "https://github.com/triple-raze/microconst.git"
+"Issues" = "https://github.com/triple-raze/microconst/issues"

microconst-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

microconst-0.1.0/tests/test_all.py

@@ -0,0 +1,21 @@
+from microconst import flag, key, parse_entry
+
+
+def test_member_creation() -> None:
+    assert key(int)(10) == "aa10"
+
+    assert key(str)("hello") == "bahello"
+
+    assert key(float)(14.1) == "ca14.1"
+
+    assert flag() == "da"
+    assert flag() == "ea"
+
+
+def test_value_extraction() -> None:
+    int_key = key(int)
+    data = int_key(123)
+
+    assert int_key.parse_entry(data) == 123
+
+    assert parse_entry("aa1.2", float) == 1.2