zerohertzLib.util.json ¶

Classes:

Name	Description
`Json`	JSON 형식 file을 읽고 사용하기 위한 class
`JsonDir`	입력된 경로에 존재하는 JSON 형식 file들을 읽고 사용하기 위한 class

Functions:

Name	Description
`write_json`	JSON (JavaScript Object Notation)을 작성하는 function

Json ¶

Json(path: str | None = None)

JSON 형식 file을 읽고 사용하기 위한 class

객체 생성 시 path 를 입력하지 않을 시 현재 경로에 존재하는 JSON file을 읽고 path 를 경로로 입력하면 해당 경로에 존재하는 JSON file을 읽는다.

Parameters:

Name	Type	Description	Default
`path`	`str \| None`	JSON file의 경로	`None`

Attributes:

Name	Type	Description
`name`		JSON file 이름
`keys`		직렬화된 JSON의 key 값들

Examples:

>>> js = zz.util.Json()
>>> js["title"]
'[v0.2.3] Release'
>>> key = js._get_key("color")
>>> key
'labels/LIST/color'
>>> js._get_value(key)
'd73a4a'
>>> js.name
'65.json'
>>> js.keys
['url', 'id', ..., 'assignees/LIST/login', ..., 'active_lock_reason']

Methods:

Name	Description
`__getitem__`	JSON file에서 key에 해당하는 값을 반환
`__len__`	JSON file의 길이를 반환
`get`	`Json._get_key` 로 생성된 key 값을 입력 받아 value return
`tree`	JSON의 구조를 출력하는 method

Source code in zerohertzLib/util/json.py

def __init__(self, path: str | None = None) -> None:
    if path is None:
        path = glob("*.json")[0]
    elif not path.endswith(".json"):
        path = glob(f"{path}/*.json")[0]
    self.name = path.replace(os.path.dirname(path), "").replace("/", "")
    with open(path, "r", encoding="utf-8") as file:
        self.data = orjson.loads(file.read())
    self.keys = []
    self.map = []

data `instance-attribute` ¶

data = loads(read())

keys `instance-attribute` ¶

keys = []

map `instance-attribute` ¶

map = []

name `instance-attribute` ¶

name = replace('/', '')

__get_keys ¶

__get_keys(data: Any, key: str = '', front: str = '') -> None

Source code in zerohertzLib/util/json.py

def __get_keys(self, data: Any, key: str = "", front: str = "") -> None:
    if isinstance(data, dict):
        for idx, (key_, val_) in enumerate(data.items()):
            if idx + 1 == len(data):
                self.map.append(front + "└── " + str(key_))
                front_ = " "
            else:
                self.map.append(front + "├── " + str(key_))
                front_ = "│"
            if key:
                self.keys.append(f"{key}/{key_}")
                self.__get_keys(val_, f"{key}/{key_}", front + f"{front_}   ")
            else:
                self.keys.append(f"{key_}")
                self.__get_keys(val_, f"{key_}", front + f"{front_}   ")
    elif isinstance(data, list):
        self.map.append(front + "└── " + "LIST")
        if data:
            if key:
                self.__get_keys(data[0], f"{key}/LIST", front + "    ")
            else:
                self.__get_keys(data[0], "LIST", front + "    ")

getitem ¶

__getitem__(key: int | str) -> Any

JSON file에서 key에 해당하는 값을 반환

Parameters:

Name	Type	Description	Default
`key`	`int \| str`	읽어온 JSON file에서 불러올 key 값	required

Returns:

Type	Description
`Any`	Key에 따른 value 값

Source code in zerohertzLib/util/json.py

def __getitem__(self, key: int | str) -> Any:
    """JSON file에서 key에 해당하는 값을 반환

    Args:
        key: 읽어온 JSON file에서 불러올 key 값

    Returns:
        Key에 따른 value 값
    """
    return self.data[key]

len ¶

__len__() -> int

JSON file의 길이를 반환

Returns:

Type	Description
`int`	읽어온 JSON file의 길이

Source code in zerohertzLib/util/json.py

def __len__(self) -> int:
    """JSON file의 길이를 반환

    Returns:
        읽어온 JSON file의 길이
    """
    return len(self.data)

_get_key ¶

_get_key(key: str) -> str

Key의 경로를 찾아주는 method

Parameters:

Name	Type	Description	Default
`key`	`str`	읽어온 JSON file에서 불러올 key 값 (깊이 무관)	required

Returns:

Type	Description
`str`	`/` 으로 깊이를 표시한 key 값

Source code in zerohertzLib/util/json.py

def _get_key(self, key: str) -> str:
    """
    Key의 경로를 찾아주는 method

    Args:
        key: 읽어온 JSON file에서 불러올 key 값 (깊이 무관)

    Returns:
        `/` 으로 깊이를 표시한 key 값
    """
    keys = self._get_keys()
    if key in keys:
        return key
    if "/" not in key:
        for key_ in keys:
            if key_.endswith(key):
                key = key_
                break
    return key

_get_keys ¶

_get_keys() -> list[str]

Source code in zerohertzLib/util/json.py

def _get_keys(self) -> list[str]:
    if not self.keys and not self.map:
        self.__get_keys(self.data)
    return self.keys

_get_value ¶

_get_value(key: str) -> Any

Json._get_key 로 생성된 key 값을 입력 받아 value return

Parameters:

Name	Type	Description	Default
`key`	`str`	`Json._get_key` 로 생성된 key 값	required

Returns:

Type	Description
`Any`	Key에 따른 value

Source code in zerohertzLib/util/json.py

def _get_value(self, key: str) -> Any:
    """
    `Json._get_key` 로 생성된 key 값을 입력 받아 value return

    Args:
        key: `Json._get_key` 로 생성된 key 값

    Returns:
        Key에 따른 value
    """
    value = self.data
    for key_ in key.split("/"):
        if key_ == "LIST":
            value = value[0]
        else:
            value = value.get(key_)
    return value

get ¶

get(key: str) -> Any

Json._get_key 로 생성된 key 값을 입력 받아 value return

Parameters:

Name	Type	Description	Default
`key`	`str`	읽어온 JSON file에서 불러올 key 값 (깊이 무관)	required

Returns:

Type	Description
`Any`	Key에 따른 value

Examples:

>>> js["title"]
'[v0.2.3] Release'
>>> js.get("title")
'[v0.2.3] Release'
>>> js["color"]
Traceback:
  File "<stdin>", line 1, in <module>
  File "/home/zerohertz/Zerohertz/zerohertzLib/zerohertzLib/util/json.py", line 107, in __getitem__
KeyError: 'color'
>>> js.get("color")
'd73a4a'

Source code in zerohertzLib/util/json.py

def get(self, key: str) -> Any:
    """`Json._get_key` 로 생성된 key 값을 입력 받아 value return

    Args:
        key: 읽어온 JSON file에서 불러올 key 값 (깊이 무관)

    Returns:
        Key에 따른 value

    Examples:
        >>> js["title"]
        '[v0.2.3] Release'
        >>> js.get("title")
        '[v0.2.3] Release'
        >>> js["color"]
        Traceback:
          File "<stdin>", line 1, in <module>
          File "/home/zerohertz/Zerohertz/zerohertzLib/zerohertzLib/util/json.py", line 107, in __getitem__
        KeyError: 'color'
        >>> js.get("color")
        'd73a4a'
    """
    return self._get_value(self._get_key(key))

tree ¶

tree() -> None

JSON의 구조를 출력하는 method

Examples:

>>> js.tree()
├── url
...
├── user
│   ├── login
...
│   └── site_admin
├── body
...
├── assignee
│   ├── login
...
│   └── site_admin
├── assignees
│   └── LIST
│       ├── login
...
│       └── site_admin
...
└── active_lock_reason

Source code in zerohertzLib/util/json.py

def tree(self) -> None:
    """JSON의 구조를 출력하는 method

    Examples:
        >>> js.tree()
        ├── url
        ...
        ├── user
        │   ├── login
        ...
        │   └── site_admin
        ├── body
        ...
        ├── assignee
        │   ├── login
        ...
        │   └── site_admin
        ├── assignees
        │   └── LIST
        │       ├── login
        ...
        │       └── site_admin
        ...
        └── active_lock_reason
    """
    self._get_keys()
    print("\n".join(self.map))

JsonDir ¶

JsonDir(path: str = '')

입력된 경로에 존재하는 JSON 형식 file들을 읽고 사용하기 위한 class

객체 생성 시 path 를 입력하지 않을 시 현재 경로에 존재하는 JSON file들을 읽는다.

Parameters:

Name	Type	Description	Default
`path`	`str`	JSON file의 경로	`''`

Attributes:

Name	Type	Description
`name`		읽어온 JSON file의 이름들
`data`		File 이름에 따른 `Json` 객체 배열

Examples:

>>> jsd = zz.util.JsonDir()
100%|█████████████| 5/5 [00:00<00:00, 3640.26it/s]
>>> len(jsd)
5
>>> jsd[0]
<zerohertzLib.util.json.Json object at 0x7f2562b83d00>
>>> jsd[0]["title"]
'[v0.2.3] Release'
>>> jsd._get_key("color")
'labels/LIST/color'

Methods:

Name	Description
`__getitem__`	Index를 사용하여 JSON file에 접근
`__len__`	JSON file의 길이를 반환
`tree`	JSON의 구조를 출력하는 method
`unique`	읽어온 JSON data들의 유일한 값을 return하는 method

Source code in zerohertzLib/util/json.py

def __init__(self, path: str = "") -> None:
    if path.endswith(".json"):
        raise ValueError("'path' ends with '*.json'")
    self.data = {}
    self.name = []
    for json_path in tqdm(glob(os.path.join(path, "*.json"))):
        name = json_path.replace(path, "").replace("/", "")
        self.data[name] = Json(json_path)
        self.name.append(name)

data `instance-attribute` ¶

data = {}

name `instance-attribute` ¶

name = []

getitem ¶

__getitem__(idx: int) -> Json

Index를 사용하여 JSON file에 접근

Parameters:

Name	Type	Description	Default
`idx`	`int`	입력 index	required

Returns:

Type	Description
`Json`	Index에 따른 `Json` instance

Source code in zerohertzLib/util/json.py

def __getitem__(self, idx: int) -> Json:
    """Index를 사용하여 JSON file에 접근

    Args:
        idx: 입력 index

    Returns:
        Index에 따른 `Json` instance
    """
    return self.data[self.name[idx]]

len ¶

__len__() -> int

JSON file의 길이를 반환

Returns:

Type	Description
`int`	읽어온 JSON file들의 수

Source code in zerohertzLib/util/json.py

def __len__(self) -> int:
    """JSON file의 길이를 반환

    Returns:
        읽어온 JSON file들의 수
    """
    return len(self.data)

_get_key ¶

_get_key(key: str) -> str

Key의 경로를 찾아주는 method

Parameters:

Name	Type	Description	Default
`key`	`str`	읽어온 JSON file에서 불러올 key 값 (깊이 무관)	required

Returns:

Type	Description
`str`	`/` 으로 깊이를 표시한 key 값

Source code in zerohertzLib/util/json.py

def _get_key(self, key: str) -> str:
    """
    Key의 경로를 찾아주는 method

    Args:
        key: 읽어온 JSON file에서 불러올 key 값 (깊이 무관)

    Returns:
        `/` 으로 깊이를 표시한 key 값
    """
    return self[0]._get_key(key)

tree ¶

tree() -> None

JSON의 구조를 출력하는 method

Examples:

>>> jsd.tree()
├── url
...
├── user
│   ├── login
...
│   └── site_admin
├── body
...
├── assignee
│   ├── login
...
│   └── site_admin
├── assignees
│   └── LIST
│       ├── login
...
│       └── site_admin
...
└── active_lock_reason

Source code in zerohertzLib/util/json.py

def tree(self) -> None:
    """JSON의 구조를 출력하는 method

    Examples:
        >>> jsd.tree()
        ├── url
        ...
        ├── user
        │   ├── login
        ...
        │   └── site_admin
        ├── body
        ...
        ├── assignee
        │   ├── login
        ...
        │   └── site_admin
        ├── assignees
        │   └── LIST
        │       ├── login
        ...
        │       └── site_admin
        ...
        └── active_lock_reason
    """
    self[0].tree()

unique ¶

unique(key: str) -> set[str]

읽어온 JSON data들의 유일한 값을 return하는 method

Parameters:

Name	Type	Description	Default
`key`	`str`	읽어온 JSON file에서 불러올 key 값	required

Returns:

Type	Description
`set[str]`	Key에 따른 유일한 값들의 집합

Examples:

>>> jsd.unique("label")
{'Zerohertz:docs', 'Zerohertz:dev-v0.2.3', 'Zerohertz:docs-v0.2.2'}
>>> jsd.unique("sha")
{'dfd53a0bfc73221dbe96d5e44a49c524d5a8596b', 'bc33235424e89cbbf23434b2a824ea068d167c7d', '97f52f9b81ba885fe69b9726632e580f5cba94be', '768c7711f94af0be00cd55e0ce7b892465cfa64a', '97e103788359f0361f4ec0e138a14218f28eddd4'}

Source code in zerohertzLib/util/json.py

def unique(self, key: str) -> set[str]:
    """읽어온 JSON data들의 유일한 값을 return하는 method

    Args:
        key: 읽어온 JSON file에서 불러올 key 값

    Returns:
        Key에 따른 유일한 값들의 집합

    Examples:
        >>> jsd.unique("label")
        {'Zerohertz:docs', 'Zerohertz:dev-v0.2.3', 'Zerohertz:docs-v0.2.2'}
        >>> jsd.unique("sha")
        {'dfd53a0bfc73221dbe96d5e44a49c524d5a8596b', 'bc33235424e89cbbf23434b2a824ea068d167c7d', '97f52f9b81ba885fe69b9726632e580f5cba94be', '768c7711f94af0be00cd55e0ce7b892465cfa64a', '97e103788359f0361f4ec0e138a14218f28eddd4'}
    """
    key = self._get_key(key)
    uniq = set()
    for json_instance in self:
        data = json_instance._get_value(key)
        uniq.add(str(data))
    return uniq

write_json ¶

write_json(data: dict[Any, Any] | list[dict[Any, Any]], path: str) -> str

JSON (JavaScript Object Notation)을 작성하는 function

Parameters:

Name	Type	Description	Default
`data`	`dict[Any, Any] \| list[dict[Any, Any]]`	입력 data (header 포함 무관)	required
`path`	`str`	출력될 JSON file의 경로 및 이름	required

Returns:

Type	Description
`str`	File의 절대 경로

Examples:

>>> zz.util.write_json([{"id": "4169", "전투력": 4209, "정보": ["아무", "거나"]}]*100, "zerohertzLib/star_craft")
'/.../star_craft.json'
[
    {
        "id": "4169",
        "전투력": 4209,
        "정보": [
            "아무",
            "거나"
        ]
    },
    {
        "id": "4169",
        "전투력": 4209,
        "정보": [
            "아무",
            "거나"
        ]
    },
...

Source code in zerohertzLib/util/json.py

def write_json(data: dict[Any, Any] | list[dict[Any, Any]], path: str) -> str:
    """JSON (JavaScript Object Notation)을 작성하는 function

    Args:
        data: 입력 data (header 포함 무관)
        path: 출력될 JSON file의 경로 및 이름

    Returns:
        File의 절대 경로

    Examples:
        >>> zz.util.write_json([{"id": "4169", "전투력": 4209, "정보": ["아무", "거나"]}]*100, "zerohertzLib/star_craft")
        '/.../star_craft.json'
        [
            {
                "id": "4169",
                "전투력": 4209,
                "정보": [
                    "아무",
                    "거나"
                ]
            },
            {
                "id": "4169",
                "전투력": 4209,
                "정보": [
                    "아무",
                    "거나"
                ]
            },
        ...
    """
    with open(f"{path}.json", "wb") as file:
        file.write(orjson.dumps(data, option=orjson.OPT_INDENT_2))
    return os.path.abspath(f"{path}.json")

zerohertzLib.util.json ¶

Json ¶

data instance-attribute ¶

keys instance-attribute ¶

map instance-attribute ¶

name instance-attribute ¶

__get_keys ¶

__getitem__ ¶

__len__ ¶

_get_key ¶

_get_keys ¶

_get_value ¶

get ¶

tree ¶

JsonDir ¶

data instance-attribute ¶

name instance-attribute ¶

__getitem__ ¶

__len__ ¶

_get_key ¶

tree ¶

unique ¶

write_json ¶

data `instance-attribute` ¶

keys `instance-attribute` ¶

map `instance-attribute` ¶

name `instance-attribute` ¶

getitem ¶

len ¶

data `instance-attribute` ¶

name `instance-attribute` ¶

getitem ¶

len ¶