pyobjtojson 0.2__tar.gz → 0.3__tar.gz

{pyobjtojson-0.2 → pyobjtojson-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pyobjtojson
-Version: 0.2
+Version: 0.3
 Summary: A Python library that simplifies serializing any Python object to JSON-friendly structures, gracefully handling circular references.
 Author-email: "Carlos A. Planchón" <carlosandresplanchonprestes@gmail.com>
 License: MIT License
@@ -27,7 +27,7 @@ A lightweight Python library that simplifies the process of serializing **any**
   No special inheritance or overrides needed. Uses reflection and standard Python methods (`__dict__`, `asdict()`, `to_dict()`, etc.) where available.
 - **Easy to Integrate**  
   Just call `obj_to_json()` on your data structure—no additional configuration required.
-  
+
 ## Installation
 
 ```bash
@@ -74,7 +74,7 @@ a = {"name": "A"}
 b = {"circular": a}
 a["b"] = b  # Creates a circular reference
 
-obj_to_json(a)
+obj_to_json(a, check_circular=True)  # check_circular is True by default.
 ```
 
 **Output**:

{pyobjtojson-0.2 → pyobjtojson-0.3}/README.md

@@ -12,7 +12,7 @@ A lightweight Python library that simplifies the process of serializing **any**
   No special inheritance or overrides needed. Uses reflection and standard Python methods (`__dict__`, `asdict()`, `to_dict()`, etc.) where available.
 - **Easy to Integrate**  
   Just call `obj_to_json()` on your data structure—no additional configuration required.
-  
+
 ## Installation
 
 ```bash
@@ -59,7 +59,7 @@ a = {"name": "A"}
 b = {"circular": a}
 a["b"] = b  # Creates a circular reference
 
-obj_to_json(a)
+obj_to_json(a, check_circular=True)  # check_circular is True by default.
 ```
 
 **Output**:

{pyobjtojson-0.2 → pyobjtojson-0.3}/pyobjtojson/__init__.py

@@ -4,23 +4,31 @@ import dataclasses
 from collections.abc import Mapping, Sequence
 
 
-def _serialize_for_json(obj, visited):
+def _serialize_for_json(obj, visited, check_circular=True):
     """
     Internal recursion logic that can handle circular references
-    using `visited`.
-    This includes careful exception handling so partial failures don't break
-    the entire serialization.
+    using `visited`. This includes careful exception handling so
+    partial failures don't break the entire serialization.
+
+    :param obj: The object to serialize.
+    :param visited: A set used to track visited objects (for cycle detection).
+    :param check_circular: Whether to check for and mark circular references.
+    :return: A JSON-serializable structure, or a string if it cannot be
+             converted more structurally.
     """
 
     # If it's None, bool, int, float, or str, it’s already JSON-serializable.
     if obj is None or isinstance(obj, (bool, int, float, str)):
         return obj
 
-    # If we've already visited this object, it's a circular reference
     obj_id = id(obj)
-    if obj_id in visited:
-        return "<circular reference>"
-    visited.add(obj_id)
+
+    # If circular checking is enabled, see if we've already
+    # visited this object.
+    if check_circular is True:
+        if obj_id in visited:
+            return "<circular reference>"
+        visited.add(obj_id)
 
     # Handle Mapping (like dict). Build a new dict item by item,
     # catching errors.
@@ -28,7 +36,9 @@ def _serialize_for_json(obj, visited):
         result = {}
         for key, value in obj.items():
             try:
-                result[key] = _serialize_for_json(value, visited)
+                result[key] = _serialize_for_json(
+                    value, visited, check_circular=check_circular
+                )
             except Exception as exc:
                 result[key] = f"<serialization error: {exc}>"
         return result
@@ -38,7 +48,13 @@ def _serialize_for_json(obj, visited):
         result = []
         for index, item in enumerate(obj):
             try:
-                result.append(_serialize_for_json(item, visited))
+                result.append(
+                    _serialize_for_json(
+                        obj=item,
+                        visited=visited,
+                        check_circular=check_circular
+                    )
+                )
             except Exception as exc:
                 result.append(f"<serialization error at index {index}: {exc}>")
         return result
@@ -47,7 +63,11 @@ def _serialize_for_json(obj, visited):
     if hasattr(obj, "model_dump") and callable(obj.model_dump):
         try:
             model_data = obj.model_dump()
-            return _serialize_for_json(model_data, visited)
+            return _serialize_for_json(
+                obj=model_data,
+                visited=visited,
+                check_circular=check_circular
+            )
         except Exception:
             # Fall through to next check if this fails
             ...
@@ -56,7 +76,11 @@ def _serialize_for_json(obj, visited):
     if hasattr(obj, "dict") and callable(obj.dict):
         try:
             dict_data = obj.dict()
-            return _serialize_for_json(dict_data, visited)
+            return _serialize_for_json(
+                obj=dict_data,
+                visited=visited,
+                check_circular=check_circular
+            )
         except Exception:
             # Fall through to next check if this fails
             ...
@@ -65,7 +89,11 @@ def _serialize_for_json(obj, visited):
     if dataclasses.is_dataclass(obj):
         try:
             dc_data = dataclasses.asdict(obj)
-            return _serialize_for_json(dc_data, visited)
+            return _serialize_for_json(
+                obj=dc_data,
+                visited=visited,
+                check_circular=check_circular
+            )
         except Exception:
             # Fall through to next check if this fails
             ...
@@ -74,7 +102,11 @@ def _serialize_for_json(obj, visited):
     if hasattr(obj, "to_dict") and callable(obj.to_dict):
         try:
             custom_dict_data = obj.to_dict()
-            return _serialize_for_json(custom_dict_data, visited)
+            return _serialize_for_json(
+                obj=custom_dict_data,
+                visited=visited,
+                check_circular=check_circular
+            )
         except Exception:
             # Fall through to next check if this fails
             ...
@@ -82,10 +114,14 @@ def _serialize_for_json(obj, visited):
     # If the object has a __dict__, recurse into that
     if hasattr(obj, "__dict__"):
         try:
-            return _serialize_for_json(obj.__dict__, visited)
+            return _serialize_for_json(
+                obj=obj.__dict__,
+                visited=visited,
+                check_circular=check_circular
+            )
         except Exception:
             # Fall through to next check if this fails
-            ...
+            pass
 
     # Last resort: convert to string, but even this can fail
     # if __str__ is broken
@@ -96,9 +132,18 @@ def _serialize_for_json(obj, visited):
         return f"<serialization error: {exc}>"
 
 
-def obj_to_json(obj):
+def obj_to_json(obj, check_circular=True):
     """
     Public-facing function that starts with a fresh visited set
-    to handle cycles. Calls the internal _serialize_for_json.
+    to handle cycles (if `check_circular=True`). Calls the internal
+    _serialize_for_json.
+
+    :param obj: The object to serialize to JSON-like structures.
+    :param check_circular: If True, detect and mark circular references.
     """
-    return _serialize_for_json(obj, visited=set())
+    visited = set()
+    return _serialize_for_json(
+        obj=obj,
+        visited=visited,
+        check_circular=check_circular
+    )

{pyobjtojson-0.2 → pyobjtojson-0.3}/pyobjtojson.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pyobjtojson
-Version: 0.2
+Version: 0.3
 Summary: A Python library that simplifies serializing any Python object to JSON-friendly structures, gracefully handling circular references.
 Author-email: "Carlos A. Planchón" <carlosandresplanchonprestes@gmail.com>
 License: MIT License
@@ -27,7 +27,7 @@ A lightweight Python library that simplifies the process of serializing **any**
   No special inheritance or overrides needed. Uses reflection and standard Python methods (`__dict__`, `asdict()`, `to_dict()`, etc.) where available.
 - **Easy to Integrate**  
   Just call `obj_to_json()` on your data structure—no additional configuration required.
-  
+
 ## Installation
 
 ```bash
@@ -74,7 +74,7 @@ a = {"name": "A"}
 b = {"circular": a}
 a["b"] = b  # Creates a circular reference
 
-obj_to_json(a)
+obj_to_json(a, check_circular=True)  # check_circular is True by default.
 ```
 
 **Output**:

{pyobjtojson-0.2 → pyobjtojson-0.3}/pyproject.toml

@@ -8,7 +8,7 @@ packages = ["pyobjtojson"]
 
 [project]
 name = "pyobjtojson"
-version = "0.2"
+version = "0.3"
 authors = [
     {name = "Carlos A. Planchón", email = "carlosandresplanchonprestes@gmail.com"},
 ]