Merge pull request #204 from jsoref/spelling

fix spelling in the repo

Author: Mikhail Koviazin

.github/spellcheck-settings.yml

@@ -1,7 +1,7 @@
 matrix:
 - name: Markdown
   expect_match: false
-  apsell:
+  aspell:
     lang: en
     d: en_US
     ignore-case: true

README.md

@@ -83,7 +83,7 @@ Alternatively, you might want to look at [Async connections](https://valkey-py.r
 
 ### Valkey Commands
 
-There is built-in support for all of the [out-of-the-box Valkey commands](https://valkey.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) except where a word (i.e. del) is reserved by the language. The complete set of commands can be found [here](https://github.com/valkey-io/valkey-py/tree/main/valkey/commands), or [the documentation](https://valkey-py.readthedocs.io/en/latest/commands.html).
+There is built-in support for all of the [out-of-the-box Valkey commands](https://valkey.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) except where a word (i.e. del) is reserved by the language. See the [complete set of commands](https://github.com/valkey-io/valkey-py/tree/main/valkey/commands), or [the documentation](https://valkey-py.readthedocs.io/en/latest/commands.html).
 
 ## Documentation
 
@@ -142,8 +142,7 @@ The following example shows how to utilize [Valkey Pub/Sub](https://valkey.io/to
 
 ### Author
 
-valkey-py can be found [here](
-https://github.com/valkey-io/valkey-py), or downloaded from [pypi](https://pypi.org/project/valkey/).
+You can read valkey-py sources on [GitHub](https://github.com/valkey-io/valkey-py), or download it from [pypi](https://pypi.org/project/valkey/)
 It was created as a fork of [redis-py](https://github.com/redis/redis-py)
 
 Special thanks to:

tasks.py

@@ -74,7 +74,7 @@ def cluster_tests(c, uvloop=False, protocol=2, color=False):
         )
     else:
         run(
-            f"pytest --color={'yes' if color else 'no'} --protocol={protocol} --cov=./ --cov-report=xml:coverage_clusteclient.xml -W always -m 'not onlynoncluster and not valkeymod' --valkey-url={cluster_url} --junit-xml=cluster-results.xml"
+            f"pytest --color={'yes' if color else 'no'} --protocol={protocol} --cov=./ --cov-report=xml:coverage_clusterclient.xml -W always -m 'not onlynoncluster and not valkeymod' --valkey-url={cluster_url} --junit-xml=cluster-results.xml"
         )
 
 

tests/conftest.py

@@ -167,9 +167,7 @@ def pytest_sessionstart(session):
 
             uvloop.install()
         except ImportError as e:
-            raise RuntimeError(
-                "Can not import uvloop, make sure it is installed"
-            ) from e
+            raise RuntimeError("Cannot import uvloop, make sure it is installed") from e
 
 
 def wait_for_cluster_creation(valkey_url, cluster_nodes, timeout=60):
@@ -510,7 +508,7 @@ def assert_resp_response(r, response, resp2_expected, resp3_expected):
 def assert_geo_is_close(coords, expected_coords):
     """Verifies that the coordinates are close within the floating point tolerance.
 
-    Valkey uses 52-bit presicion
+    Valkey uses 52-bit precision
     """
     for a, b in zip(coords, expected_coords):
         assert math.isclose(a, b)

tests/mocks.py

@@ -3,7 +3,7 @@
 
 class MockSocket:
     """
-    A class simulating an readable socket, optionally raising a
+    A class simulating a readable socket, optionally raising a
     special exception every other read.
     """
 

tests/test_asyncio/test_cluster.py

@@ -775,7 +775,7 @@ async def test_all_nodes(self, r: ValkeyCluster) -> None:
 
     async def test_all_nodes_masters(self, r: ValkeyCluster) -> None:
         """
-        Set a list of nodes with random primaries/replicas config and it shold
+        Set a list of nodes with random primaries/replicas config and it should
         be possible to iterate over all of them.
         """
         nodes = [
@@ -1128,7 +1128,7 @@ async def test_cluster_failover(self, r: ValkeyCluster) -> None:
         assert await r.cluster_failover(node, "FORCE") is True
         assert await r.cluster_failover(node, "TAKEOVER") is True
         with pytest.raises(ValkeyError):
-            await r.cluster_failover(node, "FORCT")
+            await r.cluster_failover(node, "NONEXISTENT_KEY")
 
     async def test_cluster_info(self, r: ValkeyCluster) -> None:
         info = await r.cluster_info()
@@ -2446,7 +2446,7 @@ async def test_init_slots_cache(self) -> None:
 
     async def test_init_slots_cache_cluster_mode_disabled(self) -> None:
         """
-        Test that creating a ValkeyCluster failes if one of the startup nodes
+        Test that creating a ValkeyCluster fails if one of the startup nodes
         has cluster mode disabled
         """
         with pytest.raises(ValkeyClusterException) as e:
@@ -2469,7 +2469,7 @@ async def test_empty_startup_nodes(self) -> None:
 
     async def test_wrong_startup_nodes_type(self) -> None:
         """
-        If something other then a list type itteratable is provided it should
+        If something other then a list type iterable is provided it should
         fail
         """
         with pytest.raises(ValkeyClusterException):

tests/test_asyncio/test_commands.py

@@ -62,15 +62,15 @@ def factory(username):
 async def slowlog(r: valkey.Valkey):
     current_config = await r.config_get()
     old_slower_than_value = current_config["slowlog-log-slower-than"]
-    old_max_legnth_value = current_config["slowlog-max-len"]
+    old_max_length_value = current_config["slowlog-max-len"]
 
     await r.config_set("slowlog-log-slower-than", 0)
     await r.config_set("slowlog-max-len", 128)
 
     yield
 
     await r.config_set("slowlog-log-slower-than", old_slower_than_value)
-    await r.config_set("slowlog-max-len", old_max_legnth_value)
+    await r.config_set("slowlog-max-len", old_max_length_value)
 
 
 async def valkey_server_time(client: valkey.Valkey):
@@ -1972,10 +1972,10 @@ async def test_zunionstore_max(self, r: valkey.Valkey):
         await r.zadd("b", {"a1": 2, "a2": 2, "a3": 2})
         await r.zadd("c", {"a1": 6, "a3": 5, "a4": 4})
         assert await r.zunionstore("d", ["a", "b", "c"], aggregate="MAX") == 4
-        respponse = await r.zrange("d", 0, -1, withscores=True)
+        response = await r.zrange("d", 0, -1, withscores=True)
         assert_resp_response(
             r,
-            respponse,
+            response,
             [(b"a2", 2.0), (b"a4", 4.0), (b"a3", 5.0), (b"a1", 6.0)],
             [[b"a2", 2.0], [b"a4", 4.0], [b"a3", 5.0], [b"a1", 6.0]],
         )
@@ -2647,7 +2647,7 @@ async def test_geosearch_with(
 
     @skip_if_server_version_lt("6.2.0")
     async def test_geosearch_negative(self, r: valkey.Valkey):
-        # not specifying member nor longitude and latitude
+        # neither specifying member nor longitude and latitude
         with pytest.raises(exceptions.DataError):
             assert await r.geosearch("barcelona")
         # specifying member and longitude and latitude
@@ -2661,7 +2661,7 @@ async def test_geosearch_negative(self, r: valkey.Valkey):
         with pytest.raises(exceptions.DataError):
             assert await r.geosearch("barcelona", latitude=2)
 
-        # not specifying radius nor width and height
+        # neither specifying radius nor width and height
         with pytest.raises(exceptions.DataError):
             assert await r.geosearch("barcelona", member="Paris")
         # specifying radius and width and height
@@ -3549,8 +3549,8 @@ async def helper():
             with pytest.raises(asyncio.CancelledError):
                 # blocking pop
                 ready.set()
-                await r.brpop(["nonexist"])
-            # If the following is not done, further Timout operations will fail,
+                await r.brpop(["nonexistent"])
+            # If the following is not done, further Timeout operations will fail,
             # because the timeout won't catch its Cancelled Error if the task
             # has a pending cancel.  Python documentation probably should reflect this.
             if sys.version_info >= (3, 11):

tests/test_asyncio/test_connection.py

@@ -212,7 +212,7 @@ async def test_connection_parse_response_resume(r: valkey.Valkey):
     [_AsyncRESP2Parser, _AsyncRESP3Parser, _AsyncLibvalkeyParser],
     ids=["AsyncRESP2Parser", "AsyncRESP3Parser", "AsyncLibvalkeyParser"],
 )
-async def test_connection_disconect_race(parser_class, connect_args):
+async def test_connection_disconnect_race(parser_class, connect_args):
     """
     This test reproduces the case in issue #2349
     where a connection is closed while the parser is reading to feed the

tests/test_asyncio/test_cwe_404.py

@@ -134,7 +134,7 @@ async def op(r):
                     await t
 
                 # make sure that our previous request, cancelled while waiting for
-                # a repsponse, didn't leave the connection open andin a bad state
+                # a response, didn't leave the connection open and in a bad state
                 assert await r.get("bar") == b"bar"
                 assert await r.ping()
                 assert await r.get("foo") == b"foo"
@@ -173,7 +173,7 @@ async def op(pipe):
                 with pytest.raises(asyncio.CancelledError):
                     await t
 
-                # we have now cancelled the pieline in the middle of a request,
+                # we have now cancelled the pipeline in the middle of a request,
                 # make sure that the connection is still usable
                 pipe.get("bar")
                 pipe.ping()

tests/test_asyncio/test_json.py

@@ -58,7 +58,7 @@ async def test_json_merge(decoded_r: valkey.Valkey):
         "person1": {"personal_data": {"name": "John", "hobbies": "reading"}}
     }
 
-    # Test with root path path $.person1.personal_data
+    # Test with root path $.person1.personal_data
     assert await decoded_r.json().merge(
         "person_data", "$.person1.personal_data", {"country": "Israel"}
     )
@@ -89,7 +89,7 @@ async def test_jsonsetexistentialmodifiersshouldsucceed(decoded_r: valkey.Valkey
     assert await decoded_r.json().set("obj", Path("foo"), "baz", xx=True)
     assert await decoded_r.json().set("obj", Path("qaz"), "baz", nx=True)
 
-    # Test that flags are mutually exlusive
+    # Test that flags are mutually exclusive
     with pytest.raises(Exception):
         await decoded_r.json().set("obj", Path("foo"), "baz", nx=True, xx=True)
 
@@ -825,7 +825,7 @@ async def test_objkeys_dollar(decoded_r: valkey.Valkey):
     # Test missing key
     assert await decoded_r.json().objkeys("non_existing_doc", "..a") is None
 
-    # Test non existing doc
+    # Test nonexistent doc
     with pytest.raises(exceptions.ResponseError):
         assert await decoded_r.json().objkeys("non_existing_doc", "$..a") == []