2022-05-23 00:16:32 +04:00

86 lines
2.7 KiB
Python

# Copyright 2018-2022 Streamlit Inc.
#
# 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 cast
import streamlit
from streamlit.proto.Json_pb2 import Json as JsonProto
from streamlit.state import SessionStateProxy
class JsonMixin:
def json(
self,
body,
*, # keyword-only arguments:
expanded=True,
):
"""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
-------
>>> st.json({
... 'foo': 'bar',
... 'baz': 'boz',
... 'stuff': [
... 'stuff 1',
... 'stuff 2',
... 'stuff 3',
... 'stuff 5',
... ],
... })
.. output::
https://share.streamlit.io/streamlit/docs/main/python/api-examples-source/data.json.py
height: 385px
"""
import streamlit as st
if isinstance(body, SessionStateProxy):
body = body.to_dict()
if not isinstance(body, str):
try:
body = json.dumps(body, default=repr)
except TypeError as err:
st.warning(
"Warning: this data structure was not fully serializable as "
"JSON due to one or more unexpected keys. (Error was: %s)" % err
)
body = json.dumps(body, skipkeys=True, default=repr)
json_proto = JsonProto()
json_proto.body = body
json_proto.expanded = expanded
return self.dg._enqueue("json", json_proto)
@property
def dg(self) -> "streamlit.delta_generator.DeltaGenerator":
"""Get our DeltaGenerator."""
return cast("streamlit.delta_generator.DeltaGenerator", self)