Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions redis/commands/json/commands.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import os
from json import JSONDecodeError, loads

from deprecated import deprecated

from redis.exceptions import DataError
Expand Down Expand Up @@ -213,6 +216,54 @@ def set(self, name, path, obj, nx=False, xx=False, decode_keys=False):
pieces.append("XX")
return self.execute_command("JSON.SET", *pieces)

def set_file(self, name, path, file_name, nx=False, xx=False, decode_keys=False):
"""
Set the JSON value at key ``name`` under the ``path`` to the content
of the json file ``file_name``.

``nx`` if set to True, set ``value`` only if it does not exist.
``xx`` if set to True, set ``value`` only if it exists.
``decode_keys`` If set to True, the keys of ``obj`` will be decoded
with utf-8.

"""

with open(file_name, "r") as fp:
file_content = loads(fp.read())

return self.set(name, path, file_content, nx=nx, xx=xx, decode_keys=decode_keys)

def set_path(self, json_path, root_folder, nx=False, xx=False, decode_keys=False):
"""
Iterate over ``root_folder`` and set each JSON file to a value
under ``json_path`` with the file name as the key.

``nx`` if set to True, set ``value`` only if it does not exist.
``xx`` if set to True, set ``value`` only if it exists.
``decode_keys`` If set to True, the keys of ``obj`` will be decoded
with utf-8.

"""
set_files_result = {}
for root, dirs, files in os.walk(root_folder):
for file in files:
file_path = os.path.join(root, file)
try:
file_name = file_path.rsplit(".")[0]
self.set_file(
file_name,
json_path,
file_path,
nx=nx,
xx=xx,
decode_keys=decode_keys,
)
set_files_result[file_path] = True
except JSONDecodeError:
set_files_result[file_path] = False

return set_files_result

def strlen(self, name, path=None):
"""Return the length of the string JSON value under ``path`` at key
``name``.
Expand Down
39 changes: 39 additions & 0 deletions tests/test_json.py
Original file line number Diff line number Diff line change
Expand Up @@ -1392,3 +1392,42 @@ def test_custom_decoder(client):
assert client.exists("foo") == 0
assert not isinstance(cj.__encoder__, json.JSONEncoder)
assert not isinstance(cj.__decoder__, json.JSONDecoder)


@pytest.mark.redismod
def test_set_file(client):
import json
import tempfile

obj = {"hello": "world"}
jsonfile = tempfile.NamedTemporaryFile(suffix=".json")
with open(jsonfile.name, "w+") as fp:
fp.write(json.dumps(obj))

nojsonfile = tempfile.NamedTemporaryFile()
nojsonfile.write(b"Hello World")

assert client.json().set_file("test", Path.rootPath(), jsonfile.name)
assert client.json().get("test") == obj
with pytest.raises(json.JSONDecodeError):
client.json().set_file("test2", Path.rootPath(), nojsonfile.name)


@pytest.mark.redismod
def test_set_path(client):
import json
import tempfile

root = tempfile.mkdtemp()
sub = tempfile.mkdtemp(dir=root)
jsonfile = tempfile.mktemp(suffix=".json", dir=sub)
nojsonfile = tempfile.mktemp(dir=root)

with open(jsonfile, "w+") as fp:
fp.write(json.dumps({"hello": "world"}))
open(nojsonfile, "a+").write("hello")

result = {jsonfile: True, nojsonfile: False}
print(result)
assert client.json().set_path(Path.rootPath(), root) == result
assert client.json().get(jsonfile.rsplit(".")[0]) == {"hello": "world"}