Merge master

aio-libs · Jan 30, 2024 · e7de51d · e7de51d
2 parents d5fd592 + 8b33fe6
commit e7de51d
Show file tree

Hide file tree

Showing 65 changed files with 1,963 additions and 146 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,6 +8,20 @@
 
 <!-- Outline any notable behaviour for the end users. -->
 
+## Is it a substantial burden for the maintainers to support this?
+
+<!--
+Stop right there! Pause. Just for a minute... Can you think of anything
+obvious that would complicate the ongoing development of this project?
+
+Try to consider if you'd be able to maintain it throughout the next
+5 years. Does it seem viable? Tell us your thoughts! We'd very much
+love to hear what the consequences of merging this patch might be...
+
+This will help us assess if your change is something we'd want to
+entertain early in the review process. Thank you in advance!
+-->
+
 ## Related issue number
 
 <!-- Are there any issues opened that will be resolved by merging this change? -->
@@ -21,13 +35,35 @@
 - [ ] If you provide code modification, please add yourself to `CONTRIBUTORS.txt`
   * The format is &lt;Name&gt; &lt;Surname&gt;.
   * Please keep alphabetical order, the file is sorted by names.
-- [ ] Add a new news fragment into the `CHANGES` folder
-  * name it `<issue_id>.<type>` for example (588.bugfix)
-  * if you don't have an `issue_id` change it to the pr id after creating the pr
-  * ensure type is one of the following:
-    * `.feature`: Signifying a new feature.
-    * `.bugfix`: Signifying a bug fix.
-    * `.doc`: Signifying a documentation improvement.
-    * `.removal`: Signifying a deprecation or removal of public API.
-    * `.misc`: A ticket has been closed, but it is not of interest to users.
-  * Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."
+- [ ] Add a new news fragment into the `CHANGES/` folder
+  * name it `<issue_or_pr_num>.<type>.rst` (e.g. `588.bugfix.rst`)
+  * if you don't have an issue number, change it to the pull request
+    number after creating the PR
+    * `.bugfix`: A bug fix for something the maintainers deemed an
+      improper undesired behavior that got corrected to match
+      pre-agreed expectations.
+    * `.feature`: A new behavior, public APIs. That sort of stuff.
+    * `.deprecation`: A declaration of future API removals and breaking
+      changes in behavior.
+    * `.breaking`: When something public is removed in a breaking way.
+      Could be deprecated in an earlier release.
+    * `.doc`: Notable updates to the documentation structure or build
+      process.
+    * `.packaging`: Notes for downstreams about unobvious side effects
+      and tooling. Changes in the test invocation considerations and
+      runtime assumptions.
+    * `.contrib`: Stuff that affects the contributor experience. e.g.
+      Running tests, building the docs, setting up the development
+      environment.
+    * `.misc`: Changes that are hard to assign to any of the above
+      categories.
+  * Make sure to use full sentences with correct case and punctuation,
+    for example:
+    ```rst
+    Fixed issue with non-ascii contents in doctest text files
+    -- by :user:`contributor-gh-handle`.
+    ```
+
+    Use the past tense or the present tense a non-imperative mood,
+    referring to what's changed compared to the last released version
+    of this project.
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -391,7 +391,7 @@ jobs:
       run: |
         make cythonize
     - name: Build wheels
-      uses: pypa/[email protected].2
+      uses: pypa/[email protected].4
       env:
         CIBW_ARCHS_MACOS: x86_64 arm64 universal2
     - uses: actions/upload-artifact@v3
@@ -436,8 +436,10 @@ jobs:
         version_file: aiohttp/__init__.py
         github_token: ${{ secrets.GITHUB_TOKEN }}
         dist_dir: dist
-        fix_issue_regex: "`#(\\d+) <https://github.com/aio-libs/aiohttp/issues/\\1>`_"
-        fix_issue_repl: "(#\\1)"
+        fix_issue_regex: >-
+          :issue:`(\d+)`
+        fix_issue_repl: >-
+          #\1
 
     - name: >-
         Publish 🐍📦 to PyPI

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -6,9 +6,35 @@ repos:
     language: fail
     entry: >-
       Changelog files must be named
-      ####.(bugfix|feature|removal|doc|misc)(.#)?(.rst)?
+      ####.(
+      bugfix
+      | feature
+      | deprecation
+      | breaking
+      | doc
+      | packaging
+      | contrib
+      | misc
+      )(.#)?(.rst)?
     exclude: >-
-      ^CHANGES/(\.TEMPLATE\.rst|\.gitignore|\d+\.(bugfix|feature|removal|doc|misc)(\.\d+)?(\.rst)?|README\.rst)$
+      (?x)
+      ^
+        CHANGES/(
+          \.gitignore
+          |(\d+|[0-9a-f]{8}|[0-9a-f]{7}|[0-9a-f]{40})\.(
+            bugfix
+            |feature
+            |deprecation
+            |breaking
+            |doc
+            |packaging
+            |contrib
+            |misc
+          )(\.\d+)?(\.rst)?
+          |README\.rst
+          |\.TEMPLATE\.rst
+        )
+      $
     files: ^CHANGES/
   - id: changelogs-user-role
     name: Changelog files should use a non-broken :user:`name` role
@@ -30,11 +56,11 @@ repos:
   hooks:
   - id: yesqa
 - repo: https://github.com/PyCQA/isort
-  rev: '5.12.0'
+  rev: '5.13.2'
   hooks:
   - id: isort
 - repo: https://github.com/psf/black
-  rev: '23.11.0'
+  rev: '23.12.1'
   hooks:
     - id: black
       language_version: python3 # Should be a command that runs python
@@ -76,7 +102,7 @@ repos:
   - id: pyupgrade
     args: ['--py37-plus']
 - repo: https://github.com/PyCQA/flake8
-  rev: '6.1.0'
+  rev: '7.0.0'
   hooks:
   - id: flake8
     additional_dependencies:

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -10,6 +10,233 @@
 
 .. towncrier release notes start
 
+3.9.3 (2024-01-29)
+==================
+
+Bug fixes
+---------
+
+- Fixed backwards compatibility breakage (in 3.9.2) of ``ssl`` parameter when set outside
+  of ``ClientSession`` (e.g. directly in ``TCPConnector``) -- by :user:`Dreamsorcerer`.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8097`, :issue:`8098`.
+
+
+
+
+Miscellaneous internal changes
+------------------------------
+
+- Improved test suite handling of paths and temp files to consistently use pathlib and pytest fixtures.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`3957`.
+
+
+
+
+----
+
+
+3.9.2 (2024-01-28)
+==================
+
+Bug fixes
+---------
+
+- Fixed server-side websocket connection leak.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`7978`.
+
+
+
+- Fixed ``web.FileResponse`` doing blocking I/O in the event loop.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8012`.
+
+
+
+- Fixed double compress when compression enabled and compressed file exists in server file responses.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8014`.
+
+
+
+- Added runtime type check for ``ClientSession`` ``timeout`` parameter.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8021`.
+
+
+
+- Fixed an unhandled exception in the Python HTTP parser on header lines starting with a colon -- by :user:`pajod`.
+
+  Invalid request lines with anything but a dot between the HTTP major and minor version are now rejected.
+  Invalid header field names containing question mark or slash are now rejected.
+  Such requests are incompatible with :rfc:`9110#section-5.6.2` and are not known to be of any legitimate use.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8074`.
+
+
+
+- Improved validation of paths for static resources requests to the server -- by :user:`bdraco`.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8079`.
+
+
+
+
+Features
+--------
+
+- Added support for passing :py:data:`True` to ``ssl`` parameter in ``ClientSession`` while
+  deprecating :py:data:`None` -- by :user:`xiangyan99`.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`7698`.
+
+
+
+Breaking changes
+----------------
+
+- Fixed an unhandled exception in the Python HTTP parser on header lines starting with a colon -- by :user:`pajod`.
+
+  Invalid request lines with anything but a dot between the HTTP major and minor version are now rejected.
+  Invalid header field names containing question mark or slash are now rejected.
+  Such requests are incompatible with :rfc:`9110#section-5.6.2` and are not known to be of any legitimate use.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8074`.
+
+
+
+
+Improved documentation
+----------------------
+
+- Fixed examples of ``fallback_charset_resolver`` function in the :doc:`client_advanced` document. -- by :user:`henry0312`.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`7995`.
+
+
+
+- The Sphinx setup was updated to avoid showing the empty
+  changelog draft section in the tagged release documentation
+  builds on Read The Docs -- by :user:`webknjaz`.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8067`.
+
+
+
+
+Packaging updates and notes for downstreams
+-------------------------------------------
+
+- The changelog categorization was made clearer. The
+  contributors can now mark their fragment files more
+  accurately -- by :user:`webknjaz`.
+
+  The new category tags are:
+
+      * ``bugfix``
+
+      * ``feature``
+
+      * ``deprecation``
+
+      * ``breaking`` (previously, ``removal``)
+
+      * ``doc``
+
+      * ``packaging``
+
+      * ``contrib``
+
+      * ``misc``
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8066`.
+
+
+
+
+Contributor-facing changes
+--------------------------
+
+- Updated :ref:`contributing/Tests coverage <aiohttp-contributing>` section to show how we use ``codecov`` -- by :user:`Dreamsorcerer`.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`7916`.
+
+
+
+- The changelog categorization was made clearer. The
+  contributors can now mark their fragment files more
+  accurately -- by :user:`webknjaz`.
+
+  The new category tags are:
+
+      * ``bugfix``
+
+      * ``feature``
+
+      * ``deprecation``
+
+      * ``breaking`` (previously, ``removal``)
+
+      * ``doc``
+
+      * ``packaging``
+
+      * ``contrib``
+
+      * ``misc``
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`8066`.
+
+
+
+
+Miscellaneous internal changes
+------------------------------
+
+- Replaced all ``tmpdir`` fixtures with ``tmp_path`` in test suite.
+
+
+  *Related issues and pull requests on GitHub:*
+  :issue:`3551`.
+
+
+
+
+----
+
+
 3.9.1 (2023-11-26)
 ==================