pip._vendor.rich.json.JSON Class Reference

Public Member Functions
None	__init__ (self, str json, Union[None, int, str] indent=2, bool highlight=True, bool skip_keys=False, bool ensure_ascii=False, bool check_circular=True, bool allow_nan=True, Optional[Callable[[Any], Any]] default=None, bool sort_keys=False)
"JSON"	from_data (cls, Any data, Union[None, int, str] indent=2, bool highlight=True, bool skip_keys=False, bool ensure_ascii=False, bool check_circular=True, bool allow_nan=True, Optional[Callable[[Any], Any]] default=None, bool sort_keys=False)
Text	__rich__ (self)

Public Attributes
	text

Detailed Description

A renderable which pretty prints JSON.

Args:
    json (str): JSON encoded data.
    indent (Union[None, int, str], optional): Number of characters to indent by. Defaults to 2.
    highlight (bool, optional): Enable highlighting. Defaults to True.
    skip_keys (bool, optional): Skip keys not of a basic type. Defaults to False.
    ensure_ascii (bool, optional): Escape all non-ascii characters. Defaults to False.
    check_circular (bool, optional): Check for circular references. Defaults to True.
    allow_nan (bool, optional): Allow NaN and Infinity values. Defaults to True.
    default (Callable, optional): A callable that converts values that can not be encoded
        in to something that can be JSON encoded. Defaults to None.
    sort_keys (bool, optional): Sort dictionary keys. Defaults to False.

Member Function Documentation

from_data()

"JSON" pip._vendor.rich.json.JSON.from_data	(		cls,
		Any	data,
		Union[None, int, str]	indent = 2,
		bool	highlight = True,
		bool	skip_keys = False,
		bool	ensure_ascii = False,
		bool	check_circular = True,
		bool	allow_nan = True,
		Optional[Callable[[Any], Any]]	default = None,
		bool	sort_keys = False
	)

Encodes a JSON object from arbitrary data.

Args:
    data (Any): An object that may be encoded in to JSON
    indent (Union[None, int, str], optional): Number of characters to indent by. Defaults to 2.
    highlight (bool, optional): Enable highlighting. Defaults to True.
    default (Callable, optional): Optional callable which will be called for objects that cannot be serialized. Defaults to None.
    skip_keys (bool, optional): Skip keys not of a basic type. Defaults to False.
    ensure_ascii (bool, optional): Escape all non-ascii characters. Defaults to False.
    check_circular (bool, optional): Check for circular references. Defaults to True.
    allow_nan (bool, optional): Allow NaN and Infinity values. Defaults to True.
    default (Callable, optional): A callable that converts values that can not be encoded
        in to something that can be JSON encoded. Defaults to None.
    sort_keys (bool, optional): Sort dictionary keys. Defaults to False.

Returns:
    JSON: New JSON object from the given data.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/json.py