JSON Duplicate Keys - PyPI
Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate KeysInstallation¶
From PyPI:¶
pip install json-duplicate-keys
From Source:¶
git clone https://github.com/tpcybersec/json-duplicate-keys.git --branch <Branch/Tag>
cd json-duplicate-keys
python -m build
python -m pip install dist/json_duplicate_keys-<version>-py3-none-any.whl
Basic Usage¶
normalize_key(name, dupSign_start=”{{{”, dupSign_end=”}}}”, _isDebug_=False)¶
Normalize Key name
name: key namedupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
print(jdks.normalize_key("version{{{_2_}}}"))
# OUTPUT: version
loads(Jstr, dupSign_start=”{{{”, dupSign_end=”}}}”, ordered_dict=False, skipDuplicated=False, _isDebug_=False)¶
Deserialize a JSON format string to a class JSON_DUPLICATE_KEYS
Jstr: a JSON format stringdupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})ordered_dict: preserves the order in which the Keys are insertedskipDuplicated: Skip loading duplicate keys to improve execution performance_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject)
# OUTPUT: <json_duplicate_keys.JSON_DUPLICATE_KEYS object at 0x00000270AE987940>
load(Jfilepath, dupSign_start=”{{{”, dupSign_end=”}}}”, ordered_dict=False, skipDuplicated=False, _isDebug_=False)¶
Deserialize a JSON format string from a file to a class JSON_DUPLICATE_KEYS
Jfilepath: The path to the file containing the JSON format stringdupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})ordered_dict: preserves the order in which the Keys are insertedskipDuplicated: Skip loading duplicate keys to improve execution performance_isDebug_: Show/ Hide debug error messages
# /path/to/file.json: {"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}
import json_duplicate_keys as jdks
Jfilepath = "/path/to/file.json"
JDKSObject = jdks.load(Jfilepath)
print(JDKSObject)
# OUTPUT: <json_duplicate_keys.JSON_DUPLICATE_KEYS object at 0x00000270AE986D40>
JSON_DUPLICATE_KEYS.getObject()¶
Get the JSON object
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JSON_DUPLICATE_KEYS.get(name, case_insensitive=False, separator=”||”, parse_index=”$”, _isDebug_=False)¶
Get value in the JSON object by name
name: the key name of the JSON object. Supported flatten key name formatcase_insensitive: the key name case (in)sensitiveseparator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.get("version{{{_2_}}}"))
# OUTPUT: {'name': 'version{{{_2_}}}', 'value': 'latest'}
print(JDKSObject.get("release||$0$"))
# OUTPUT: {'name': 'release||$0$', 'value': {'version': 'latest'}}
print(JDKSObject.get("snapshot||author"))
# OUTPUT: {'name': 'snapshot||author', 'value': 'truocphan'}
JSON_DUPLICATE_KEYS.set(name, value, case_insensitive=False, separator=”||”, parse_index=”$”, dupSign_start=”{{{”, dupSign_end=”}}}”, ordered_dict=False, _isDebug_=False)¶
Set a new name and value for the JSON object
name: new key name for the JSON object. Supported flat key name formatvalue: value for keynamecase_insensitive: the key name case (in)sensitiveseparator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)dupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})ordered_dict: preserves the order in which the Keys are inserted_isDebug_: Show/Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {}
JDKSObject.set("author", "truocphan")
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan'}
JDKSObject.set("version", "22.3.3")
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3'}
JDKSObject.set("version", "latest")
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest'}
JDKSObject.set("release", [{"version": "latest"}])
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}]}
JDKSObject.set("snapshot", {})
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {}}
JDKSObject.set("snapshot||author", "truocphan")
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan'}}
JSON_DUPLICATE_KEYS.insert(name, value, position=None, case_insensitive=False, separator=”||”, parse_index=”$”, dupSign_start=”{{{”, dupSign_end=”}}}”, _isDebug_=False)¶
Insert value at position in value list of name
name: the key name of the JSON object. Supported flatten key name formatvalue: new value for keynameposition: position of thevalueto insert (default insert at the last position of the list)case_insensitive: the key name case (in)sensitiveseparator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)dupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JDKSObject.insert("release", {'version': '2025.1.1'})
JDKSObject.insert("snapshot||release", {'version': '2025.1.1'}, 0)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}, {'version': '2025.1.1'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': '2025.1.1'}, {'version': 'latest'}]}}
JSON_DUPLICATE_KEYS.update(name, value, case_insensitive=False, allow_new_key=False, separator=”||”, parse_index=”$”, dupSign_start=”{{{”, dupSign_end=”}}}”, ordered_dict=False, _isDebug_=False)¶
Update new value for existing name or Set a new name in the JSON object
name: the key name of the JSON object. Supported flatten key name formatvalue: new value for keynamecase_insensitive: the key name case (in)sensitiveallow_new_key: allows to create a new key name if the key name does not existseparator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)dupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})ordered_dict: preserves the order in which the Keys are inserted_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JDKSObject.update("version{{{_2_}}}", ["22.3.3", "latest"])
JDKSObject.update("snapshot||version", "latest")
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': ['22.3.3', 'latest'], 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': 'latest', 'release': [{'version': 'latest'}]}}
JSON_DUPLICATE_KEYS.delete(name, case_insensitive=False, separator=”||”, parse_index=”$”, _isDebug_=False)¶
Delete a key-value pair in a JSON object by key name
name: the key name of the JSON object. Supported flatten key name formatcase_insensitive: the key name case (in)sensitiveseparator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JDKSObject.delete("version")
JDKSObject.delete("release||$0$")
JDKSObject.delete("snapshot")
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version{{{_2_}}}': 'latest', 'release': []}
JSON_DUPLICATE_KEYS.filter_keys(name, separator=”||”, parse_index=”$”, ordered_dict=False)¶
Return a JSON_DUPLICATE_KEYS object with keys matching a pattern
name:separator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)ordered_dict: preserves the order in which the Keys are inserted
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.filter_keys("version").dumps())
# OUTPUT: {"version": "22.3.3", "version": "latest", "release||$0$||version": "latest", "snapshot||version": "22.3.3", "snapshot||release||$0$||version": "latest"}
print(JDKSObject.dumps())
# OUTPUT: {"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}
JSON_DUPLICATE_KEYS.filter_values(value, separator=”||”, parse_index=”$”, ordered_dict=False)¶
Return a JSON_DUPLICATE_KEYS object with values matching a pattern
value:separator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)ordered_dict: preserves the order in which the Keys are inserted
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.filter_values("latest").dumps())
# OUTPUT: {"version": "latest", "release||$0$||version": "latest", "snapshot||release||$0$||version": "latest"}
print(JDKSObject.dumps())
# OUTPUT: {"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}
JSON_DUPLICATE_KEYS.dumps(dupSign_start=”{{{”, dupSign_end=”}}}”, _isDebug_=False, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)¶
Serialize a JSON object to a JSON format string
dupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})_isDebug_: Show/ Hide debug error messagesFor remaining arguments, please refer to json.dump()
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JDKSObject.delete("version")
JDKSObject.delete("release||$0$")
JDKSObject.delete("snapshot")
print(JDKSObject.dumps())
# OUTPUT: {"author": "truocphan", "version": "latest", "release": []}
JSON_DUPLICATE_KEYS.dump(Jfilepath, dupSign_start=”{{{”, dupSign_end=”}}}”, _isDebug_=False, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)¶
Serialize a JSON object to a JSON format string and write to a file
Jfilepath: the path to the file to save the JSON format stringdupSign_start: Start symbol for marking duplicates (default:{{{)dupSign_end: End symbol for marking duplicates (default:}}})_isDebug_: Show/ Hide debug error messagesFor remaining arguments, please refer to json.dump()
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JDKSObject.delete("version")
JDKSObject.delete("release||$0$")
JDKSObject.delete("snapshot")
Jfilepath = "/path/to/file.json"
JDKSObject.dump(Jfilepath)
JDKSObject_load = jdks.load(Jfilepath)
print(JDKSObject_load.getObject())
# OUTPUT: {'author': 'truocphan', 'version': 'latest', 'release': []}
JSON_DUPLICATE_KEYS.flatten(separator=”||”, parse_index=”$”, ordered_dict=False, _isDebug_=False)¶
Flatten a JSON object to a single key-value pairs
separator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)ordered_dict: preserves the order in which the Keys are inserted_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release": [{"version": "latest"}], "snapshot": {"author": "truocphan", "version": "22.3.3", "release": [{"version": "latest"}]}}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
JDKSObject.flatten()
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release||$0$||version': 'latest', 'snapshot||author': 'truocphan', 'snapshot||version': '22.3.3', 'snapshot||release||$0$||version': 'latest'}
JSON_DUPLICATE_KEYS.unflatten(separator=”||”, parse_index=”$”, ordered_dict=False, _isDebug_=False)¶
Unflatten a flattened JSON object back to a JSON object
separator: Separator for flatten keys (default:||)parse_index: Symbol for index parsing (default:$)ordered_dict: preserves the order in which the Keys are inserted_isDebug_: Show/ Hide debug error messages
import json_duplicate_keys as jdks
Jstr = '{"author": "truocphan", "version": "22.3.3", "version": "latest", "release||$0$||version": "latest", "snapshot||author": "truocphan", "snapshot||version": "22.3.3", "snapshot||release||$0$||version": "latest"}'
JDKSObject = jdks.loads(Jstr)
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release||$0$||version': 'latest', 'snapshot||author': 'truocphan', 'snapshot||version': '22.3.3', 'snapshot||release||$0$||version': 'latest'}
JDKSObject.unflatten()
print(JDKSObject.getObject())
# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}
CHANGELOG¶
json-duplicate-keys v2025.8.19¶
[Updated] Add an exception when loading a non-existent file
[Updated] Dump Unicode characters to a file
json-duplicate-keys v2025.7.1¶
[Updated] Fixed some issues when loading JSON strings with
skipDuplicatedoption[Updated] Allow loading of JSON data in byte string format
[Updated] Issue with getting and setting an empty list
json-duplicate-keys v2025.6.6¶
[Updated] Added
skipDuplicatedparameter toloadandloadsfunctions to improve performance when parsing large JSON strings by skipping duplicate keys.
json-duplicate-keys v2024.12.12¶
New: insert function
json-duplicate-keys v2024.11.28¶
Fixed: Add subkey name to empty dict of existing key name
json-duplicate-keys v2024.11.19¶
Updated: Allows getting (
JSON_DUPLICATE_KEYS.get), setting (JSON_DUPLICATE_KEYS.set), updating (JSON_DUPLICATE_KEYS.update), deleting (JSON_DUPLICATE_KEYS.delete) JSON_DUPLICATE_KEYS objects with case-insensitive key names
json-duplicate-keys v2024.7.17¶
Fixed: issue #3 break the set function when the key’s value is empty. Thanks ptth222 for reporting this issue.
json-duplicate-keys v2024.4.20¶
New: filter_values
Updated: filter_keys
json-duplicate-keys v2024.3.24¶
Updated: normalize_key, loads, get, set, update, delete