Flask-Ujson

https://flask-ujson.readthedocs.io
Admin
Flask-Ujson is a Flask/Quart JSONProvider that uses the fast ujson library to significantly speed up...
Tokens:1,200
Snippets:12
Trust Score:8.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Initialize Flask-ujson Provider

Source: https://flask-ujson.readthedocs.io/en/latest

This snippet demonstrates how to initialize the UjsonProvider for a Flask application. It requires importing Flask and UjsonProvider, creating a Flask app instance, instantiating the provider with the app, and then assigning the provider to the app's JSON attribute. This setup enables faster JSON handling within the Flask application.

```python
from flask import Flask
from flask_ujson import UjsonProvider

app = Flask(__name__)
json_provider = UjsonProvider(app)
app.json = json_provider

```

--------------------------------

### Get flask-ujson version

Source: https://flask-ujson.readthedocs.io/en/latest/changes

Shows how to retrieve the installed version of the flask-ujson library using the `importlib.metadata` module. This replaces the removed `__version__` attribute.

```python
import importlib.metadata

version = importlib.metadata.version('flask-ujson')
print(version)

```

--------------------------------

### UjsonProvider Initialization in Flask

Source: https://flask-ujson.readthedocs.io/en/latest/api

Demonstrates how to initialize the UjsonProvider for a Flask application. This class acts as a JSON provider, leveraging the ujson library for faster JSON processing compared to the default Flask JSON handler. It takes the Flask application instance as an argument.

```python
from flask import Flask
from flask_ujson import UjsonProvider

app = Flask(__name__)
app.json = UjsonProvider(app)

# Now use app.json.dumps() and app.json.loads()

```

--------------------------------

### Set ujson.dumps arguments with dump_args

Source: https://flask-ujson.readthedocs.io/en/latest/changes

Illustrates how to configure default keyword arguments for `ujson.dumps` using the `dump_args` attribute of `UjsonProvider`. This allows for customization of serialization behavior, such as sorting keys or compact output.

```python
from flask_ujson import UjsonProvider

app.json = UjsonProvider(app, dump_args={'sort_keys': True, 'compact': True})

```

--------------------------------

### Configure flask-ujson with UjsonProvider

Source: https://flask-ujson.readthedocs.io/en/latest/changes

Demonstrates how to configure flask-ujson in a Flask application using the UjsonProvider. This method replaces the deprecated UJSON extension class. Keyword arguments passed to `dumps` will override default arguments set in `dump_args`.

```python
from flask_ujson import UjsonProvider

app.json = UjsonProvider(app)

```

--------------------------------

### UjsonProvider.dumps() Method for JSON Serialization

Source: https://flask-ujson.readthedocs.io/en/latest/api

This method serializes a Python object into a JSON string using the ujson library. It accepts the object to serialize and optional keyword arguments that are passed directly to `ujson.dumps`. Default arguments can be configured via `dump_args` on the provider instance.

```python
from flask import Flask
from flask_ujson import UjsonProvider

app = Flask(__name__)
app.json = UjsonProvider(app)

data = {"key": "value", "number": 123}
json_string = app.json.dumps(data)
print(json_string)
# Example with custom arguments overriding defaults
json_string_pretty = app.json.dumps(data, indent=2)
print(json_string_pretty)

```

--------------------------------

### UjsonProvider.loads() Method for JSON Deserialization

Source: https://flask-ujson.readthedocs.io/en/latest/api

This method deserializes a JSON string or bytes into a Python object using the ujson library. It accepts the JSON string/bytes as input and ignores any additional keyword arguments, simplifying the deserialization process. It is designed to be robust with various JSON inputs.

```python
from flask import Flask
from flask_ujson import UjsonProvider

app = Flask(__name__)
app.json = UjsonProvider(app)

json_string = '{"key": "value", "number": 123}'
python_object = app.json.loads(json_string)
print(python_object)

# Example with bytes input
json_bytes = b'{"key": "value", "number": 123}'
python_object_from_bytes = app.json.loads(json_bytes)
print(python_object_from_bytes)

```
Tokens:
Raw