listclasses 1.0.0__tar.gz → 1.0.2__tar.gz

{listclasses-1.0.0 → listclasses-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: listclasses
-Version: 1.0.0
+Version: 1.0.2
 Summary: A simple decorator to make custom sequence types
 Description-Content-Type: text/markdown
 Dynamic: description
@@ -13,13 +13,17 @@ type-safe, and highly customizable custom sequence types
 
 # Features:
 
-· Type Safety: Enforce strict data types for sequence items
-· Length Constraints: Define fixed-size or dynamic sequences
-· Immutability: Easily create read-only (frozen) collections
-· Rich API: Seamlessly integrates with built-in functions (len(), repr(), iteration, slicing)
-· Copy Support: Native support for shallow and deep copying
-· Pretty Printing: Built-in methods for clean text formatting out of the box
-· Installation: Add the listclass decorator code directly to your project
+- Type Safety: Enforce strict data types for sequence items
+- Length Constraints: Define fixed-size or dynamic sequences
+- Immutability: Easily create read-only (frozen) collections
+- Rich API: Seamlessly integrates with built-in functions (len(), repr(), iteration, slicing)
+- Copy Support: Native support for shallow and deep copying
+- Pretty Printing: Built-in methods for clean text formatting out of the box
+- Installation: Add the listclass decorator code directly to your project
+
+```commandline
+pip install listclasses
+```
 
 ```python
 from listclasses import listclass
@@ -46,7 +50,7 @@ print(len(items))     # Output: 3
 
 The @listclass decorator accepts configuration parameters to restrict container behavior
 
-## Enforcing Strict Types
+### Enforcing Strict Types
 
 ```python
 @listclass(type=int)
@@ -60,21 +64,22 @@ numbers = IntegerList(1, 2, 3)
 numbers = IntegerList(1, "two", 3)
 ```
 
-## Enforcing more than one type
+### Multi-Type Union Support
 
 ```python
-@listclass(type=int | None)
-class List:
+@listclass(type=int | str)
+class MixedList:
     pass
 
-# Works perfectly
-numbers_and_None = List(1, 2, 3, None)
+# Both integers and strings are valid
+mixed = MixedList(1, "hello", 42, "world")
 
-# Raises TypeError: Incorrect type: expected: int | None got: str
-numbers_and_None = List(1, "two", 3)
+# Appending a float raises an error
+# Raises TypeError: Incorrect type: expected: int | str got: float
+mixed.append(3.14)
 ```
 
-## Setting Fixed Lengths
+### Setting Fixed Lengths
 
 ```python
 @listclass(len=2)
@@ -88,7 +93,7 @@ point = Coordinates(10, 20)
 point = Coordinates(10, 20, 30)
 ```
 
-## Creating Frozen (Immutable) Lists
+### Creating Frozen (Immutable) Lists
 
 ```python
 @listclass(frozen=True)
@@ -101,7 +106,7 @@ data = ReadOnlyData("A", "B")
 data[0] = "Z"
 ```
 
-## Built-in Formatting
+### Built-in Formatting
 listclasses comes with utility methods to print your items cleanly.
 
 ```python
@@ -114,9 +119,9 @@ todos = TodoList("Buy milk", "Clean room", "Code Python")
 # Dotted list format
 todos.print_dotted()
 # Output:
-# ·  Buy milk
-# ·  Clean room
-# ·  Code Python
+# -  Buy milk
+# -  Clean room
+# -  Code Python
 
 # Numbered list format
 todos.print_numbered()
@@ -139,7 +144,7 @@ todos.print_numbered()
 
 Depending on configuration (frozen and len), instances support standard list operations:
 
-· Access: __getitem__, __iter__, __contains__, count(), index()
-· Mutation (Dynamic only): append(), pop(), clear(), insert(), __delitem__
-· Ordering (Mutable only): sort(), reverse()
-· Math: __add__ (+), __iadd__ (+=)
+- Access: `__getitem__`, `__iter__`, `__contains__`, `count()`, `index()`
+- Mutation (Dynamic only): `append()`, `pop()`, `clear()`, `insert()`, `__delitem__`
+- Ordering (Mutable only): `sort()`, `reverse()`
+- Math: `__add__`, `__iadd__`

{listclasses-1.0.0 → listclasses-1.0.2}/README.md

@@ -4,13 +4,17 @@ type-safe, and highly customizable custom sequence types
 
 # Features:
 
-· Type Safety: Enforce strict data types for sequence items
-· Length Constraints: Define fixed-size or dynamic sequences
-· Immutability: Easily create read-only (frozen) collections
-· Rich API: Seamlessly integrates with built-in functions (len(), repr(), iteration, slicing)
-· Copy Support: Native support for shallow and deep copying
-· Pretty Printing: Built-in methods for clean text formatting out of the box
-· Installation: Add the listclass decorator code directly to your project
+- Type Safety: Enforce strict data types for sequence items
+- Length Constraints: Define fixed-size or dynamic sequences
+- Immutability: Easily create read-only (frozen) collections
+- Rich API: Seamlessly integrates with built-in functions (len(), repr(), iteration, slicing)
+- Copy Support: Native support for shallow and deep copying
+- Pretty Printing: Built-in methods for clean text formatting out of the box
+- Installation: Add the listclass decorator code directly to your project
+
+```commandline
+pip install listclasses
+```
 
 ```python
 from listclasses import listclass
@@ -37,7 +41,7 @@ print(len(items))     # Output: 3
 
 The @listclass decorator accepts configuration parameters to restrict container behavior
 
-## Enforcing Strict Types
+### Enforcing Strict Types
 
 ```python
 @listclass(type=int)
@@ -51,21 +55,22 @@ numbers = IntegerList(1, 2, 3)
 numbers = IntegerList(1, "two", 3)
 ```
 
-## Enforcing more than one type
+### Multi-Type Union Support
 
 ```python
-@listclass(type=int | None)
-class List:
+@listclass(type=int | str)
+class MixedList:
     pass
 
-# Works perfectly
-numbers_and_None = List(1, 2, 3, None)
+# Both integers and strings are valid
+mixed = MixedList(1, "hello", 42, "world")
 
-# Raises TypeError: Incorrect type: expected: int | None got: str
-numbers_and_None = List(1, "two", 3)
+# Appending a float raises an error
+# Raises TypeError: Incorrect type: expected: int | str got: float
+mixed.append(3.14)
 ```
 
-## Setting Fixed Lengths
+### Setting Fixed Lengths
 
 ```python
 @listclass(len=2)
@@ -79,7 +84,7 @@ point = Coordinates(10, 20)
 point = Coordinates(10, 20, 30)
 ```
 
-## Creating Frozen (Immutable) Lists
+### Creating Frozen (Immutable) Lists
 
 ```python
 @listclass(frozen=True)
@@ -92,7 +97,7 @@ data = ReadOnlyData("A", "B")
 data[0] = "Z"
 ```
 
-## Built-in Formatting
+### Built-in Formatting
 listclasses comes with utility methods to print your items cleanly.
 
 ```python
@@ -105,9 +110,9 @@ todos = TodoList("Buy milk", "Clean room", "Code Python")
 # Dotted list format
 todos.print_dotted()
 # Output:
-# ·  Buy milk
-# ·  Clean room
-# ·  Code Python
+# -  Buy milk
+# -  Clean room
+# -  Code Python
 
 # Numbered list format
 todos.print_numbered()
@@ -130,7 +135,7 @@ todos.print_numbered()
 
 Depending on configuration (frozen and len), instances support standard list operations:
 
-· Access: __getitem__, __iter__, __contains__, count(), index()
-· Mutation (Dynamic only): append(), pop(), clear(), insert(), __delitem__
-· Ordering (Mutable only): sort(), reverse()
-· Math: __add__ (+), __iadd__ (+=)
+- Access: `__getitem__`, `__iter__`, `__contains__`, `count()`, `index()`
+- Mutation (Dynamic only): `append()`, `pop()`, `clear()`, `insert()`, `__delitem__`
+- Ordering (Mutable only): `sort()`, `reverse()`
+- Math: `__add__`, `__iadd__`

{listclasses-1.0.0 → listclasses-1.0.2}/listclasses/main.py

@@ -23,26 +23,30 @@ def listclass(cls = None, *, len: int = 0, frozen: bool = False, type: type = an
 
 
     def wraps(cls):
+        # --- Type Validation Helper ---
+        def validate_items(items):
+            if type == any:
+                return
+
+            is_union = isinstance(type, types.UnionType) or get_origin(type) is Union
+            allowed = get_args(type) if is_union else type
+
+            for item in items:
+                if not isinstance(item, allowed):
+                    if is_union:
+                        type_names = " | ".join(t.__name__ for t in allowed)
+                    else:
+                        type_names = type.__name__ if hasattr(type, '__name__') else str(type)
+
+                    got_name = _type(item).__name__
+                    raise TypeError(f'Incorrect type: expected: {type_names} got: {got_name}')
+
         original_init = getattr(cls, '__init__', None)
+
         def new_init(self, *args, **kwargs):
             if args.__len__() == len or len == 0:
-                if args.__len__() == len or len == 0:
-                    for i in range(args.__len__()):
-                        # Check if the allowed type is a modern Union (int | str) or legacy typing.Union
-                        is_union = isinstance(type, types.UnionType) or get_origin(type) is Union
-
-                        if is_union:
-                            allowed_types = get_args(type)
-                            if not isinstance(args[i], allowed_types):
-                                type_names = " | ".join(t.__name__ for t in allowed_types)
-                                got_name = _type(args[i]).__name__
-                                raise TypeError(f'Incorrect type: expected: {type_names} got: {got_name}')
-                        else:
-                            if (not isinstance(args[i], type)) and (type != any):
-                                expected_name = type.__name__ if hasattr(type, '__name__') else str(type)
-                                got_name = _type(args[i]).__name__
-                                raise TypeError(f'Incorrect type: expected: {expected_name} got: {got_name}')
-                    self._items = [*args]
+                validate_items(args)
+                self._items = [*args]
             elif args.__len__() > len:
                 raise ValueError(f'Too many items: expected: {len} got: {args.__len__()}')
             elif args.__len__() < len:
@@ -56,20 +60,7 @@ def listclass(cls = None, *, len: int = 0, frozen: bool = False, type: type = an
         def new_setitem(self, key, value):
             if frozen:
                 raise TypeError(f"'{cls.__name__}' object does not support item assignment")
-            # Check if the allowed type is a modern Union (int | str) or legacy typing.Union
-            is_union = isinstance(type, types.UnionType) or get_origin(type) is Union
-
-            if is_union:
-                allowed_types = get_args(type)
-                if not isinstance(args[i], allowed_types):
-                    type_names = " | ".join(t.__name__ for t in allowed_types)
-                    got_name = _type(args[i]).__name__
-                    raise TypeError(f'Incorrect type: expected: {type_names} got: {got_name}')
-            else:
-                if (not isinstance(args[i], type)) and (type != any):
-                    expected_name = type.__name__ if hasattr(type, '__name__') else str(type)
-                    got_name = _type(args[i]).__name__
-                    raise TypeError(f'Incorrect type: expected: {expected_name} got: {got_name}')
+            validate_items([value])
             self._items[key] = value
 
         def new_copy(self):
@@ -85,7 +76,7 @@ def listclass(cls = None, *, len: int = 0, frozen: bool = False, type: type = an
                 new_instance.__dict__[k] = deepcopy(v, memo)
             return new_instance
 
-        def print_dotted(self) -> None:
+        def print_dotted(self, dot: str='·') -> None:
             """
             Prints a list in a format:
                 · list[0]\n
@@ -93,7 +84,7 @@ def listclass(cls = None, *, len: int = 0, frozen: bool = False, type: type = an
                 · list[2]
             """
             for item in self._items:
-                print('·', item)
+                print(dot, item)
 
         def print_numbered(self) -> None:
             """
@@ -131,24 +122,14 @@ def listclass(cls = None, *, len: int = 0, frozen: bool = False, type: type = an
 
         def new_iadd(self, other):
             if isinstance(other, cls):
-                self._items.extend(other._items)
+                items_to_add = other._items
             elif hasattr(other, '__iter__'):
-                self._items.extend(other)
+                items_to_add = list(other)
             else:
                 return NotImplemented
-            # Check if the allowed type is a modern Union (int | str) or legacy typing.Union
-            is_union = isinstance(type, types.UnionType) or get_origin(type) is Union
-            if is_union:
-                allowed_types = get_args(type)
-                if not isinstance(args[i], allowed_types):
-                    type_names = " | ".join(t.__name__ for t in allowed_types)
-                    got_name = _type(args[i]).__name__
-                    raise TypeError(f'Incorrect type: expected: {type_names} got: {got_name}')
-            else:
-                if (not isinstance(args[i], type)) and (type != any):
-                    expected_name = type.__name__ if hasattr(type, '__name__') else str(type)
-                    got_name = _type(args[i]).__name__
-                    raise TypeError(f'Incorrect type: expected: {expected_name} got: {got_name}')
+            # Type check elements being added via '+='
+            validate_items(items_to_add)
+            self._items.extend(items_to_add)
             return self
 
         def new_class_getitem(cls, params):
@@ -198,4 +179,14 @@ def listclass(cls = None, *, len: int = 0, frozen: bool = False, type: type = an
         # We're called with parens.
         return wraps
     # We're called as @listclass without parens.
-    return wraps(cls)
+    return wraps(cls)
+
+# tests
+if __name__ == '__main__':
+    @listclass
+    class List:
+        ...
+    l = List(0, 10)
+    l[0] = 10
+    l += List(100, 20)
+    print(l)

{listclasses-1.0.0 → listclasses-1.0.2}/listclasses.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: listclasses
-Version: 1.0.0
+Version: 1.0.2
 Summary: A simple decorator to make custom sequence types
 Description-Content-Type: text/markdown
 Dynamic: description
@@ -13,13 +13,17 @@ type-safe, and highly customizable custom sequence types
 
 # Features:
 
-· Type Safety: Enforce strict data types for sequence items
-· Length Constraints: Define fixed-size or dynamic sequences
-· Immutability: Easily create read-only (frozen) collections
-· Rich API: Seamlessly integrates with built-in functions (len(), repr(), iteration, slicing)
-· Copy Support: Native support for shallow and deep copying
-· Pretty Printing: Built-in methods for clean text formatting out of the box
-· Installation: Add the listclass decorator code directly to your project
+- Type Safety: Enforce strict data types for sequence items
+- Length Constraints: Define fixed-size or dynamic sequences
+- Immutability: Easily create read-only (frozen) collections
+- Rich API: Seamlessly integrates with built-in functions (len(), repr(), iteration, slicing)
+- Copy Support: Native support for shallow and deep copying
+- Pretty Printing: Built-in methods for clean text formatting out of the box
+- Installation: Add the listclass decorator code directly to your project
+
+```commandline
+pip install listclasses
+```
 
 ```python
 from listclasses import listclass
@@ -46,7 +50,7 @@ print(len(items))     # Output: 3
 
 The @listclass decorator accepts configuration parameters to restrict container behavior
 
-## Enforcing Strict Types
+### Enforcing Strict Types
 
 ```python
 @listclass(type=int)
@@ -60,21 +64,22 @@ numbers = IntegerList(1, 2, 3)
 numbers = IntegerList(1, "two", 3)
 ```
 
-## Enforcing more than one type
+### Multi-Type Union Support
 
 ```python
-@listclass(type=int | None)
-class List:
+@listclass(type=int | str)
+class MixedList:
     pass
 
-# Works perfectly
-numbers_and_None = List(1, 2, 3, None)
+# Both integers and strings are valid
+mixed = MixedList(1, "hello", 42, "world")
 
-# Raises TypeError: Incorrect type: expected: int | None got: str
-numbers_and_None = List(1, "two", 3)
+# Appending a float raises an error
+# Raises TypeError: Incorrect type: expected: int | str got: float
+mixed.append(3.14)
 ```
 
-## Setting Fixed Lengths
+### Setting Fixed Lengths
 
 ```python
 @listclass(len=2)
@@ -88,7 +93,7 @@ point = Coordinates(10, 20)
 point = Coordinates(10, 20, 30)
 ```
 
-## Creating Frozen (Immutable) Lists
+### Creating Frozen (Immutable) Lists
 
 ```python
 @listclass(frozen=True)
@@ -101,7 +106,7 @@ data = ReadOnlyData("A", "B")
 data[0] = "Z"
 ```
 
-## Built-in Formatting
+### Built-in Formatting
 listclasses comes with utility methods to print your items cleanly.
 
 ```python
@@ -114,9 +119,9 @@ todos = TodoList("Buy milk", "Clean room", "Code Python")
 # Dotted list format
 todos.print_dotted()
 # Output:
-# ·  Buy milk
-# ·  Clean room
-# ·  Code Python
+# -  Buy milk
+# -  Clean room
+# -  Code Python
 
 # Numbered list format
 todos.print_numbered()
@@ -139,7 +144,7 @@ todos.print_numbered()
 
 Depending on configuration (frozen and len), instances support standard list operations:
 
-· Access: __getitem__, __iter__, __contains__, count(), index()
-· Mutation (Dynamic only): append(), pop(), clear(), insert(), __delitem__
-· Ordering (Mutable only): sort(), reverse()
-· Math: __add__ (+), __iadd__ (+=)
+- Access: `__getitem__`, `__iter__`, `__contains__`, `count()`, `index()`
+- Mutation (Dynamic only): `append()`, `pop()`, `clear()`, `insert()`, `__delitem__`
+- Ordering (Mutable only): `sort()`, `reverse()`
+- Math: `__add__`, `__iadd__`

{listclasses-1.0.0 → listclasses-1.0.2}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', 'r') as file:
 
 setup(
     name='listclasses',
-    version='1.0.0',
+    version='1.0.2',
     packages=find_packages(),
     install_requires=[
 
@@ -13,4 +13,5 @@ setup(
     description='A simple decorator to make custom sequence types',
     long_description=description,
     long_description_content_type='text/markdown'
-)
+)
+