RGBCube/JsonWrapper
1
Fork 0
mirror of https://github.com/RGBCube/JsonWrapper synced 2025-07-27 11:47:45 +00:00
Code Issues Activity Actions

get

Browse source
This commit is contained in:
RGBCube 2022-01-28 20:24:00 +03:00 • committed by GitHub
parent da720f7469
commit 0df6c16faa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/README.md
View file

@ -1,20 +1,35 @@
### Table of Contents
* [*class* `json_wrapper.JsonWrapper(json_path: str)`](https://github.com/RGBCube/json-wrapper/tree/main/docs#class-json_wrapperjsonwrapperjson_path-str)
# *class* `json_wrapper.JsonWrapper(json_path: str)`
### Methods
* [*def* `set(key: str, value, *, pathmagic: (str, list) = "")`](https://github.com/RGBCube/json-wrapper/tree/main/docs#def-setkey-str-value--pathmagic-str-list--)
* [*def* `get(key: str, *, default=None, pathmagic: (str, list) = "")`]() TODO
* [*def* `all()`]() TODO
* [*def* `rem(key: str, *, pathmagic: (str, list) = "")`]() TODO
* [*def* `nuke(*, pathmagic: (str, list) = "")`]() TODO
## *def* `set(key: str, value, *, pathmagic: (str, list) = "")`
Sets the key value pair in the json.
If the pathmagic kwarg is given, (if str)it will split it by the +'s and make dicts inside dicts(or use existing ones) until the list ends. Then it will set the key value pair in the last dict.
#### Args:
* key `(str)`: The key for the key value pair.
* value `(Any)`: The value for the key value pair.
* pathmagic `(Union[str, List[str]], optional)`: The path to follow. Defaults to `""`.
* key (`str`): The key for the key value pair.
* value (`Any`): The value for the key value pair.
* pathmagic (`Union[str, List[str]]`, optional): The path to follow. Defaults to `""`.
#### [Example Usage]() TODO
## *def* `get(key: str, *, default=None, pathmagic: (str, list) = "")`
Returns the key's value in the json. Will return the default kwarg if not found.
If the pathmagic kwarg is given, (if str)it will split it by the +'s and follow the dicts inside the dicts until the list ends. Then it will return the value of the key in the last dict. The default kwarg applies.
#### Args:
* key (`str`): The key to get the value of.
* default (`Any`, optional): The value to return if the key is not found. Defaults to `None`.
* pathmagic (`Union[str, List[str]]`, optional): The path to follow. Defaults to `""`.
#### Returns:
* `Any`: The value of the key. Will return the default kwarg if the key is not found.