# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022) # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import json from typing import TYPE_CHECKING, Any, List, Union, cast from streamlit.proto.Json_pb2 import Json as JsonProto from streamlit.runtime.metrics_util import gather_metrics from streamlit.runtime.state import SessionStateProxy from streamlit.user_info import UserInfoProxy if TYPE_CHECKING: from streamlit.delta_generator import DeltaGenerator def _ensure_serialization(o: object) -> Union[str, List[Any]]: """A repr function for json.dumps default arg, which tries to serialize sets as lists""" if isinstance(o, set): return list(o) return repr(o) class JsonMixin: @gather_metrics("json") def json( self, body: object, *, # keyword-only arguments: expanded: bool = True, ) -> "DeltaGenerator": """Display object or string as a pretty-printed JSON string. Parameters ---------- body : object or str The object to print as JSON. All referenced objects should be serializable to JSON as well. If object is a string, we assume it contains serialized JSON. expanded : bool An optional boolean that allows the user to set whether the initial state of this json element should be expanded. Defaults to True. This argument can only be supplied by keyword. Example ------- >>> import streamlit as st >>> >>> st.json({ ... 'foo': 'bar', ... 'baz': 'boz', ... 'stuff': [ ... 'stuff 1', ... 'stuff 2', ... 'stuff 3', ... 'stuff 5', ... ], ... }) .. output:: https://doc-json.streamlitapp.com/ height: 385px """ import streamlit as st if isinstance(body, (SessionStateProxy, UserInfoProxy)): body = body.to_dict() if not isinstance(body, str): try: # Serialize body to string and try to interpret sets as lists body = json.dumps(body, default=_ensure_serialization) except TypeError as err: st.warning( "Warning: this data structure was not fully serializable as " f"JSON due to one or more unexpected keys. (Error was: {err})" ) body = json.dumps(body, skipkeys=True, default=_ensure_serialization) json_proto = JsonProto() json_proto.body = body json_proto.expanded = expanded return self.dg._enqueue("json", json_proto) @property def dg(self) -> "DeltaGenerator": """Get our DeltaGenerator.""" return cast("DeltaGenerator", self)