Skip to content

Configure black to lint Jupyter notebooks #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkmkme merged 2 commits into from
Mar 28, 2026
Merged

Configure black to lint Jupyter notebooks #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff3de4f
Configure black to lint Jupyter notebooks
kurtmckee Mar 4, 2026
d776cfa
Apply black formatting to `docs/`
kurtmckee Mar 28, 2026
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
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ build-docs docs: .check-virtualenv

linters: .check-virtualenv
flake8 tests valkey
black --target-version py37 --check --diff tests valkey
black --target-version py37 --check --diff docs tests valkey
isort --check-only --diff tests valkey
vulture valkey whitelist.py --min-confidence 80
flynt --fail-on-change --dry-run tests valkey
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = {'.rst': 'restructuredtext'}
source_suffix = {".rst": "restructuredtext"}

# The encoding of source files.
# source_encoding = 'utf-8-sig'
Expand Down
17 changes: 12 additions & 5 deletions docs/examples/asyncio_examples.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
"\n",
"r = await valkey.from_url(\"valkey://localhost\")\n",
"async with r.pipeline(transaction=True) as pipe:\n",
" ok1, ok2 = await (pipe.set(\"key1\", \"value1\").set(\"key2\", \"value2\").execute())\n",
" ok1, ok2 = await pipe.set(\"key1\", \"value1\").set(\"key2\", \"value2\").execute()\n",
"assert ok1\n",
"assert ok2"
]
Expand Down Expand Up @@ -201,13 +201,16 @@
"\n",
"async def reader(channel: valkey.client.PubSub):\n",
" while True:\n",
" message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n",
" message = await channel.get_message(\n",
" ignore_subscribe_messages=True, timeout=None\n",
" )\n",
" if message is not None:\n",
" print(f\"(Reader) Message Received: {message}\")\n",
" if message[\"data\"].decode() == STOPWORD:\n",
" print(\"(Reader) STOP\")\n",
" break\n",
"\n",
"\n",
"r = valkey.from_url(\"valkey://localhost\")\n",
"async with r.pubsub() as pubsub:\n",
" await pubsub.subscribe(\"channel:1\", \"channel:2\")\n",
Expand Down Expand Up @@ -264,7 +267,9 @@
"\n",
"async def reader(channel: valkey.client.PubSub):\n",
" while True:\n",
" message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n",
" message = await channel.get_message(\n",
" ignore_subscribe_messages=True, timeout=None\n",
" )\n",
" if message is not None:\n",
" print(f\"(Reader) Message Received: {message}\")\n",
" if message[\"data\"].decode() == STOPWORD:\n",
Expand Down Expand Up @@ -318,7 +323,6 @@
"\n",
"from valkey.asyncio.sentinel import Sentinel\n",
"\n",
"\n",
"sentinel = Sentinel([(\"localhost\", 26379), (\"sentinel2\", 26379)])\n",
"r = sentinel.master_for(\"mymaster\")\n",
"\n",
Expand Down Expand Up @@ -359,6 +363,7 @@
],
"source": [
"import valkey.asyncio as valkey\n",
"\n",
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True\")\n",
"url_connection.ping()"
]
Expand All @@ -378,7 +383,9 @@
"source": [
"import valkey.asyncio as valkey\n",
"\n",
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True&protocol=3\")\n",
"url_connection = valkey.from_url(\n",
" \"valkey://localhost:6379?decode_responses=True&protocol=3\"\n",
")\n",
"url_connection.ping()"
]
}
Expand Down
66 changes: 48 additions & 18 deletions docs/examples/connection_examples.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,13 @@
"source": [
"import valkey\n",
"\n",
"user_connection = valkey.Valkey(host='localhost', port=6380, username='dvora', password='valkey', decode_responses=True)\n",
"user_connection = valkey.Valkey(\n",
" host=\"localhost\",\n",
" port=6380,\n",
" username=\"dvora\",\n",
" password=\"valkey\",\n",
" decode_responses=True,\n",
")\n",
"user_connection.ping()"
]
},
Expand All @@ -132,7 +138,9 @@
"import valkey\n",
"\n",
"creds_provider = valkey.UsernamePasswordCredentialProvider(\"username\", \"password\")\n",
"user_connection = valkey.Valkey(host=\"localhost\", port=6379, credential_provider=creds_provider)\n",
"user_connection = valkey.Valkey(\n",
" host=\"localhost\", port=6379, credential_provider=creds_provider\n",
")\n",
"user_connection.ping()"
]
},
Expand All @@ -152,8 +160,8 @@
"from typing import Tuple\n",
"import valkey\n",
"\n",
"creds_map = {\"user_1\": \"pass_1\",\n",
" \"user_2\": \"pass_2\"}\n",
"creds_map = {\"user_1\": \"pass_1\", \"user_2\": \"pass_2\"}\n",
"\n",
"\n",
"class UserMapCredentialProvider(valkey.CredentialProvider):\n",
" def __init__(self, username: str):\n",
Expand All @@ -162,6 +170,7 @@
" def get_credentials(self) -> Tuple[str, str]:\n",
" return self.username, creds_map.get(self.username)\n",
"\n",
"\n",
"# Create a default connection to set the ACL user\n",
"default_connection = valkey.Valkey(host=\"localhost\", port=6379)\n",
"default_connection.acl_setuser(\n",
Expand All @@ -175,8 +184,9 @@
"# Create a UserMapCredentialProvider instance for user_1\n",
"creds_provider = UserMapCredentialProvider(\"user_1\")\n",
"# Initiate user connection with the credential provider\n",
"user_connection = valkey.Valkey(host=\"localhost\", port=6379,\n",
" credential_provider=creds_provider)\n",
"user_connection = valkey.Valkey(\n",
" host=\"localhost\", port=6379, credential_provider=creds_provider\n",
")\n",
"user_connection.ping()"
]
},
Expand All @@ -196,6 +206,7 @@
"from typing import Union\n",
"import valkey\n",
"\n",
"\n",
"class InitCredsSetCredentialProvider(valkey.CredentialProvider):\n",
" def __init__(self, username, password):\n",
" self.username = username\n",
Expand All @@ -213,7 +224,10 @@
" self.call_supplier = True\n",
" return self.username, self.password\n",
"\n",
"cred_provider = InitCredsSetCredentialProvider(username=\"init_user\", password=\"init_pass\")"
"\n",
"cred_provider = InitCredsSetCredentialProvider(\n",
" username=\"init_user\", password=\"init_pass\"\n",
")"
]
},
{
Expand Down Expand Up @@ -241,24 +255,31 @@
"import json\n",
"import cachetools.func\n",
"\n",
"\n",
"class SecretsManagerProvider(valkey.CredentialProvider):\n",
" def __init__(self, secret_id, version_id=None, version_stage='AWSCURRENT'):\n",
" self.sm_client = boto3.client('secretsmanager')\n",
" def __init__(self, secret_id, version_id=None, version_stage=\"AWSCURRENT\"):\n",
" self.sm_client = boto3.client(\"secretsmanager\")\n",
" self.secret_id = secret_id\n",
" self.version_id = version_id\n",
" self.version_stage = version_stage\n",
"\n",
" def get_credentials(self) -> Union[Tuple[str], Tuple[str, str]]:\n",
" @cachetools.func.ttl_cache(maxsize=128, ttl=24 * 60 * 60) #24h\n",
" @cachetools.func.ttl_cache(maxsize=128, ttl=24 * 60 * 60) # 24h\n",
" def get_sm_user_credentials(secret_id, version_id, version_stage):\n",
" secret = self.sm_client.get_secret_value(secret_id, version_id)\n",
" return json.loads(secret['SecretString'])\n",
" creds = get_sm_user_credentials(self.secret_id, self.version_id, self.version_stage)\n",
" return creds['username'], creds['password']\n",
" return json.loads(secret[\"SecretString\"])\n",
"\n",
" creds = get_sm_user_credentials(\n",
" self.secret_id, self.version_id, self.version_stage\n",
" )\n",
" return creds[\"username\"], creds[\"password\"]\n",
"\n",
"\n",
"my_secret_id = \"EXAMPLE1-90ab-cdef-fedc-ba987SECRET1\"\n",
"creds_provider = SecretsManagerProvider(secret_id=my_secret_id)\n",
"user_connection = valkey.Valkey(host=\"localhost\", port=6379, credential_provider=creds_provider)\n",
"user_connection = valkey.Valkey(\n",
" host=\"localhost\", port=6379, credential_provider=creds_provider\n",
")\n",
"user_connection.ping()"
]
},
Expand Down Expand Up @@ -295,6 +316,7 @@
"from botocore.signers import RequestSigner\n",
"from cachetools import TTLCache, cached\n",
"\n",
"\n",
"class ElastiCacheIAMProvider(valkey.CredentialProvider):\n",
" def __init__(self, user, cluster_name, region=\"us-east-1\"):\n",
" self.user = user\n",
Expand Down Expand Up @@ -336,11 +358,14 @@
" # So strip it off the signed URL before returning\n",
" return (self.user, signed_url.removeprefix(\"https://\"))\n",
"\n",
"\n",
"username = \"barshaul\"\n",
"cluster_name = \"test-001\"\n",
"endpoint = \"test-001.use1.cache.amazonaws.com\"\n",
"creds_provider = ElastiCacheIAMProvider(user=username, cluster_name=cluster_name)\n",
"user_connection = valkey.Valkey(host=endpoint, port=6379, credential_provider=creds_provider)\n",
"user_connection = valkey.Valkey(\n",
" host=endpoint, port=6379, credential_provider=creds_provider\n",
")\n",
"user_connection.ping()"
]
},
Expand Down Expand Up @@ -375,7 +400,9 @@
}
],
"source": [
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True&health_check_interval=2\")\n",
"url_connection = valkey.from_url(\n",
" \"valkey://localhost:6379?decode_responses=True&health_check_interval=2\"\n",
")\n",
"url_connection.ping()"
]
},
Expand All @@ -392,7 +419,9 @@
"metadata": {},
"outputs": [],
"source": [
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True&health_check_interval=2&protocol=3\")\n",
"url_connection = valkey.from_url(\n",
" \"valkey://localhost:6379?decode_responses=True&health_check_interval=2&protocol=3\"\n",
")\n",
"url_connection.ping()"
]
},
Expand All @@ -410,7 +439,8 @@
"outputs": [],
"source": [
"from valkey.sentinel import Sentinel\n",
"sentinel = Sentinel([('localhost', 26379)], socket_timeout=0.1)\n",
"\n",
"sentinel = Sentinel([(\"localhost\", 26379)], socket_timeout=0.1)\n",
"sentinel.discover_master(\"valkey-py-test\")"
]
}
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/pipeline_examples.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
}
],
"source": [
"import valkey \n",
"import valkey\n",
"\n",
"r = valkey.Valkey(decode_responses=True)\n",
"r.ping()"
Expand Down
33 changes: 20 additions & 13 deletions docs/examples/search_json_examples.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,48 +33,53 @@
"from valkey.commands.search.indexDefinition import IndexDefinition, IndexType\n",
"from valkey.commands.search.query import NumericFilter, Query\n",
"\n",
"\n",
"r = valkey.Valkey(host='localhost', port=6379)\n",
"r = valkey.Valkey(host=\"localhost\", port=6379)\n",
"user1 = {\n",
" \"user\":{\n",
" \"user\": {\n",
" \"name\": \"Paul John\",\n",
" \"email\": \"paul.john@example.com\",\n",
" \"age\": 42,\n",
" \"city\": \"London\"\n",
" \"city\": \"London\",\n",
" }\n",
"}\n",
"user2 = {\n",
" \"user\":{\n",
" \"user\": {\n",
" \"name\": \"Eden Zamir\",\n",
" \"email\": \"eden.zamir@example.com\",\n",
" \"age\": 29,\n",
" \"city\": \"Tel Aviv\"\n",
" \"city\": \"Tel Aviv\",\n",
" }\n",
"}\n",
"user3 = {\n",
" \"user\":{\n",
" \"user\": {\n",
" \"name\": \"Paul Zamir\",\n",
" \"email\": \"paul.zamir@example.com\",\n",
" \"age\": 35,\n",
" \"city\": \"Tel Aviv\"\n",
" \"city\": \"Tel Aviv\",\n",
" }\n",
"}\n",
"\n",
"user4 = {\n",
" \"user\":{\n",
" \"user\": {\n",
" \"name\": \"Sarah Zamir\",\n",
" \"email\": \"sarah.zamir@example.com\",\n",
" \"age\": 30,\n",
" \"city\": \"Paris\"\n",
" \"city\": \"Paris\",\n",
" }\n",
"}\n",
"r.json().set(\"user:1\", Path.root_path(), user1)\n",
"r.json().set(\"user:2\", Path.root_path(), user2)\n",
"r.json().set(\"user:3\", Path.root_path(), user3)\n",
"r.json().set(\"user:4\", Path.root_path(), user4)\n",
"\n",
"schema = (TextField(\"$.user.name\", as_name=\"name\"),TagField(\"$.user.city\", as_name=\"city\"), NumericField(\"$.user.age\", as_name=\"age\"))\n",
"r.ft().create_index(schema, definition=IndexDefinition(prefix=[\"user:\"], index_type=IndexType.JSON))"
"schema = (\n",
" TextField(\"$.user.name\", as_name=\"name\"),\n",
" TagField(\"$.user.city\", as_name=\"city\"),\n",
" NumericField(\"$.user.age\", as_name=\"age\"),\n",
")\n",
"r.ft().create_index(\n",
" schema, definition=IndexDefinition(prefix=[\"user:\"], index_type=IndexType.JSON)\n",
")"
]
},
{
Expand Down Expand Up @@ -167,7 +172,9 @@
"# Search for all users, returning 2 users at a time and sorting by age in descending order\n",
"offset = 0\n",
"num = 2\n",
"q = Query(\"*\").paging(offset, num).sort_by(\"age\", asc=False) # pass asc=True to sort in ascending order\n",
"q = (\n",
" Query(\"*\").paging(offset, num).sort_by(\"age\", asc=False)\n",
") # pass asc=True to sort in ascending order\n",
"r.ft().search(q)"
]
},
Expand Down
Loading
Loading