cleanup and prep

README.md

@@ -94,6 +94,53 @@ The core of the PyConstClasses package are the `const_class` and `static_const_c
     Error: Cannot modify const attribute `last_name` of class `Person`
     ```
 
+    This `const_class` decorators also provides the `new` method which allows for the creationg of new instances of the class based on an existing instance with the option to modify individual fields:
+
+    ```python
+    # const_class_new.py
+
+    @cc.const_class(with_kwargs=True)
+    class PersonKwargs:
+        first_name: str
+        last_name: str
+        age: int
+
+        def __repr__(self) -> str:
+            return f"(kwargs) {self.first_name} {self.last_name} [age: {self.age}]"
+
+
+    @cc.const_class(with_kwargs=False)
+    class PersonArgs:
+        first_name: str
+        last_name: str
+        age: int
+
+        def __repr__(self) -> str:
+            return f"(args) {self.first_name} {self.last_name} [age: {self.age}]"
+
+
+    if __name__ == "__main__":
+        john = PersonKwargs(first_name="John", last_name="Doe", age=21)
+        print(f"{john = }")
+
+        john_aged = john.new(age=22)
+        print(f"{john_aged = }")
+
+        john = PersonArgs("John", "Doe", 21)
+        print(f"{john = }")
+
+        john_aged = john.new(age=22)
+        print(f"{john_aged = }")
+    ```
+
+    This program will produce the following output:
+    ```
+    john = (kwargs) John Doe [age: 21]
+    john_aged = (kwargs) John Doe [age: 22]
+    john = (args) John Doe [age: 21]
+    john_aged = (args) John Doe [age: 22]
+    ```
+
 * The `static_const_class` deacorator allows you to define a pseudo-static resource with const members (it creates an instance of the decorated class):
 
     ```python

examples/const_class_new.py

@@ -0,0 +1,35 @@
+import constclasses as cc
+
+
+@cc.const_class(with_kwargs=True)
+class PersonKwargs:
+    first_name: str
+    last_name: str
+    age: int
+
+    def __repr__(self) -> str:
+        return f"(kwargs) {self.first_name} {self.last_name} [age: {self.age}]"
+
+
+@cc.const_class(with_kwargs=False)
+class PersonArgs:
+    first_name: str
+    last_name: str
+    age: int
+
+    def __repr__(self) -> str:
+        return f"(args) {self.first_name} {self.last_name} [age: {self.age}]"
+
+
+if __name__ == "__main__":
+    john = PersonKwargs(first_name="John", last_name="Doe", age=21)
+    print(f"{john = }")
+
+    john_aged = john.new(age=22)
+    print(f"{john_aged = }")
+
+    john = PersonArgs("John", "Doe", 21)
+    print(f"{john = }")
+
+    john_aged = john.new(age=22)
+    print(f"{john_aged = }")

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyconstclasses"
-version = "1.0.0"
+version = "1.0.4"
 description = "Package with const class decoratos and utility"
 authors = [
   {name = "SpectraL519"}

src/constclasses/const_class.py

@@ -1,12 +1,12 @@
+from copy import deepcopy
+
 from .ccerror import ConstError, InitializationError
 from .const_class_base import (
     CC_BASE_ATTR_NAME,
     CC_INITIALIZED_ATTR_NAME,
     ConstClassBase,
 )
 
-from copy import deepcopy
-
 
 def const_class_impl(
     cls,

test/test_const_class.py

@@ -207,7 +207,11 @@ class ConstClassWithKwargs:
         s: str
 
         def __eq__(self, other: object) -> bool:
-            return isinstance(other, self.__class__) and other.x == self.x and other.s == self.s
+            return (
+                isinstance(other, self.__class__)
+                and other.x == self.x
+                and other.s == self.s
+            )
 
     const_instance = ConstClassWithKwargs(**ATTR_VALS_1)
 
@@ -228,7 +232,11 @@ class ConstClassWithKwargs:
         s: str
 
         def __eq__(self, other: object) -> bool:
-            return isinstance(other, self.__class__) and other.x == self.x and other.s == self.s
+            return (
+                isinstance(other, self.__class__)
+                and other.x == self.x
+                and other.s == self.s
+            )
 
     const_instance = ConstClassWithKwargs(*(ATTR_VALS_1.values()))