DOC-2544: Adding new doctest to support updated VSS article (#2886)

Co-authored-by: Viktor Ivanov <viktor@infogrid.io>
Co-authored-by: Sergey Prokazov <sergey.prokazov@redis.com>
Co-authored-by: Anuragkillswitch <70265851+Anuragkillswitch@users.noreply.github.com>
Co-authored-by: dvora-h <67596500+dvora-h@users.noreply.github.com>
Co-authored-by: Alex Schmitz <aschmitz@box.com>
Co-authored-by: Alex Schmitz <alex.schmitz@gmail.com>
Co-authored-by: Chayim <chayim@users.noreply.github.com>
Co-authored-by: Bar Shaul <88437685+barshaul@users.noreply.github.com>
Co-authored-by: CrimsonGlory <CrimsonGlory@users.noreply.github.com>
Co-authored-by: Raymond Yin <raymond@tryevergreen.com>
Co-authored-by: zach.lee <zach.lee@sendbird.com>
Co-authored-by: James R T <jamestiotio@gmail.com>
Co-authored-by: dvora-h <dvora.heller@redis.com>
Co-authored-by: Marc Schöchlin <marc.schoechlin@flipapp.de>
Co-authored-by: Nick Gerow <nick.gerow@enlightedinc.com>
Co-authored-by: Igor Malinovskiy <u.glide@gmail.com>
Co-authored-by: Chayim I. Kirshen <c@kirshen.com>
Co-authored-by: Leibale Eidelman <me@leibale.com>
Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com>
Co-authored-by: woutdenolf <woutdenolf@users.sf.net>
Co-authored-by: shacharPash <93581407+shacharPash@users.noreply.github.com>
Co-authored-by: Mirek Długosz <miniopl+github@gmail.com>
Co-authored-by: Oran Avraham <252748+oranav@users.noreply.github.com>
Co-authored-by: mzdehbashi-github <85902780+mzdehbashi-github@users.noreply.github.com>
Co-authored-by: Tyler Hutcherson <tyler.hutcherson@redis.com>
Co-authored-by: Felipe Machado <462154+felipou@users.noreply.github.com>
Co-authored-by: AYMEN Mohammed <53928879+AYMENJD@users.noreply.github.com>
Co-authored-by: Marc Schöchlin <ms-github@256bit.org>
Co-authored-by: Avasam <samuel.06@hotmail.com>
Co-authored-by: Markus Gerstel <2102431+Anthchirp@users.noreply.github.com>
Co-authored-by: Kristján Valur Jónsson <sweskman@gmail.com>
Co-authored-by: Nick Gerow <Nick.G.123@hotmail.com>
Co-authored-by: Cristian Matache <cristianmatache@hotmail.com>
Co-authored-by: Anurag Bandyopadhyay <angbpy@gmail.com>
Co-authored-by: Seongchuel Ahn <aciddust20@gmail.com>
Co-authored-by: Alibi <aliby.bbb@gmail.com>
Co-authored-by: Smit Parmar <smitraj333@gmail.com>
Co-authored-by: Brad MacPhee <macphee@gmail.com>
Co-authored-by: Shahar Lev <shahar_lev@hotmail.com>
Co-authored-by: Vladimir Mihailenco <vladimir.webdev@gmail.com>
Co-authored-by: Kevin James <KevinJames@thekev.in>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: David Pacsuta <34983281+ant1fact@users.noreply.github.com>
Co-authored-by: Rich Bowen <rbowen@rcbowen.com>
Co-authored-by: gmbnomis <gmbnomis@users.noreply.github.com>
Co-authored-by: Vivanov98 <66319645+Vivanov98@users.noreply.github.com>
Co-authored-by: Kosuke <kosuke.zhang@gmail.com>
Co-authored-by: Sergey Prokazov <prokazov@users.noreply.github.com>
Co-authored-by: jmcbailey <jmcbailey@gmail.com>
Co-authored-by: Galtozzy <14139502+Galtozzy@users.noreply.github.com>
Co-authored-by: Abhishek Kumar Sinha <aksinha334@gmail.com>
Co-authored-by: Eom Taegyung "Iggy <iggy.eom@sendbird.com>
Co-authored-by: Mehdi ABAAKOUK <sileht@sileht.net>
Co-authored-by: Dongkeun Lee <3315213+zakaf@users.noreply.github.com>
Co-authored-by: woutdenolf <wout.de_nolf@esrf.eu>
Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
Co-authored-by: Juraj Páll <palljuraj1@gmail.com>
Co-authored-by: Joan Fontanals <jfontanalsmartinez@gmail.com>
Co-authored-by: Stanislav Zmiev <zmievsa@gmail.com>
fix (#2566)
Fix unlink in cluster pipeline (#2562)
Fix issue 2540: Synchronise concurrent command calls to single-client mode. (#2568)
Fix: tuple function cannot be passed more than one argument (#2573)
Fix issue 2567: NoneType check before raising exception (#2569)
Fix issue 2349: Let async HiredisParser finish parsing after a Connection.disconnect() (#2557)
Fix issue with `pack_commands` returning an empty byte sequence (#2416)
Fix #2581 UnixDomainSocketConnection' object has no attribute '_command_packer' (#2583)
Fix #2581 UnixDomainSocketConnection' object has no attribute '_command_packer' .
Fix for `lpop` and `rpop` return typing (#2590)
Fixed CredentialsProvider examples (#2587)
Fixed issue #2598 - make Document class subscriptable
fix: replace async_timeout by asyncio.timeout (#2602)
Fix behaviour of async PythonParser to match RedisParser as for issue #2349 (#2582)
Fix (#2641)
fix: do not use asyncio's timeout lib before 3.11.2 (#2659)
Fix issue 2660: PytestUnraisableExceptionWarning from asycio client (#2669)
Fixing cancelled async futures (#2666)
Fix async (#2673)
Fix memory leak caused by hiredis (#2693) (#2694)
Fix incorrect usage of once flag in async Sentinel (#2718)
Fix topk list example. (#2724)
Fix `ClusterCommandProtocol` not itself being marked as a protocol (#2729)
Fix potential race condition during disconnection (#2719)
fix CI (#2748)
fix parse_slowlog_get (#2732)
fixes for issue #1128
fix create single_connection_client from url (#2752)
Fix `xadd` allow non negative maxlen (#2739)
Fix JSON.MERGE Summary (#2786)
Fixed key error in parse_xinfo_stream (#2788)
Fix dead weakref in sentinel connection causing ReferenceError (#2767) (#2771)
Fix dead weakref in sentinel conn (#2767)
fix redirects and some small cleanups (#2801)
Fix type hint for retry_on_error in async cluster (#2804)
Fix CI (#2809)
Fix async client with resp3 (#2657)
Fix `COMMAND` response in resp3 (redis 7+) (#2740)
Fix protocol version checking (#2737)
Fix parse resp3 dict response: don't use dict comprehension (#2757)
Fixing asyncio import (#2759)
fix (#2799)
fix async tests (#2806)
Fix socket garbage collection (#2859)
Fixing doc builds (#2869)
Fix a duplicate word in `CONTRIBUTING.md` (#2848)
Fix timeout retrying on Redis pipeline execution (#2812)
Fix type hints in SearchCommands (#2817)

Author: 55 people

.flake8

@@ -0,0 +1,26 @@
+[flake8]
+max-line-length = 88
+exclude =
+    *.egg-info,
+    *.pyc,
+    .git,
+    .tox,
+    .venv*,
+    build,
+    docs/*,
+    dist,
+    docker,
+    venv*,
+    .venv*,
+    whitelist.py,
+    tasks.py
+ignore =
+    E126
+    E203
+    F405
+    N801
+    N802
+    N803
+    N806
+    N815
+    W503

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    labels:
+      - "maintenance"
+    schedule:
+      interval: "monthly"

.github/spellcheck-settings.yml

@@ -0,0 +1,29 @@
+matrix:
+- name: Markdown
+  expect_match: false
+  apsell:
+    lang: en
+    d: en_US
+    ignore-case: true
+  dictionary:
+    wordlists:
+    - .github/wordlist.txt
+    output: wordlist.dic
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.extra:
+  - pyspelling.filters.html:
+      comments: false
+      attributes:
+      - alt
+      ignores:
+      - ':matches(code, pre)'
+      - code
+      - pre
+      - blockquote
+      - img
+  sources:
+  - '*.md'
+  - 'docs/*.rst'
+  - 'docs/*.ipynb'

.github/wordlist.txt

@@ -0,0 +1,142 @@
+APM
+ARGV
+BFCommands
+CFCommands
+CMSCommands
+ClusterNode
+ClusterNodes
+ClusterPipeline
+ClusterPubSub
+ConnectionPool
+CoreCommands
+EVAL
+EVALSHA
+GraphCommands
+Grokzen's
+INCR
+IOError
+Instrumentations
+JSONCommands
+Jaeger
+Ludovico
+Magnocavallo
+McCurdy
+NOSCRIPT
+NUMPAT
+NUMPT
+NUMSUB
+OSS
+OpenCensus
+OpenTelemetry
+OpenTracing
+Otel
+PubSub
+READONLY
+RediSearch
+RedisBloom
+RedisCluster
+RedisClusterCommands
+RedisClusterException
+RedisClusters
+RedisGraph
+RedisInstrumentor
+RedisJSON
+RedisTimeSeries
+SHA
+SearchCommands
+SentinelCommands
+SentinelConnectionPool
+Sharded
+Solovyov
+SpanKind
+Specfiying
+StatusCode
+TCP
+TOPKCommands
+TimeSeriesCommands
+Uptrace
+ValueError
+WATCHed
+WatchError
+api
+args
+async
+asyncio
+autoclass
+automodule
+backoff
+bdb
+behaviour
+bool
+boolean
+booleans
+bysource
+charset
+del
+dev
+eg
+exc
+firsttimersonly
+fo
+genindex
+gmail
+hiredis
+http
+idx
+iff
+ini
+json
+keyslot
+keyspace
+kwarg
+linters
+localhost
+lua
+makeapullrequest
+maxdepth
+mget
+microservice
+microservices
+mset
+multikey
+mykey
+nonatomic
+observability
+opentelemetry
+oss
+performant
+pmessage
+png
+pre
+psubscribe
+pubsub
+punsubscribe
+py
+pypi
+quickstart
+readonly
+readwrite
+redis
+redismodules
+reinitialization
+replicaof
+repo
+runtime
+sedrik
+sharded
+ssl
+str
+stunnel
+subcommands
+thevalueofmykey
+timeseries
+toctree
+topk
+tox
+triaging
+txt
+un
+unicode
+url
+virtualenv
+www

.github/workflows/docs.yaml

@@ -0,0 +1,47 @@
+name: Docs CI
+
+on:
+  push:
+    branches:
+      - master
+      - '[0-9].[0-9]'
+  pull_request:
+    branches:
+      - master
+      - '[0-9].[0-9]'
+  schedule:
+    - cron: '0 1 * * *' # nightly build
+
+concurrency:
+  group: ${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+jobs:
+
+   build-docs:
+     name: Build docs
+     runs-on: ubuntu-latest
+     steps:
+       - uses: actions/checkout@v3
+       - uses: actions/setup-python@v4
+         with:
+           python-version: 3.9
+           cache: 'pip'
+       - name: install deps
+         run: |
+           sudo apt-get update -yqq
+           sudo apt-get install -yqq pandoc make
+       - name: run code linters
+         run: |
+           pip install -r requirements.txt -r dev_requirements.txt -r docs/requirements.txt
+           invoke build-docs
+
+       - name: upload docs
+         uses: actions/upload-artifact@v3
+         with:
+           name: redis-py-docs
+           path: |
+             docs/_build/html

.github/workflows/doctests.yml

@@ -32,7 +32,8 @@ jobs:
         run: |
           pip install -r dev_requirements.txt
           pip install -r requirements.txt
-          isort --check-only --diff doctests/*.py
+          pip install -r doctests/requirements.txt
+          isort -l 80 --profile black --check-only --diff doctests/*.py
           black -l 80 --target-version py39 --check --diff doctests/*.py
 
       - name: run tests