json-duplicate-keys


Namejson-duplicate-keys JSON
Version 2024.4.20 PyPI version JSON
download
home_pagehttps://github.com/truocphan/json-duplicate-keys
SummaryFlatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys
upload_time2024-04-20 16:04:13
maintainerNone
docs_urlNone
authorTP Cyber Security
requires_pythonNone
licenseMIT
keywords tpcybersec json duplicate keys json duplicate keys flatten unflatten
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # JSON Duplicate Keys - PyPI
Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys

<p align="center">
    <a href="https://github.com/truocphan/json-duplicate-keys/releases/"><img src="https://img.shields.io/github/release/truocphan/json-duplicate-keys" height=30></a>
	<a href="#"><img src="https://img.shields.io/github/downloads/truocphan/json-duplicate-keys/total" height=30></a>
	<a href="#"><img src="https://img.shields.io/github/stars/truocphan/json-duplicate-keys" height=30></a>
	<a href="#"><img src="https://img.shields.io/github/forks/truocphan/json-duplicate-keys" height=30></a>
	<a href="https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aopen+is%3Aissue"><img src="https://img.shields.io/github/issues/truocphan/json-duplicate-keys" height=30></a>
	<a href="https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/truocphan/json-duplicate-keys" height=30></a>
	<a href="https://pypi.org/project/json-duplicate-keys/" target="_blank"><img src="https://img.shields.io/badge/pypi-3775A9?style=for-the-badge&logo=pypi&logoColor=white" height=30></a>
	<a href="https://www.facebook.com/61550595106970" target="_blank"><img src="https://img.shields.io/badge/Facebook-1877F2?style=for-the-badge&logo=facebook&logoColor=white" height=30></a>
	<a href="https://twitter.com/TPCyberSec" target="_blank"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" height=30></a>
	<a href="https://github.com/truocphan" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white" height=30></a>
	<a href="mailto:tpcybersec2023@gmail.com" target="_blank"><img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white" height=30></a>
	<a href="https://www.buymeacoffee.com/truocphan" target="_blank"><img src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black" height=30></a>
</p>

## Installation
#### From PyPI:
```console
pip install json-duplicate-keys
```
#### From Source:
```console
git clone https://github.com/truocphan/json-duplicate-keys.git --branch <Branch/Tag>
cd json-duplicate-keys
python setup.py build
python setup.py install
```

## Basic Usage
### normalize_key(`name`, `dupSign_start`="{{{", `dupSign_end`="}}}", `_isDebug_`=False)
_Normalize Key name_
- `name`: key name
- `dupSign_start`: 
- `dupSign_end`: 
- `_isDebug_`: Show/ Hide debug error messages
```python
import json_duplicate_keys as jdks

print(jdks.normalize_key("version{{{_2_}}}"))
# OUTPUT: version
```
---

### loads(`Jstr`, `dupSign_start`="{{{", `dupSign_end`="}}}", `ordered_dict`=False, `_isDebug_`=False)
_Deserialize a JSON format string to a class `JSON_DUPLICATE_KEYS`_
- `Jstr`: a JSON format string
- `dupSign_start`: 
- `dupSign_end`: 
- `ordered_dict`: preserves the order in which the Keys are inserted
- `_isDebug_`: Show/ Hide debug error messages
```python
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, `_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 string
- `dupSign_start`: 
- `dupSign_end`: 
- `ordered_dict`: preserves the order in which the Keys are inserted
- `_isDebug_`: Show/ Hide debug error messages
```python
# /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_
```python
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`, `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 format
- `separator`: 
- `parse_index`:
- `_isDebug_`: Show/ Hide debug error messages
```python
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: latest

print(JDKSObject.get("release||$0$"))
# OUTPUT: {'version': 'latest'}

print(JDKSObject.get("snapshot||author"))
# OUTPUT: truocphan
```
---

### JSON_DUPLICATE_KEYS.set(`name`, `value`, `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 format
- `value`: value for key `name`
- `separator`: 
- `parse_index`: 
- `dupSign_start`: 
- `dupSign_end`: 
- `ordered_dict`: preserves the order in which the Keys are inserted
- `_isDebug_`: Show/Hide debug error messages
```python
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'}}


Jstr = '[]'
JDKSObject = jdks.loads(Jstr)

print(JDKSObject.getObject())
# OUTPUT: []

JDKSObject.set("author", "truocphan")
print(JDKSObject.getObject())
# OUTPUT: [{'author': 'truocphan'}]

JDKSObject.set("release", [])
print(JDKSObject.getObject())
# OUTPUT: [{'author': 'truocphan'}, {'release': []}]

JDKSObject.set("$1$||release||", {"version": "latest"})
print(JDKSObject.getObject())
# OUTPUT: [{'author': 'truocphan'}, {'release': [{'version': 'latest'}]}]
```
---

### JSON_DUPLICATE_KEYS.update(`name`, `value`, `separator`="||", `parse_index`="$", `_isDebug_`=False)
_Update new `value` for existing `name` in the JSON object_
- `name`: the key name of the JSON object. Supported flatten key name format
- `value`: new value for key `name`
- `separator`: 
- `parse_index`: 
- `_isDebug_`: Show/ Hide debug error messages
```python
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`, `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 format
- `separator`: 
- `parse_index`: 
- `_isDebug_`: Show/ Hide debug error messages
```python
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)

- `name`:
- `separator`:
- `parse_index`:
- `ordered_dict`:
```python
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)

- `value`:
- `separator`:
- `parse_index`:
- `ordered_dict`:
```python
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`: 
- `dupSign_end`: 
- `_isDebug_`: Show/ Hide debug error messages
- For remaining arguments, please refer to [json.dump()](https://docs.python.org/3/library/json.html#json.dump)
```python
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 string
- `dupSign_start`: 
- `dupSign_end`: 
- `_isDebug_`: Show/ Hide debug error messages
- For remaining arguments, please refer to [json.dump()](https://docs.python.org/3/library/json.html#json.dump)
```python
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`: 
- `parse_index`: 
- `ordered_dict`: preserves the order in which the Keys are inserted
- `_isDebug_`: Show/ Hide debug error messages
```python
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`: 
- `parse_index`: 
- `ordered_dict`: preserves the order in which the Keys are inserted
- `_isDebug_`: Show/ Hide debug error messages
```python
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 v2024.4.20](https://github.com/truocphan/json-duplicate-keys/tree/2024.4.20)
- **New**: _filter_values_
- **Updated**: _filter_keys_

#### [json-duplicate-keys v2024.3.24](https://github.com/truocphan/json-duplicate-keys/tree/2024.3.24)
- **Updated**: _normalize_key_, _loads_, _get_, _set_, _update_, _delete_
---


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/truocphan/json-duplicate-keys",
    "name": "json-duplicate-keys",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "TPCyberSec, json, duplicate keys, json duplicate keys, flatten, unflatten",
    "author": "TP Cyber Security",
    "author_email": "tpcybersec2023@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/45/10/726e670ec019e340006c8fa403d821e6a6fc5dd96c8bfc6fb66a3e6328e7/json-duplicate-keys-2024.4.20.tar.gz",
    "platform": null,
    "description": "# JSON Duplicate Keys - PyPI\nFlatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys\n\n<p align=\"center\">\n    <a href=\"https://github.com/truocphan/json-duplicate-keys/releases/\"><img src=\"https://img.shields.io/github/release/truocphan/json-duplicate-keys\" height=30></a>\n\t<a href=\"#\"><img src=\"https://img.shields.io/github/downloads/truocphan/json-duplicate-keys/total\" height=30></a>\n\t<a href=\"#\"><img src=\"https://img.shields.io/github/stars/truocphan/json-duplicate-keys\" height=30></a>\n\t<a href=\"#\"><img src=\"https://img.shields.io/github/forks/truocphan/json-duplicate-keys\" height=30></a>\n\t<a href=\"https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aopen+is%3Aissue\"><img src=\"https://img.shields.io/github/issues/truocphan/json-duplicate-keys\" height=30></a>\n\t<a href=\"https://github.com/truocphan/json-duplicate-keys/issues?q=is%3Aissue+is%3Aclosed\"><img src=\"https://img.shields.io/github/issues-closed/truocphan/json-duplicate-keys\" height=30></a>\n\t<a href=\"https://pypi.org/project/json-duplicate-keys/\" target=\"_blank\"><img src=\"https://img.shields.io/badge/pypi-3775A9?style=for-the-badge&logo=pypi&logoColor=white\" height=30></a>\n\t<a href=\"https://www.facebook.com/61550595106970\" target=\"_blank\"><img src=\"https://img.shields.io/badge/Facebook-1877F2?style=for-the-badge&logo=facebook&logoColor=white\" height=30></a>\n\t<a href=\"https://twitter.com/TPCyberSec\" target=\"_blank\"><img src=\"https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white\" height=30></a>\n\t<a href=\"https://github.com/truocphan\" target=\"_blank\"><img src=\"https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white\" height=30></a>\n\t<a href=\"mailto:tpcybersec2023@gmail.com\" target=\"_blank\"><img src=\"https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white\" height=30></a>\n\t<a href=\"https://www.buymeacoffee.com/truocphan\" target=\"_blank\"><img src=\"https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black\" height=30></a>\n</p>\n\n## Installation\n#### From PyPI:\n```console\npip install json-duplicate-keys\n```\n#### From Source:\n```console\ngit clone https://github.com/truocphan/json-duplicate-keys.git --branch <Branch/Tag>\ncd json-duplicate-keys\npython setup.py build\npython setup.py install\n```\n\n## Basic Usage\n### normalize_key(`name`, `dupSign_start`=\"{{{\", `dupSign_end`=\"}}}\", `_isDebug_`=False)\n_Normalize Key name_\n- `name`: key name\n- `dupSign_start`: \n- `dupSign_end`: \n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nprint(jdks.normalize_key(\"version{{{_2_}}}\"))\n# OUTPUT: version\n```\n---\n\n### loads(`Jstr`, `dupSign_start`=\"{{{\", `dupSign_end`=\"}}}\", `ordered_dict`=False, `_isDebug_`=False)\n_Deserialize a JSON format string to a class `JSON_DUPLICATE_KEYS`_\n- `Jstr`: a JSON format string\n- `dupSign_start`: \n- `dupSign_end`: \n- `ordered_dict`: preserves the order in which the Keys are inserted\n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject)\n# OUTPUT: <json_duplicate_keys.JSON_DUPLICATE_KEYS object at 0x00000270AE987940>\n```\n---\n\n### load(`Jfilepath`, `dupSign_start`=\"{{{\", `dupSign_end`=\"}}}\", `ordered_dict`=False, `_isDebug_`=False)\n_Deserialize a JSON format string from a file to a class `JSON_DUPLICATE_KEYS`_\n- `Jfilepath`: The path to the file containing the JSON format string\n- `dupSign_start`: \n- `dupSign_end`: \n- `ordered_dict`: preserves the order in which the Keys are inserted\n- `_isDebug_`: Show/ Hide debug error messages\n```python\n# /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\"}]}}\n\nimport json_duplicate_keys as jdks\n\nJfilepath = \"/path/to/file.json\"\n\nJDKSObject = jdks.load(Jfilepath)\n\nprint(JDKSObject)\n# OUTPUT: <json_duplicate_keys.JSON_DUPLICATE_KEYS object at 0x00000270AE986D40>\n```\n---\n\n### JSON_DUPLICATE_KEYS.getObject()\n_Get the JSON object_\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n```\n---\n\n### JSON_DUPLICATE_KEYS.get(`name`, `separator`=\"||\", `parse_index`=\"$\", `_isDebug_`=False)\n_Get value in the JSON object by `name`_\n- `name`: the key name of the JSON object. Supported flatten key name format\n- `separator`: \n- `parse_index`:\n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.get(\"version{{{_2_}}}\"))\n# OUTPUT: latest\n\nprint(JDKSObject.get(\"release||$0$\"))\n# OUTPUT: {'version': 'latest'}\n\nprint(JDKSObject.get(\"snapshot||author\"))\n# OUTPUT: truocphan\n```\n---\n\n### JSON_DUPLICATE_KEYS.set(`name`, `value`, `separator`=\"||\", `parse_index`=\"$\", `dupSign_start`=\"{{{\", `dupSign_end`=\"}}}\", `ordered_dict`=False, `_isDebug_`=False)\n_Set a new `name` and `value` for the JSON object_\n- `name`: new key name for the JSON object. Supported flat key name format\n- `value`: value for key `name`\n- `separator`: \n- `parse_index`: \n- `dupSign_start`: \n- `dupSign_end`: \n- `ordered_dict`: preserves the order in which the Keys are inserted\n- `_isDebug_`: Show/Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{}'\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {}\n\nJDKSObject.set(\"author\", \"truocphan\")\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan'}\n\nJDKSObject.set(\"version\", \"22.3.3\")\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3'}\n\nJDKSObject.set(\"version\", \"latest\")\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest'}\n\nJDKSObject.set(\"release\", [{\"version\": \"latest\"}])\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}]}\n\nJDKSObject.set(\"snapshot\", {})\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {}}\n\nJDKSObject.set(\"snapshot||author\", \"truocphan\")\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan'}}\n\n\nJstr = '[]'\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: []\n\nJDKSObject.set(\"author\", \"truocphan\")\nprint(JDKSObject.getObject())\n# OUTPUT: [{'author': 'truocphan'}]\n\nJDKSObject.set(\"release\", [])\nprint(JDKSObject.getObject())\n# OUTPUT: [{'author': 'truocphan'}, {'release': []}]\n\nJDKSObject.set(\"$1$||release||\", {\"version\": \"latest\"})\nprint(JDKSObject.getObject())\n# OUTPUT: [{'author': 'truocphan'}, {'release': [{'version': 'latest'}]}]\n```\n---\n\n### JSON_DUPLICATE_KEYS.update(`name`, `value`, `separator`=\"||\", `parse_index`=\"$\", `_isDebug_`=False)\n_Update new `value` for existing `name` in the JSON object_\n- `name`: the key name of the JSON object. Supported flatten key name format\n- `value`: new value for key `name`\n- `separator`: \n- `parse_index`: \n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n\nJDKSObject.update(\"version{{{_2_}}}\", [\"22.3.3\", \"latest\"])\nJDKSObject.update(\"snapshot||version\", \"latest\")\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': ['22.3.3', 'latest'], 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': 'latest', 'release': [{'version': 'latest'}]}}\n```\n---\n\n### JSON_DUPLICATE_KEYS.delete(`name`, `separator`=\"||\", `parse_index`=\"$\", `_isDebug_`=False)\n_Delete a key-value pair in a JSON object by key `name`_\n- `name`: the key name of the JSON object. Supported flatten key name format\n- `separator`: \n- `parse_index`: \n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n\nJDKSObject.delete(\"version\")\nJDKSObject.delete(\"release||$0$\")\nJDKSObject.delete(\"snapshot\")\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version{{{_2_}}}': 'latest', 'release': []}\n```\n---\n\n### JSON_DUPLICATE_KEYS.filter_keys(`name`, `separator`=\"||\", `parse_index`=\"$\", `ordered_dict`=False)\n\n- `name`:\n- `separator`:\n- `parse_index`:\n- `ordered_dict`:\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.filter_keys(\"version\").dumps())\n# OUTPUT: {\"version\": \"22.3.3\", \"version\": \"latest\", \"release||$0$||version\": \"latest\", \"snapshot||version\": \"22.3.3\", \"snapshot||release||$0$||version\": \"latest\"}\n\nprint(JDKSObject.dumps())\n# OUTPUT: {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}\n```\n---\n\n### JSON_DUPLICATE_KEYS.filter_values(`value`, `separator`=\"||\", `parse_index`=\"$\", `ordered_dict`=False)\n\n- `value`:\n- `separator`:\n- `parse_index`:\n- `ordered_dict`:\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.filter_values(\"latest\").dumps())\n# OUTPUT: {\"version\": \"latest\", \"release||$0$||version\": \"latest\", \"snapshot||release||$0$||version\": \"latest\"}\n\nprint(JDKSObject.dumps())\n# OUTPUT: {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}\n```\n---\n\n### 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)\n_Serialize a JSON object to a JSON format string_\n- `dupSign_start`: \n- `dupSign_end`: \n- `_isDebug_`: Show/ Hide debug error messages\n- For remaining arguments, please refer to [json.dump()](https://docs.python.org/3/library/json.html#json.dump)\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n\nJDKSObject.delete(\"version\")\nJDKSObject.delete(\"release||$0$\")\nJDKSObject.delete(\"snapshot\")\n\nprint(JDKSObject.dumps())\n# OUTPUT: {\"author\": \"truocphan\", \"version\": \"latest\", \"release\": []}\n```\n---\n\n### 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)\n_Serialize a JSON object to a JSON format string and write to a file_\n- `Jfilepath`: the path to the file to save the JSON format string\n- `dupSign_start`: \n- `dupSign_end`: \n- `_isDebug_`: Show/ Hide debug error messages\n- For remaining arguments, please refer to [json.dump()](https://docs.python.org/3/library/json.html#json.dump)\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n\nJDKSObject.delete(\"version\")\nJDKSObject.delete(\"release||$0$\")\nJDKSObject.delete(\"snapshot\")\n\nJfilepath = \"/path/to/file.json\"\nJDKSObject.dump(Jfilepath)\n\nJDKSObject_load = jdks.load(Jfilepath)\nprint(JDKSObject_load.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': 'latest', 'release': []}\n```\n---\n\n### JSON_DUPLICATE_KEYS.flatten(`separator`=\"||\", `parse_index`=\"$\", `ordered_dict`=False, `_isDebug_`=False)\n_Flatten a JSON object to a single key-value pairs_\n- `separator`: \n- `parse_index`: \n- `ordered_dict`: preserves the order in which the Keys are inserted\n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"author\": \"truocphan\", \"version\": \"22.3.3\", \"version\": \"latest\", \"release\": [{\"version\": \"latest\"}], \"snapshot\": {\"author\": \"truocphan\", \"version\": \"22.3.3\", \"release\": [{\"version\": \"latest\"}]}}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n\nJDKSObject.flatten()\n\nprint(JDKSObject.getObject())\n# 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'}\n```\n---\n\n### JSON_DUPLICATE_KEYS.unflatten(`separator`=\"||\", `parse_index`=\"$\", `ordered_dict`=False, `_isDebug_`=False)\n_Unflatten a flattened JSON object back to a JSON object_\n- `separator`: \n- `parse_index`: \n- `ordered_dict`: preserves the order in which the Keys are inserted\n- `_isDebug_`: Show/ Hide debug error messages\n```python\nimport json_duplicate_keys as jdks\n\nJstr = '{\"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\"}'\n\nJDKSObject = jdks.loads(Jstr)\n\nprint(JDKSObject.getObject())\n# 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'}\n\nJDKSObject.unflatten()\n\nprint(JDKSObject.getObject())\n# OUTPUT: {'author': 'truocphan', 'version': '22.3.3', 'version{{{_2_}}}': 'latest', 'release': [{'version': 'latest'}], 'snapshot': {'author': 'truocphan', 'version': '22.3.3', 'release': [{'version': 'latest'}]}}\n```\n---\n\n## CHANGELOG\n#### [json-duplicate-keys v2024.4.20](https://github.com/truocphan/json-duplicate-keys/tree/2024.4.20)\n- **New**: _filter_values_\n- **Updated**: _filter_keys_\n\n#### [json-duplicate-keys v2024.3.24](https://github.com/truocphan/json-duplicate-keys/tree/2024.3.24)\n- **Updated**: _normalize_key_, _loads_, _get_, _set_, _update_, _delete_\n---\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Flatten/ Unflatten and Load(s)/ Dump(s) JSON File/ Object with Duplicate Keys",
    "version": "2024.4.20",
    "project_urls": {
        "Homepage": "https://github.com/truocphan/json-duplicate-keys"
    },
    "split_keywords": [
        "tpcybersec",
        " json",
        " duplicate keys",
        " json duplicate keys",
        " flatten",
        " unflatten"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c747cee28d272643b91cef5a213b5c9f39254052684a76e2d4a7d6581b74d2c2",
                "md5": "0790b0296dbc9ada5adec975c3825bdf",
                "sha256": "ef102e0d59bc7d9faf1506462266e09c16b67abefc1eb1da6bf4ef67c588be73"
            },
            "downloads": -1,
            "filename": "json_duplicate_keys-2024.4.20-py2-none-any.whl",
            "has_sig": false,
            "md5_digest": "0790b0296dbc9ada5adec975c3825bdf",
            "packagetype": "bdist_wheel",
            "python_version": "py2",
            "requires_python": null,
            "size": 8191,
            "upload_time": "2024-04-20T16:04:09",
            "upload_time_iso_8601": "2024-04-20T16:04:09.772189Z",
            "url": "https://files.pythonhosted.org/packages/c7/47/cee28d272643b91cef5a213b5c9f39254052684a76e2d4a7d6581b74d2c2/json_duplicate_keys-2024.4.20-py2-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e4cdebc6cb6965231f10fb078a8a0eff426e690a958b81ba8cbbcd682baf1ea5",
                "md5": "c261a773085b2c5720750ee7d45eb316",
                "sha256": "e4dee7116579a08a2a24125e75cf1990795432882e4496bb6e7ef7b45bde5a8f"
            },
            "downloads": -1,
            "filename": "json_duplicate_keys-2024.4.20-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c261a773085b2c5720750ee7d45eb316",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8216,
            "upload_time": "2024-04-20T16:04:11",
            "upload_time_iso_8601": "2024-04-20T16:04:11.847658Z",
            "url": "https://files.pythonhosted.org/packages/e4/cd/ebc6cb6965231f10fb078a8a0eff426e690a958b81ba8cbbcd682baf1ea5/json_duplicate_keys-2024.4.20-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4510726e670ec019e340006c8fa403d821e6a6fc5dd96c8bfc6fb66a3e6328e7",
                "md5": "38846e2c13d4fd4fd5b3853d09230b2e",
                "sha256": "c998fe9640c38a85fe8b98b129a12baf6e4a8b270302d1c1fb0792f9b3db8bc7"
            },
            "downloads": -1,
            "filename": "json-duplicate-keys-2024.4.20.tar.gz",
            "has_sig": false,
            "md5_digest": "38846e2c13d4fd4fd5b3853d09230b2e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8535,
            "upload_time": "2024-04-20T16:04:13",
            "upload_time_iso_8601": "2024-04-20T16:04:13.193135Z",
            "url": "https://files.pythonhosted.org/packages/45/10/726e670ec019e340006c8fa403d821e6a6fc5dd96c8bfc6fb66a3e6328e7/json-duplicate-keys-2024.4.20.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-20 16:04:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "truocphan",
    "github_project": "json-duplicate-keys",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "json-duplicate-keys"
}
        
Elapsed time: 0.34932s