PyObjectInterface 0.1.1rc1__tar.gz → 0.1.1rc2__tar.gz

{PyObjectInterface-0.1.1rc1 → PyObjectInterface-0.1.1rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyObjectInterface
-Version: 0.1.1rc1
+Version: 0.1.1rc2
 Summary: Create a web interface to interact with a class
 Home-page: https://github.com/RobertJN64/PyObjectInterface
 Author: Robert Nies
@@ -77,3 +77,29 @@ You can use PyObjectInterface without the WebController.
  - `flask_app`: return value of flask.Flask()
  - `recursion_depth = 5`: maximum layers of subobjects to include
  - `create_private_interface = True`: if `True` creates a `/webcontroller/private` page that includes private methods and attributes
+
+### Modifying Attributes
+
+By default, POI treats `NoneType, bool, int, float, str, list, dict, tuple, and set` as primitive types.
+These show up in the attribute table instead of as recursive objects.
+
+`numpy.ndarray`, `pandas.DataFrame`, and `pandas.Series` are also treated as primitives.
+
+If you would like to customize this behavior, you can modify
+`PyObjectInterface.basic_attribute_types`
+
+For example:
+```python
+from PyObjectInterface import basic_attribute_types
+
+class My_Class_A: ...
+class My_Class_B: ...
+class My_Class_C: ...
+
+basic_attribute_types[str(type(My_Class_A()))] = False
+basic_attribute_types[str(type(My_Class_B()))] = True
+```
+
+`My_Class_A` will be treated as a primitive and only show up in the attributes table.
+`My_Class_B` will also show up in attributes table, but it still appears in the subobjects section.
+`My_Class_C` will only appear in the subobjects section.

{PyObjectInterface-0.1.1rc1 → PyObjectInterface-0.1.1rc2}/PyObjectInterface/__init__.py

@@ -1,6 +1,22 @@
 from typing_extensions import Self
 import inspect
 
+# {type: examine_recursively}
+basic_attribute_types = {
+    str(type(None)): False,  #NoneType
+    str(type(True)): False,  #bool
+    str(type(1)): False,     #int
+    str(type(1.0)): False,   #float
+    str(type('1')): False,   #str
+    str(type([1])): False,   #list
+    str(type({1:1})): False, #dict
+    str(type((1,1))): False, #tuple
+    str(type({1})): False,   #set
+    "<class 'numpy.ndarray'>": False,
+    "<class 'pandas.core.frame.DataFrame'>": False,
+    "<class 'pandas.core.series.Series'>": False
+}
+
 class FunctionDesc:
     def __init__(self, func):
         self.func = func
@@ -48,12 +64,14 @@ class PyObjectInterface:
             all_attrs = [x for x in inspect.getmembers(obj) if x[0][0:1] != '_'] #ignore private
 
         for (attr_name, instance) in all_attrs:
+            if str(type(instance)) in basic_attribute_types:
+                self.attribute_list.append(attr_name)
+                if not basic_attribute_types[str(type(instance))]:
+                    continue #skip the rest of the checks, we don't want to examine this item recursively
+
             if hasattr(instance, '__call__'):
                 self.method_dict[attr_name] = FunctionDesc(instance)
 
-            elif isinstance(instance, (int, float, str, bool, list, dict)) or instance is None:
-                self.attribute_list.append(attr_name)
-
             elif recursion_depth > 0: #stop adding subobjects at recursion depth 0
                 # using .__class__ allows superclassing
                 # noinspection PyTypeChecker

{PyObjectInterface-0.1.1rc1 → PyObjectInterface-0.1.1rc2}/PyObjectInterface.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyObjectInterface
-Version: 0.1.1rc1
+Version: 0.1.1rc2
 Summary: Create a web interface to interact with a class
 Home-page: https://github.com/RobertJN64/PyObjectInterface
 Author: Robert Nies
@@ -77,3 +77,29 @@ You can use PyObjectInterface without the WebController.
  - `flask_app`: return value of flask.Flask()
  - `recursion_depth = 5`: maximum layers of subobjects to include
  - `create_private_interface = True`: if `True` creates a `/webcontroller/private` page that includes private methods and attributes
+
+### Modifying Attributes
+
+By default, POI treats `NoneType, bool, int, float, str, list, dict, tuple, and set` as primitive types.
+These show up in the attribute table instead of as recursive objects.
+
+`numpy.ndarray`, `pandas.DataFrame`, and `pandas.Series` are also treated as primitives.
+
+If you would like to customize this behavior, you can modify
+`PyObjectInterface.basic_attribute_types`
+
+For example:
+```python
+from PyObjectInterface import basic_attribute_types
+
+class My_Class_A: ...
+class My_Class_B: ...
+class My_Class_C: ...
+
+basic_attribute_types[str(type(My_Class_A()))] = False
+basic_attribute_types[str(type(My_Class_B()))] = True
+```
+
+`My_Class_A` will be treated as a primitive and only show up in the attributes table.
+`My_Class_B` will also show up in attributes table, but it still appears in the subobjects section.
+`My_Class_C` will only appear in the subobjects section.

{PyObjectInterface-0.1.1rc1 → PyObjectInterface-0.1.1rc2}/README.md

@@ -54,4 +54,30 @@ You can use PyObjectInterface without the WebController.
  - `name: str`: Friendly name for object, generally the name of the variable that refers to the object
  - `flask_app`: return value of flask.Flask()
  - `recursion_depth = 5`: maximum layers of subobjects to include
- - `create_private_interface = True`: if `True` creates a `/webcontroller/private` page that includes private methods and attributes
+ - `create_private_interface = True`: if `True` creates a `/webcontroller/private` page that includes private methods and attributes
+
+### Modifying Attributes
+
+By default, POI treats `NoneType, bool, int, float, str, list, dict, tuple, and set` as primitive types.
+These show up in the attribute table instead of as recursive objects.
+
+`numpy.ndarray`, `pandas.DataFrame`, and `pandas.Series` are also treated as primitives.
+
+If you would like to customize this behavior, you can modify
+`PyObjectInterface.basic_attribute_types`
+
+For example:
+```python
+from PyObjectInterface import basic_attribute_types
+
+class My_Class_A: ...
+class My_Class_B: ...
+class My_Class_C: ...
+
+basic_attribute_types[str(type(My_Class_A()))] = False
+basic_attribute_types[str(type(My_Class_B()))] = True
+```
+
+`My_Class_A` will be treated as a primitive and only show up in the attributes table.
+`My_Class_B` will also show up in attributes table, but it still appears in the subobjects section.
+`My_Class_C` will only appear in the subobjects section.

{PyObjectInterface-0.1.1rc1 → PyObjectInterface-0.1.1rc2}/setup.cfg

@@ -6,7 +6,7 @@ license = MIT
 license_file = LICENSE
 url = https://github.com/RobertJN64/PyObjectInterface
 author_email = robertjnies@gmail.com
-version = 0.1.1rc1
+version = 0.1.1rc2
 long_description = file: README.md
 long_description_content_type = text/markdown
 classifiers = 

{PyObjectInterface-0.1.1rc1 → PyObjectInterface-0.1.1rc2}/tests/test_poi.py

@@ -1,5 +1,6 @@
+from PyObjectInterface import PyObjectInterface, basic_attribute_types
 from PyObjectInterface.WebController import generate_html
-from PyObjectInterface import PyObjectInterface
+import numpy as np
 import pytest
 
 class Nested:
@@ -141,4 +142,29 @@ def test_html():
 
     class Blank: pass
     poi = PyObjectInterface(Blank(), 'Blank')
-    assert 'table' not in generate_html(poi)
+    assert 'table' not in generate_html(poi)
+
+class np_special_case:
+    def __init__(self):
+        self.np_arr = np.array([1,2,3])
+
+def test_np_special_case():
+    n = np_special_case()
+
+    poi = PyObjectInterface(n, 'b')
+    assert 'np_arr' in poi.attribute_list
+    assert 'np_arr' not in poi.subobj_dict
+
+    basic_attribute_types[str(type(n.np_arr))] = True
+
+    poi = PyObjectInterface(n, 'b')
+    assert 'np_arr' in poi.attribute_list
+    assert 'np_arr' in poi.subobj_dict
+
+    assert "is a builtin method and can't be accessed from WebController" in generate_html(poi)
+
+    basic_attribute_types.pop(str(type(n.np_arr)))
+
+    poi = PyObjectInterface(n, 'b')
+    assert 'np_arr' not in poi.attribute_list
+    assert 'np_arr' in poi.subobj_dict