Skip to content

Commit 062ba2a

Browse files
kurtmckeekurtmckee
committed
Apply black formatting to docs/
Signed-off-by: Kurt McKee <contactme@kurtmckee.org>
1 parent 81962ca commit 062ba2a

10 files changed

+247
-176
lines changed

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
templates_path = ["_templates"]
5656

5757
# The suffix of source filenames.
58-
source_suffix = {'.rst': 'restructuredtext'}
58+
source_suffix = {".rst": "restructuredtext"}
5959

6060
# The encoding of source files.
6161
# source_encoding = 'utf-8-sig'

‎docs/examples/asyncio_examples.ipynb‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
"\n",
152152
"r = await valkey.from_url(\"valkey://localhost\")\n",
153153
"async with r.pipeline(transaction=True) as pipe:\n",
154-
" ok1, ok2 = await (pipe.set(\"key1\", \"value1\").set(\"key2\", \"value2\").execute())\n",
154+
" ok1, ok2 = await pipe.set(\"key1\", \"value1\").set(\"key2\", \"value2\").execute()\n",
155155
"assert ok1\n",
156156
"assert ok2"
157157
]
@@ -201,13 +201,16 @@
201201
"\n",
202202
"async def reader(channel: valkey.client.PubSub):\n",
203203
" while True:\n",
204-
" message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n",
204+
" message = await channel.get_message(\n",
205+
" ignore_subscribe_messages=True, timeout=None\n",
206+
" )\n",
205207
" if message is not None:\n",
206208
" print(f\"(Reader) Message Received: {message}\")\n",
207209
" if message[\"data\"].decode() == STOPWORD:\n",
208210
" print(\"(Reader) STOP\")\n",
209211
" break\n",
210212
"\n",
213+
"\n",
211214
"r = valkey.from_url(\"valkey://localhost\")\n",
212215
"async with r.pubsub() as pubsub:\n",
213216
" await pubsub.subscribe(\"channel:1\", \"channel:2\")\n",
@@ -264,7 +267,9 @@
264267
"\n",
265268
"async def reader(channel: valkey.client.PubSub):\n",
266269
" while True:\n",
267-
" message = await channel.get_message(ignore_subscribe_messages=True, timeout=None)\n",
270+
" message = await channel.get_message(\n",
271+
" ignore_subscribe_messages=True, timeout=None\n",
272+
" )\n",
268273
" if message is not None:\n",
269274
" print(f\"(Reader) Message Received: {message}\")\n",
270275
" if message[\"data\"].decode() == STOPWORD:\n",
@@ -318,7 +323,6 @@
318323
"\n",
319324
"from valkey.asyncio.sentinel import Sentinel\n",
320325
"\n",
321-
"\n",
322326
"sentinel = Sentinel([(\"localhost\", 26379), (\"sentinel2\", 26379)])\n",
323327
"r = sentinel.master_for(\"mymaster\")\n",
324328
"\n",
@@ -359,6 +363,7 @@
359363
],
360364
"source": [
361365
"import valkey.asyncio as valkey\n",
366+
"\n",
362367
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True\")\n",
363368
"url_connection.ping()"
364369
]
@@ -378,7 +383,9 @@
378383
"source": [
379384
"import valkey.asyncio as valkey\n",
380385
"\n",
381-
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True&protocol=3\")\n",
386+
"url_connection = valkey.from_url(\n",
387+
" \"valkey://localhost:6379?decode_responses=True&protocol=3\"\n",
388+
")\n",
382389
"url_connection.ping()"
383390
]
384391
}

‎docs/examples/connection_examples.ipynb‎

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,13 @@
112112
"source": [
113113
"import valkey\n",
114114
"\n",
115-
"user_connection = valkey.Valkey(host='localhost', port=6380, username='dvora', password='valkey', decode_responses=True)\n",
115+
"user_connection = valkey.Valkey(\n",
116+
" host=\"localhost\",\n",
117+
" port=6380,\n",
118+
" username=\"dvora\",\n",
119+
" password=\"valkey\",\n",
120+
" decode_responses=True,\n",
121+
")\n",
116122
"user_connection.ping()"
117123
]
118124
},
@@ -132,7 +138,9 @@
132138
"import valkey\n",
133139
"\n",
134140
"creds_provider = valkey.UsernamePasswordCredentialProvider(\"username\", \"password\")\n",
135-
"user_connection = valkey.Valkey(host=\"localhost\", port=6379, credential_provider=creds_provider)\n",
141+
"user_connection = valkey.Valkey(\n",
142+
" host=\"localhost\", port=6379, credential_provider=creds_provider\n",
143+
")\n",
136144
"user_connection.ping()"
137145
]
138146
},
@@ -152,8 +160,8 @@
152160
"from typing import Tuple\n",
153161
"import valkey\n",
154162
"\n",
155-
"creds_map = {\"user_1\": \"pass_1\",\n",
156-
" \"user_2\": \"pass_2\"}\n",
163+
"creds_map = {\"user_1\": \"pass_1\", \"user_2\": \"pass_2\"}\n",
164+
"\n",
157165
"\n",
158166
"class UserMapCredentialProvider(valkey.CredentialProvider):\n",
159167
" def __init__(self, username: str):\n",
@@ -162,6 +170,7 @@
162170
" def get_credentials(self) -> Tuple[str, str]:\n",
163171
" return self.username, creds_map.get(self.username)\n",
164172
"\n",
173+
"\n",
165174
"# Create a default connection to set the ACL user\n",
166175
"default_connection = valkey.Valkey(host=\"localhost\", port=6379)\n",
167176
"default_connection.acl_setuser(\n",
@@ -175,8 +184,9 @@
175184
"# Create a UserMapCredentialProvider instance for user_1\n",
176185
"creds_provider = UserMapCredentialProvider(\"user_1\")\n",
177186
"# Initiate user connection with the credential provider\n",
178-
"user_connection = valkey.Valkey(host=\"localhost\", port=6379,\n",
179-
" credential_provider=creds_provider)\n",
187+
"user_connection = valkey.Valkey(\n",
188+
" host=\"localhost\", port=6379, credential_provider=creds_provider\n",
189+
")\n",
180190
"user_connection.ping()"
181191
]
182192
},
@@ -196,6 +206,7 @@
196206
"from typing import Union\n",
197207
"import valkey\n",
198208
"\n",
209+
"\n",
199210
"class InitCredsSetCredentialProvider(valkey.CredentialProvider):\n",
200211
" def __init__(self, username, password):\n",
201212
" self.username = username\n",
@@ -213,7 +224,10 @@
213224
" self.call_supplier = True\n",
214225
" return self.username, self.password\n",
215226
"\n",
216-
"cred_provider = InitCredsSetCredentialProvider(username=\"init_user\", password=\"init_pass\")"
227+
"\n",
228+
"cred_provider = InitCredsSetCredentialProvider(\n",
229+
" username=\"init_user\", password=\"init_pass\"\n",
230+
")"
217231
]
218232
},
219233
{
@@ -241,24 +255,31 @@
241255
"import json\n",
242256
"import cachetools.func\n",
243257
"\n",
258+
"\n",
244259
"class SecretsManagerProvider(valkey.CredentialProvider):\n",
245-
" def __init__(self, secret_id, version_id=None, version_stage='AWSCURRENT'):\n",
246-
" self.sm_client = boto3.client('secretsmanager')\n",
260+
" def __init__(self, secret_id, version_id=None, version_stage=\"AWSCURRENT\"):\n",
261+
" self.sm_client = boto3.client(\"secretsmanager\")\n",
247262
" self.secret_id = secret_id\n",
248263
" self.version_id = version_id\n",
249264
" self.version_stage = version_stage\n",
250265
"\n",
251266
" def get_credentials(self) -> Union[Tuple[str], Tuple[str, str]]:\n",
252-
" @cachetools.func.ttl_cache(maxsize=128, ttl=24 * 60 * 60) #24h\n",
267+
" @cachetools.func.ttl_cache(maxsize=128, ttl=24 * 60 * 60) # 24h\n",
253268
" def get_sm_user_credentials(secret_id, version_id, version_stage):\n",
254269
" secret = self.sm_client.get_secret_value(secret_id, version_id)\n",
255-
" return json.loads(secret['SecretString'])\n",
256-
" creds = get_sm_user_credentials(self.secret_id, self.version_id, self.version_stage)\n",
257-
" return creds['username'], creds['password']\n",
270+
" return json.loads(secret[\"SecretString\"])\n",
271+
"\n",
272+
" creds = get_sm_user_credentials(\n",
273+
" self.secret_id, self.version_id, self.version_stage\n",
274+
" )\n",
275+
" return creds[\"username\"], creds[\"password\"]\n",
276+
"\n",
258277
"\n",
259278
"my_secret_id = \"EXAMPLE1-90ab-cdef-fedc-ba987SECRET1\"\n",
260279
"creds_provider = SecretsManagerProvider(secret_id=my_secret_id)\n",
261-
"user_connection = valkey.Valkey(host=\"localhost\", port=6379, credential_provider=creds_provider)\n",
280+
"user_connection = valkey.Valkey(\n",
281+
" host=\"localhost\", port=6379, credential_provider=creds_provider\n",
282+
")\n",
262283
"user_connection.ping()"
263284
]
264285
},
@@ -295,6 +316,7 @@
295316
"from botocore.signers import RequestSigner\n",
296317
"from cachetools import TTLCache, cached\n",
297318
"\n",
319+
"\n",
298320
"class ElastiCacheIAMProvider(valkey.CredentialProvider):\n",
299321
" def __init__(self, user, cluster_name, region=\"us-east-1\"):\n",
300322
" self.user = user\n",
@@ -336,11 +358,14 @@
336358
" # So strip it off the signed URL before returning\n",
337359
" return (self.user, signed_url.removeprefix(\"https://\"))\n",
338360
"\n",
361+
"\n",
339362
"username = \"barshaul\"\n",
340363
"cluster_name = \"test-001\"\n",
341364
"endpoint = \"test-001.use1.cache.amazonaws.com\"\n",
342365
"creds_provider = ElastiCacheIAMProvider(user=username, cluster_name=cluster_name)\n",
343-
"user_connection = valkey.Valkey(host=endpoint, port=6379, credential_provider=creds_provider)\n",
366+
"user_connection = valkey.Valkey(\n",
367+
" host=endpoint, port=6379, credential_provider=creds_provider\n",
368+
")\n",
344369
"user_connection.ping()"
345370
]
346371
},
@@ -375,7 +400,9 @@
375400
}
376401
],
377402
"source": [
378-
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True&health_check_interval=2\")\n",
403+
"url_connection = valkey.from_url(\n",
404+
" \"valkey://localhost:6379?decode_responses=True&health_check_interval=2\"\n",
405+
")\n",
379406
"url_connection.ping()"
380407
]
381408
},
@@ -392,7 +419,9 @@
392419
"metadata": {},
393420
"outputs": [],
394421
"source": [
395-
"url_connection = valkey.from_url(\"valkey://localhost:6379?decode_responses=True&health_check_interval=2&protocol=3\")\n",
422+
"url_connection = valkey.from_url(\n",
423+
" \"valkey://localhost:6379?decode_responses=True&health_check_interval=2&protocol=3\"\n",
424+
")\n",
396425
"url_connection.ping()"
397426
]
398427
},
@@ -410,7 +439,8 @@
410439
"outputs": [],
411440
"source": [
412441
"from valkey.sentinel import Sentinel\n",
413-
"sentinel = Sentinel([('localhost', 26379)], socket_timeout=0.1)\n",
442+
"\n",
443+
"sentinel = Sentinel([(\"localhost\", 26379)], socket_timeout=0.1)\n",
414444
"sentinel.discover_master(\"valkey-py-test\")"
415445
]
416446
}

‎docs/examples/pipeline_examples.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
}
3434
],
3535
"source": [
36-
"import valkey \n",
36+
"import valkey\n",
3737
"\n",
3838
"r = valkey.Valkey(decode_responses=True)\n",
3939
"r.ping()"

‎docs/examples/search_json_examples.ipynb‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,48 +33,53 @@
3333
"from valkey.commands.search.indexDefinition import IndexDefinition, IndexType\n",
3434
"from valkey.commands.search.query import NumericFilter, Query\n",
3535
"\n",
36-
"\n",
37-
"r = valkey.Valkey(host='localhost', port=6379)\n",
36+
"r = valkey.Valkey(host=\"localhost\", port=6379)\n",
3837
"user1 = {\n",
39-
" \"user\":{\n",
38+
" \"user\": {\n",
4039
" \"name\": \"Paul John\",\n",
4140
" \"email\": \"paul.john@example.com\",\n",
4241
" \"age\": 42,\n",
43-
" \"city\": \"London\"\n",
42+
" \"city\": \"London\",\n",
4443
" }\n",
4544
"}\n",
4645
"user2 = {\n",
47-
" \"user\":{\n",
46+
" \"user\": {\n",
4847
" \"name\": \"Eden Zamir\",\n",
4948
" \"email\": \"eden.zamir@example.com\",\n",
5049
" \"age\": 29,\n",
51-
" \"city\": \"Tel Aviv\"\n",
50+
" \"city\": \"Tel Aviv\",\n",
5251
" }\n",
5352
"}\n",
5453
"user3 = {\n",
55-
" \"user\":{\n",
54+
" \"user\": {\n",
5655
" \"name\": \"Paul Zamir\",\n",
5756
" \"email\": \"paul.zamir@example.com\",\n",
5857
" \"age\": 35,\n",
59-
" \"city\": \"Tel Aviv\"\n",
58+
" \"city\": \"Tel Aviv\",\n",
6059
" }\n",
6160
"}\n",
6261
"\n",
6362
"user4 = {\n",
64-
" \"user\":{\n",
63+
" \"user\": {\n",
6564
" \"name\": \"Sarah Zamir\",\n",
6665
" \"email\": \"sarah.zamir@example.com\",\n",
6766
" \"age\": 30,\n",
68-
" \"city\": \"Paris\"\n",
67+
" \"city\": \"Paris\",\n",
6968
" }\n",
7069
"}\n",
7170
"r.json().set(\"user:1\", Path.root_path(), user1)\n",
7271
"r.json().set(\"user:2\", Path.root_path(), user2)\n",
7372
"r.json().set(\"user:3\", Path.root_path(), user3)\n",
7473
"r.json().set(\"user:4\", Path.root_path(), user4)\n",
7574
"\n",
76-
"schema = (TextField(\"$.user.name\", as_name=\"name\"),TagField(\"$.user.city\", as_name=\"city\"), NumericField(\"$.user.age\", as_name=\"age\"))\n",
77-
"r.ft().create_index(schema, definition=IndexDefinition(prefix=[\"user:\"], index_type=IndexType.JSON))"
75+
"schema = (\n",
76+
" TextField(\"$.user.name\", as_name=\"name\"),\n",
77+
" TagField(\"$.user.city\", as_name=\"city\"),\n",
78+
" NumericField(\"$.user.age\", as_name=\"age\"),\n",
79+
")\n",
80+
"r.ft().create_index(\n",
81+
" schema, definition=IndexDefinition(prefix=[\"user:\"], index_type=IndexType.JSON)\n",
82+
")"
7883
]
7984
},
8085
{
@@ -167,7 +172,9 @@
167172
"# Search for all users, returning 2 users at a time and sorting by age in descending order\n",
168173
"offset = 0\n",
169174
"num = 2\n",
170-
"q = Query(\"*\").paging(offset, num).sort_by(\"age\", asc=False) # pass asc=True to sort in ascending order\n",
175+
"q = (\n",
176+
" Query(\"*\").paging(offset, num).sort_by(\"age\", asc=False)\n",
177+
") # pass asc=True to sort in ascending order\n",
171178
"r.ft().search(q)"
172179
]
173180
},

0 commit comments

Comments
 (0)