mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
89 lines
2.8 KiB
Python
89 lines
2.8 KiB
Python
"""Functions for disk IO."""
|
|
from __future__ import annotations
|
|
|
|
import io
|
|
import json
|
|
import os
|
|
import typing as t
|
|
|
|
from .encoding import (
|
|
ENCODING,
|
|
to_bytes,
|
|
to_text,
|
|
)
|
|
|
|
|
|
def read_json_file(path: str) -> t.Any:
|
|
"""Parse and return the json content from the specified path."""
|
|
return json.loads(read_text_file(path))
|
|
|
|
|
|
def read_text_file(path: str) -> str:
|
|
"""Return the contents of the specified path as text."""
|
|
return to_text(read_binary_file(path))
|
|
|
|
|
|
def read_binary_file(path: str) -> bytes:
|
|
"""Return the contents of the specified path as bytes."""
|
|
with open_binary_file(path) as file_obj:
|
|
return file_obj.read()
|
|
|
|
|
|
def make_dirs(path: str) -> None:
|
|
"""Create a directory at path, including any necessary parent directories."""
|
|
os.makedirs(to_bytes(path), exist_ok=True)
|
|
|
|
|
|
def write_json_file(path: str,
|
|
content: t.Any,
|
|
create_directories: bool = False,
|
|
formatted: bool = True,
|
|
encoder: t.Optional[t.Type[json.JSONEncoder]] = None,
|
|
) -> str:
|
|
"""Write the given json content to the specified path, optionally creating missing directories."""
|
|
text_content = json.dumps(content,
|
|
sort_keys=formatted,
|
|
indent=4 if formatted else None,
|
|
separators=(', ', ': ') if formatted else (',', ':'),
|
|
cls=encoder,
|
|
) + '\n'
|
|
|
|
write_text_file(path, text_content, create_directories=create_directories)
|
|
|
|
return text_content
|
|
|
|
|
|
def write_text_file(path: str, content: str, create_directories: bool = False) -> None:
|
|
"""Write the given text content to the specified path, optionally creating missing directories."""
|
|
if create_directories:
|
|
make_dirs(os.path.dirname(path))
|
|
|
|
with open_binary_file(path, 'wb') as file_obj:
|
|
file_obj.write(to_bytes(content))
|
|
|
|
|
|
def open_text_file(path: str, mode: str = 'r') -> t.IO[str]:
|
|
"""Open the given path for text access."""
|
|
if 'b' in mode:
|
|
raise Exception('mode cannot include "b" for text files: %s' % mode)
|
|
|
|
return io.open(to_bytes(path), mode, encoding=ENCODING) # pylint: disable=consider-using-with
|
|
|
|
|
|
def open_binary_file(path: str, mode: str = 'rb') -> t.IO[bytes]:
|
|
"""Open the given path for binary access."""
|
|
if 'b' not in mode:
|
|
raise Exception('mode must include "b" for binary files: %s' % mode)
|
|
|
|
return io.open(to_bytes(path), mode) # pylint: disable=consider-using-with
|
|
|
|
|
|
class SortedSetEncoder(json.JSONEncoder):
|
|
"""Encode sets as sorted lists."""
|
|
def default(self, o):
|
|
"""Return a serialized version of the `o` object."""
|
|
if isinstance(o, set):
|
|
return sorted(o)
|
|
|
|
return json.JSONEncoder.default(self, o)
|