Merge branch 'main' into edgarrmondragon-patch-1

edgarrmondragon · Aug 5, 2024 · d7bf761 · d7bf761
2 parents daf4983 + 7121dac
commit d7bf761
Show file tree

Hide file tree

Showing 12 changed files with 51 additions and 78 deletions.
diff --git a/.github/workflows/api-changes.yml b/.github/workflows/api-changes.yml
@@ -27,7 +27,7 @@ jobs:
         fetch-depth: 0
 
     - name: Setup Python
-      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f
       with:
         python-version: 3.12
 

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -24,7 +24,7 @@ jobs:
       with:
         fetch-depth: 0
         ref: ${{ github.event.inputs.tag || github.ref }}
-    - uses: hynek/build-and-inspect-python-package@b4fc3f6ba2b3da04f09659be99e2a29fb6146a61
+    - uses: hynek/build-and-inspect-python-package@2dbbf2b252d3a3c7cec7a810e3ed5983bd17b13a
 
   upload-to-release:
     name: Upload to GitHub Release
@@ -35,7 +35,7 @@ jobs:
       contents: write # IMPORTANT: mandatory for making GitHub Releases
 
     steps:
-    - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e
+    - uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16
       with:
         name: Packages
         path: dist
@@ -58,7 +58,7 @@ jobs:
       id-token: write # IMPORTANT: mandatory for trusted publishing
 
     steps:
-    - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e
+    - uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16
       with:
         name: Packages
         path: dist
@@ -76,11 +76,11 @@ jobs:
       attestations: write # IMPORTANT: mandatory for attestations
 
     steps:
-      - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e
+      - uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16
         with:
           name: Packages
           path: dist
-      - uses: actions/attest-build-provenance@bdd51370e0416ac948727f861e03c2f05d32d78e
+      - uses: actions/attest-build-provenance@210c1913531870065f03ce1f9440dd87bc0938cd
         id: attest
         with:
           subject-path: "./dist/citric*"

diff --git a/.github/workflows/constraints.txt b/.github/workflows/constraints.txt
@@ -1,5 +1,5 @@
-griffe==0.47.0
+griffe==0.48.0
 nox==2024.4.15
-pip==24.1.1
+pip==24.2
 pip-tools==7.4.1
-uv==0.2.18
+uv==0.2.32
diff --git a/.github/workflows/gen-release-pr.yml b/.github/workflows/gen-release-pr.yml
@@ -60,7 +60,7 @@ jobs:
 
     - name: Draft Release
       id: draft-release
-      uses: softprops/action-gh-release@a74c6b72af54cfa997e81df42d94703d6313a2d0
+      uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191
       with:
         draft: true
         body_path: ".changes/${{ steps.latest.outputs.output }}.md"

diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml
@@ -38,7 +38,7 @@ jobs:
         persist-credentials: false
 
     - name: "Run analysis"
-      uses: ossf/scorecard-action@dc50aa9510b46c811795eb24b2f1ba02a914e534
+      uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46
       with:
         results_file: results.sarif
         results_format: sarif
@@ -60,14 +60,14 @@ jobs:
     # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
     # format to the repository Actions tab.
     - name: "Upload artifact"
-      uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808
+      uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b
       with:
         name: SARIF file
         path: results.sarif
         retention-days: 5
 
     # Upload the results to GitHub's code scanning dashboard.
     - name: "Upload to code-scanning"
-      uses: github/codeql-action/upload-sarif@b611370bb5703a7efb587f9d136a52ea24c5c38c
+      uses: github/codeql-action/upload-sarif@afb54ba388a7dca6ecae48f608c4ff05ff4cc77a
       with:
         sarif_file: results.sarif
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -86,7 +86,7 @@ jobs:
 
     - name: Setup Python ${{ matrix.python-version }}
       if: "${{ !matrix.nightly }}"
-      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64
@@ -98,7 +98,7 @@ jobs:
 
     - name: Setup Python ${{ matrix.python-version }} (nightly)
       if: "${{ matrix.nightly }}"
-      uses: deadsnakes/action@4ed7bc1eceb871d35db155a6e165205bdede9cf8
+      uses: deadsnakes/action@16723567940b8b0fcc842ae60a882337f9645873
       with:
         python-version: "${{ matrix.python-version }}-dev"
 
@@ -110,7 +110,7 @@ jobs:
         nox --verbose -s tests
 
     - name: Upload coverage data
-      uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808
+      uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b
       with:
         name: "coverage-unit-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.nightly && 'nightly' || 'stable' }}"
         path: ".coverage.*"
@@ -137,7 +137,7 @@ jobs:
       uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
 
     - name: Setup Python
-      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f
       with:
         python-version: 3.12
         architecture: x64
@@ -254,7 +254,7 @@ jobs:
         fetch-tags: true
 
     - name: Setup Python ${{ matrix.python-version }}
-      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64
@@ -274,7 +274,7 @@ jobs:
         echo "LS_CHECKSUM=$(shasum -a 256 ls.tar.gz | cut -d' ' -f1)" >> $GITHUB_ENV
 
     - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb
+      uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db
 
     - name: Get Docker
       uses: actions-hub/docker/cli@f5fdbfc3f9d2a9265ead8962c1314108a7b7ec5d
@@ -306,7 +306,7 @@ jobs:
 
     - name: Upload coverage data
       if: always()
-      uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808
+      uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b
       with:
         name: "coverage-integration-${{ matrix.python-version }}-${{ matrix.image_tag || env.LS_CHECKSUM }}-${{ matrix.database }}"
         path: ".coverage.*"
@@ -326,7 +326,7 @@ jobs:
       uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
 
     - name: Set up Python
-      uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f
       with:
         python-version: "3.12"
         cache: pip
@@ -335,7 +335,7 @@ jobs:
       uses: ./.github/actions/install-tools
 
     - name: Download coverage data
-      uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e
+      uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16
       with:
         pattern: "coverage-${{ matrix.flag }}-*"
         merge-multiple: true

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -21,14 +21,14 @@ repos:
   - id: trailing-whitespace
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.6
+  rev: 0.29.1
   hooks:
   - id: check-dependabot
   - id: check-github-workflows
   - id: check-readthedocs
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.5.0
+  rev: v0.5.6
   hooks:
   - id: ruff
     args: [--fix, --exit-non-zero-on-fix, --show-fixes]
@@ -45,14 +45,14 @@ repos:
     - tomli
 
 - repo: https://github.com/pycqa/flake8
-  rev: 7.1.0
+  rev: 7.1.1
   hooks:
   - id: flake8
     additional_dependencies:
     - pydoclint==0.4.1
 
 - repo: https://github.com/pre-commit/pre-commit
-  rev: v3.7.1
+  rev: v3.8.0
   hooks:
   - id: validate_manifest
 
@@ -63,12 +63,12 @@ repos:
     args: [--all]
 
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "2.1.3"
+  rev: "2.2.1"
   hooks:
   - id: pyproject-fmt
 
 - repo: https://github.com/astral-sh/uv-pre-commit
-  rev: 0.2.13
+  rev: 0.2.33
   hooks:
   - id: pip-compile
     files: ^pyproject\.toml$

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,13 +2,9 @@
 #    uv pip compile pyproject.toml --pre --python-version 3.12 --extra docs -o docs/requirements.txt
 alabaster==0.7.16
     # via sphinx
-anyio==4.3.0
-    # via
-    #   starlette
-    #   watchfiles
-astroid==3.2.2
+astroid==3.3.0
     # via sphinx-autoapi
-autodocsumm==0.2.12
+autodocsumm==0.2.13
     # via citric (pyproject.toml)
 babel==2.15.0
     # via sphinx
@@ -18,23 +14,15 @@ certifi==2024.7.4
     # via requests
 charset-normalizer==3.3.2
     # via requests
-click==8.1.7
-    # via uvicorn
-colorama==0.4.6
-    # via sphinx-autobuild
 docutils==0.21.2
     # via
     #   citric (pyproject.toml)
     #   myst-parser
     #   sphinx
-furo==2024.5.6
+furo==2024.7.18
     # via citric (pyproject.toml)
-h11==0.14.0
-    # via uvicorn
 idna==3.7
-    # via
-    #   anyio
-    #   requests
+    # via requests
 imagesize==1.4.1
     # via sphinx
 jinja2==3.1.4
@@ -52,76 +40,63 @@ mdit-py-plugins==0.4.1
     # via myst-parser
 mdurl==0.1.2
     # via markdown-it-py
-myst-parser==3.0.1
+myst-parser==4.0.0
     # via citric (pyproject.toml)
-packaging==24.0
+packaging==24.1
     # via sphinx
 pygments==2.18.0
     # via
     #   furo
     #   sphinx
-pyyaml==6.0.1
+pyyaml==6.0.2rc1
     # via
     #   myst-parser
     #   sphinx-autoapi
-requests==2.32.2
+requests==2.32.3
     # via
     #   citric (pyproject.toml)
     #   sphinx
-sniffio==1.3.1
-    # via anyio
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.5
     # via beautifulsoup4
-sphinx==7.3.7
+sphinx==7.4.7
     # via
     #   citric (pyproject.toml)
     #   autodocsumm
     #   furo
     #   myst-parser
     #   sphinx-autoapi
-    #   sphinx-autobuild
     #   sphinx-basic-ng
     #   sphinx-copybutton
     #   sphinx-hoverxref
     #   sphinx-notfound-page
     #   sphinxcontrib-jquery
-sphinx-autoapi==3.1.0
-    # via citric (pyproject.toml)
-sphinx-autobuild==2024.4.16
+sphinx-autoapi==3.2.1
     # via citric (pyproject.toml)
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-copybutton==0.5.2
     # via citric (pyproject.toml)
-sphinx-hoverxref==1.3.0
+sphinx-hoverxref==1.4.0
     # via citric (pyproject.toml)
-sphinx-notfound-page==1.0.0
+sphinx-notfound-page==1.0.4
     # via citric (pyproject.toml)
-sphinxcontrib-applehelp==1.0.8
+sphinxcontrib-applehelp==2.0.0
     # via sphinx
-sphinxcontrib-devhelp==1.0.6
+sphinxcontrib-devhelp==2.0.0
     # via sphinx
-sphinxcontrib-htmlhelp==2.0.5
+sphinxcontrib-htmlhelp==2.1.0
     # via sphinx
 sphinxcontrib-jquery==4.1
     # via sphinx-hoverxref
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-qthelp==1.0.7
+sphinxcontrib-qthelp==2.0.0
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
-starlette==0.37.2
-    # via sphinx-autobuild
-typing-extensions==4.12.0rc1
+typing-extensions==4.12.2
     # via beautifulsoup4
 urllib3==2.2.2
     # via requests
-uvicorn==0.29.0
-    # via sphinx-autobuild
-watchfiles==0.21.0
-    # via sphinx-autobuild
-websockets==12.0
-    # via sphinx-autobuild
diff --git a/noxfile.py b/noxfile.py
@@ -149,7 +149,7 @@ def docs_serve(session: nox.Session) -> None:
         "docs",
         "build",
     ]
-    session.install("-v", "citric[docs] @ .")
+    session.install("-v", "citric[docs] @ .", "sphinx-autobuild")
 
     build_dir = Path("build")
     if build_dir.exists():

diff --git a/pyproject.toml b/pyproject.toml
@@ -56,13 +56,12 @@ optional-dependencies.dev = [
   "requests-cache>=1.1",
 ]
 optional-dependencies.docs = [
-  "autodocsumm>=0.2.5",          # 0.2.4 has a problematic dependency 'Sphinx>=2.2.*'
+  "autodocsumm>=0.2.5",       # 0.2.4 has a problematic dependency 'Sphinx>=2.2.*'
   "docutils>=0.20",
   "furo>=2024.1.29",
   "myst-parser>=2",
   "sphinx>=7",
   "sphinx-autoapi>=3",
-  "sphinx-autobuild>=2021.3.14",
   "sphinx-copybutton>=0.5.2",
   "sphinx-hoverxref>=1.3",
   "sphinx-notfound-page>=1",
@@ -207,8 +206,6 @@ lint.flake8-import-conventions.banned-from = [
   "typing",
 ]
 lint.flake8-import-conventions.extend-aliases.typing = "t"
-lint.flake8-pytest-style.fixture-parentheses = false
-lint.flake8-pytest-style.mark-parentheses = false
 lint.flake8-quotes.docstring-quotes = "double"
 lint.flake8-quotes.inline-quotes = "double"
 lint.flake8-quotes.multiline-quotes = "double"
@@ -313,6 +310,7 @@ omit = [
 ]
 precision = 2
 show_missing = true
+skip_covered = true
 
 [tool.mypy]
 enable_error_code = [