MultiProxPy 0.0.1__tar.gz → 0.1.0__tar.gz

multiproxpy-0.1.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: MultiProxPy
+Version: 0.1.0
+Summary: An easy way to combine multiple objects into one
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Eric aka CheesecakeTV
+Author-email: eric@swiftgui.de
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Project-URL: Documentation, https://github.com/CheesecakeTV/MultiProxPy
+Project-URL: Repository, https://github.com/CheesecakeTV/MultiProxPy
+Description-Content-Type: text/markdown
+
+# MultiProxPy
+A small python-package that allows you to "group" calls to objects.
+
+The cool part is that the resulting "MultiProxy"-object can be used like the referenced objects:
+```py
+from MultiProxPy import group_objects
+
+list1 = [3,1,2]
+list2 = [5,2]
+list3 = [7,8,9]
+
+list_proxy = group_objects(list1, list2, list3)
+
+list_proxy.sort()   # Sorts all lists
+list_proxy.append(15)   # Appends 15 to all lists
+list_proxy[0] = -1  # Sets the first elemet to 0 for all lists
+
+print(list1, list2, list3)
+```
+The grouping is very abstract and should work with any type of object.
+
+The best part is that your IDE will treat the proxy-object like one of the contained objects.
+It will suggest methods/attributes bound to that class:\
+![img.png](assets/images/SuggestionsOnProxyObject.png)
+
+Other examples can be found in the github-repository: https://github.com/CheesecakeTV/MultiProxPy
+
+## Limitations
+There are a few downsides you should be aware of.
+
+1. Any return-value on proxy-calls will be lost
+2. Simmilarely, math operations like additions don't work for the proxy. However, inline-operations do, e.g.: `list_proxy += [5]`
+3. The proxy can't fool `isinstance`, e.g.: `isinstance(list_proxy, list)` will return `False`
+4. Objects inside the proxy should have the same type, or a derived one. This is only a suggestion. If you are careful enough, you can mix different types
+
+

multiproxpy-0.1.0/README.md

@@ -0,0 +1,35 @@
+# MultiProxPy
+A small python-package that allows you to "group" calls to objects.
+
+The cool part is that the resulting "MultiProxy"-object can be used like the referenced objects:
+```py
+from MultiProxPy import group_objects
+
+list1 = [3,1,2]
+list2 = [5,2]
+list3 = [7,8,9]
+
+list_proxy = group_objects(list1, list2, list3)
+
+list_proxy.sort()   # Sorts all lists
+list_proxy.append(15)   # Appends 15 to all lists
+list_proxy[0] = -1  # Sets the first elemet to 0 for all lists
+
+print(list1, list2, list3)
+```
+The grouping is very abstract and should work with any type of object.
+
+The best part is that your IDE will treat the proxy-object like one of the contained objects.
+It will suggest methods/attributes bound to that class:\
+![img.png](assets/images/SuggestionsOnProxyObject.png)
+
+Other examples can be found in the github-repository: https://github.com/CheesecakeTV/MultiProxPy
+
+## Limitations
+There are a few downsides you should be aware of.
+
+1. Any return-value on proxy-calls will be lost
+2. Simmilarely, math operations like additions don't work for the proxy. However, inline-operations do, e.g.: `list_proxy += [5]`
+3. The proxy can't fool `isinstance`, e.g.: `isinstance(list_proxy, list)` will return `False`
+4. Objects inside the proxy should have the same type, or a derived one. This is only a suggestion. If you are careful enough, you can mix different types
+

{multiproxpy-0.0.1 → multiproxpy-0.1.0}/pyproject.toml

@@ -1,26 +1,27 @@
-[project]
-name = "MultiProxPy"
-version = "0.0.1"
-packages = [
-    { include = "MultiProxPy", from = "src" }
-]
-authors = [
-  { name="Eric aka CheesecakeTV", email="eric@swiftgui.de" },
-]
-description = "An easy way to combine multiple objects into one"
-readme = "README.md"
-requires-python = ">=3.10"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "Operating System :: OS Independent",
-]
-license = "Apache-2.0"
-license-files = ["LICEN[CS]E*"]
-dependencies = []
-[project.urls]
-Repository = "https://github.com/CheesecakeTV/MultiProxy"
-Documentation = "https://github.com/CheesecakeTV/MultiProxy"
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
+[project]
+name = "MultiProxPy"
+version = "0.1.0"
+packages = [
+    { include = "MultiProxPy", from = "src" }
+]
+authors = [
+  { name="Eric aka CheesecakeTV", email="eric@swiftgui.de" },
+]
+description = "An easy way to combine multiple objects into one"
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "Apache-2.0"
+license-files = ["LICEN[CS]E*"]
+dependencies = []
+[project.urls]
+Repository = "https://github.com/CheesecakeTV/MultiProxPy"
+Documentation = "https://github.com/CheesecakeTV/MultiProxPy"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+

{multiproxpy-0.0.1 → multiproxpy-0.1.0}/src/MultiProxPy/MultiProxyClass.py

@@ -12,7 +12,7 @@ class MultiProxy:
         Do not call directly!
         Use group_objects instead!
         """
-        assert objects, "At least one object is required to create a grouped caller!"
+        assert objects, "At least one object is required to create a MultiProxy!"
 
         super().__setattr__("_objects", objects)
 
@@ -34,11 +34,11 @@ class MultiProxy:
 
     def __str__(self) -> str:
         objects = super().__getattribute__("_objects")
-        return f"<GroupedCaller {tuple(map(str, objects))}>"
+        return f"<MultiProxy {tuple(map(str, objects))}>"
 
     def __repr__(self):
         objects = super().__getattribute__("_objects")
-        return f"<GroupedCaller {id(self)} {tuple(map(repr, objects))}>"
+        return f"<MultiProxy {id(self)} {tuple(map(repr, objects))}>"
 
     def __await__(self):
         objects = super().__getattribute__("_objects")
@@ -102,6 +102,15 @@ def group_objects(
         primary: inner_type, *others: inner_type,
         check_type_mismatch: bool = True,
 ) -> inner_type:
+    """
+    Create a MultiProxy-object and fool the IDE about its type.
+    This is the proper way to create such an object.
+
+    :param primary: The "type" of the returned object
+    :param others: All the other elements inside that proxy
+    :param check_type_mismatch: False to go the dangerous route of mixing together types
+    :return:
+    """
 
     if check_type_mismatch:
         main_type = type(primary)
@@ -119,3 +128,5 @@ def group_objects(
 
     return my_caller
 
+
+

multiproxpy-0.0.1/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.4
-Name: MultiProxPy
-Version: 0.0.1
-Summary: An easy way to combine multiple objects into one
-License-Expression: Apache-2.0
-License-File: LICENSE
-Author: Eric aka CheesecakeTV
-Author-email: eric@swiftgui.de
-Requires-Python: >=3.10
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Project-URL: Documentation, https://github.com/CheesecakeTV/MultiProxy
-Project-URL: Repository, https://github.com/CheesecakeTV/MultiProxy
-Description-Content-Type: text/markdown
-
-# MultiProxy
-
-
-

multiproxpy-0.0.1/README.md

@@ -1,3 +0,0 @@
-# MultiProxy
-
-