mirror of
https://github.com/home-assistant/core.git
synced 2025-12-23 12:29:55 +00:00
e5861241c7
* Addded support for private storage. Include 'private' flag parameters to the Store class and save_json function. Updated various authentication and onboarding classes to use private stores. Fixed unit test for emulated_hue which used a mock patch on save_json(). * Fixed Hound formatting issues not detected by local linting.
62 lines
1.9 KiB
Python
62 lines
1.9 KiB
Python
"""JSON utility functions."""
|
|
import logging
|
|
from typing import Union, List, Dict
|
|
|
|
import json
|
|
import os
|
|
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class SerializationError(HomeAssistantError):
|
|
"""Error serializing the data to JSON."""
|
|
|
|
|
|
class WriteError(HomeAssistantError):
|
|
"""Error writing the data."""
|
|
|
|
|
|
def load_json(filename: str, default: Union[List, Dict, None] = None) \
|
|
-> Union[List, Dict]:
|
|
"""Load JSON data from a file and return as dict or list.
|
|
|
|
Defaults to returning empty dict if file is not found.
|
|
"""
|
|
try:
|
|
with open(filename, encoding='utf-8') as fdesc:
|
|
return json.loads(fdesc.read()) # type: ignore
|
|
except FileNotFoundError:
|
|
# This is not a fatal error
|
|
_LOGGER.debug('JSON file not found: %s', filename)
|
|
except ValueError as error:
|
|
_LOGGER.exception('Could not parse JSON content: %s', filename)
|
|
raise HomeAssistantError(error)
|
|
except OSError as error:
|
|
_LOGGER.exception('JSON file reading failed: %s', filename)
|
|
raise HomeAssistantError(error)
|
|
return {} if default is None else default
|
|
|
|
|
|
def save_json(filename: str, data: Union[List, Dict],
|
|
private: bool = False) -> None:
|
|
"""Save JSON data to a file.
|
|
|
|
Returns True on success.
|
|
"""
|
|
try:
|
|
json_data = json.dumps(data, sort_keys=True, indent=4)
|
|
mode = 0o600 if private else 0o644
|
|
with open(os.open(filename, os.O_WRONLY | os.O_CREAT, mode),
|
|
'w', encoding='utf-8') as fdesc:
|
|
fdesc.write(json_data)
|
|
except TypeError as error:
|
|
_LOGGER.exception('Failed to serialize to JSON: %s',
|
|
filename)
|
|
raise SerializationError(error)
|
|
except OSError as error:
|
|
_LOGGER.exception('Saving JSON file failed: %s',
|
|
filename)
|
|
raise WriteError(error)
|