issue in add_objcet_to_json

[Amangondaliya555]

Hi, I believe there is a small issue with the function add_object_to_json. In line 132 of jsonlibrary.py, it should be...

match.value.update({child_name: object_to_add_cpy[child_name]})

Currently, the function is adding the whole object as a value.
input: {key1;value1}
output: {key1: {key1;value1}}

can you please check and let me know if it is a bug or I am doing something wrong?

[NorseGaud]

Issue #58 Analysis: add_object_to_json Nesting Behavior

Issue Report

Source: #58

Summary: When using add_object_to_json to add an object to a non-existent path, the function adds the entire object as a nested value, which can cause unexpected double-nesting.

Bug Reproduction: CONFIRMED ✅

I've successfully reproduced the issue and added a test case in tests/test_JSONLib.py::TestJSONLib::test_add_object_to_json_issue_58.

Example of the Bug

When adding {key1: value1} to path $.key1:

Current behavior:

{
  "key1": {
    "key1": "value1"
  }
}

Issue reporter expects:

{
  "key1": "value1"
}

Root Cause

The issue is in JSONLib/jsonlib.py at line 132:

match.value.update({child_name: object_to_add_cpy})

This adds the entire object as the value for the new field.

Test Scenarios

Scenario 1: Path name matches object key (THE BUG)

• Path: $.key1
• Object: {key1: value1}
• Result: {key1: {key1: value1}} ❌
• Expected: {key1: value1}

Scenario 2: Path name differs from object keys (Works fine)

• Path: $.myField
• Object: {key1: value1}
• Result: {myField: {key1: value1}} ✅
• This is correct behavior

Scenario 3: Multiple keys in object

• Path: $.key1
• Object: {key1: value1, key2: value2}
• Result: {key1: {key1: value1, key2: value2}}
• Issue reporter's fix would give: {key1: value1} (loses key2!)

Scenario 4: Existing path (Works correctly)

• Path: $.address (already exists)
• Object: {city: Bangkok}
• Result: Merges correctly ✅

Proposed Fix from Issue Reporter

The issue suggests changing line 132 to:

match.value.update({child_name: object_to_add_cpy[child_name]})

Problems with This Fix:

1. Only works if child_name exists in object_to_add_cpy - Would raise KeyError if not
2. Loses other keys - If the object has multiple keys, only one is extracted
3. Breaks API consistency - Different behavior based on whether keys match

Questions for Consideration

1. Is this actually a bug or expected behavior?

   • The function is called add_object_to_json, so adding the entire object could be correct
   • The double-nesting only occurs when path name matches an object key

2. What should the expected behavior be?

   • Option A: Keep current behavior (explicit and predictable)
   • Option B: Extract matching key if it exists (suggested fix, but limited)
   • Option C: Always merge keys directly (breaking change for other use cases)

3. Should there be a different keyword?

   • Perhaps a new keyword like add_value_from_object for extracting specific values?

Test Added

A comprehensive test has been added to tests/test_JSONLib.py:

• Test name: test_add_object_to_json_issue_58
• Documents current behavior
• Covers multiple scenarios
• All tests pass (32/32)

Recommendation

The bug is CONFIRMED and reproducible. However, the suggested fix has limitations. Before implementing a fix, the maintainers should decide on the expected API behavior:

1. If current behavior is intentional → Close issue as "working as designed"
2. If fix is needed → Consider edge cases and potential breaking changes
3. Consider adding a new parameter or keyword for value extraction use cases

@Amangondaliya555 , What should the expected behavior be?