abridge some more

Author: iritkatriel

peps/pep-0765.rst

@@ -158,15 +158,14 @@ straightforward.
 Appendix
 ========
 
-Below is an abridged version of a
-`research report <https://github.com/iritkatriel/finally/commits/main/README.md>`__
-by Irit Katriel, which was posted on 9 Nov 2024.
-
 ``return`` in ``finally`` considered harmful
 --------------------------------------------
 
-I describe an investigation of usage of ``return``, ``break`` and ``continue``
-in a ``finally`` clause in real world code. It addresses the
+Below is an abridged version of a
+`research report <https://github.com/iritkatriel/finally/commits/main/README.md>`__
+by Irit Katriel, which was posted on 9 Nov 2024.
+It describes an investigation into usage of ``return``, ``break`` and ``continue``
+in a ``finally`` clause in real world code, addressing the
 questions: Are people using it? How often are they using it incorrectly?
 How much churn would the proposed change create?
 
@@ -292,57 +291,10 @@ Two of the issue were labelled as "good first issue".
 The 8 cases where the feature appears to be used correctly (in non-test code) also
 deserve attention. These represent the "churn" that would be caused by blocking
 the feature, because this is where working code will need to change.  I did not
-contact the authors in these cases, so we will need to assess the difficulty of
-making these changes ourselves.
-
-- In `mosaicml <https://github.com/mosaicml/composer/blob/694e72159cf026b838ba00333ddf413185b4fb4f/composer/cli/launcher.py#L590>`__
-  there is a return in a finally at the end of the ``main`` function, after an ``except:``
-  clause which swallows all exceptions. The return in the finally would swallow
-  an exception raised from within the ``except:`` clause, but this seems to be the
-  intention in this code. A possible fix would be to assign the return value to a
-  variable in the ``finally`` clause, dedent the ``return`` statement and wrap the
-  body of the ``except:`` clause by another ``try``-``except`` to swallow any
-  exceptions from within it.
-
-- In `webtest <https://github.com/Pylons/webtest/blob/617a2b823c60e8d7c5f6e12a220affbc72e09d7d/webtest/http.py#L131>`__
-  there is a ``finally`` block that contains only ``return False``. It could be replaced
-  by
-
-.. code-block::
-
-    except BaseException:
-        pass
-    return False
-
-- In `kivy <https://github.com/kivy/kivy/blob/3b744c7ed274c1a99bd013fc55a5191ebd8a6a40/kivy/uix/codeinput.py#L204>`__
-  there is a ``finally`` that contains only a ``return`` statement. Since there is also a
-  bare ``except`` just before it, in this case the fix will be to just remove the ``finally:``
-  block and dedent the ``return`` statement.
-
-- In `logilab-common <https://forge.extranet.logilab.fr/open-source/logilab-common/-/blob/branch/default/test/data/module.py?ref_type=heads#L60>`__
-  there is, once again, a ``finally`` clause that can be replace by an ``except BaseException``
-  with the ``return`` dedented one level.
-
-- In `pluggy <https://github.com/pytest-dev/pluggy/blob/c760a77e17d512c3572d54d368fe6c6f9a7ac810/src/pluggy/_callers.py#L141>`__
-  there is a lengthy ``finally`` with two ``return`` statements (the second on line 182). Here the
-  return value can be assigned to a variable, and the ``return`` itself can appear after we've
-  exited the ``finally`` clause.
-
-- In `aws-sam-cli <https://github.com/aws/aws-sam-cli/blob/97e63dcc2738529eded8eecfef4b875abc3a476f/samcli/local/apigw/local_apigw_service.py#L721>`__
-  there is a conditional return at the end of the block.
-  From reading the code, it seems that the condition only holds when the exception has
-  been handled. The conditional block can just move outside of the ``finally`` block and
-  achieve the same effect.
-
-- In `scrappy <https://github.com/scrapy/scrapy/blob/52c072640aa61884de05214cb1bdda07c2a87bef/scrapy/utils/gz.py#L27>`__
-  there is a ``finally`` that contains only a ``break`` instruction. Assuming that it was the intention
-  to swallow all exceptions, it can be replaced by
-
-.. code-block::
-
-    except BaseException:
-         pass
-    break
+contact the authors in these cases, so we need to assess the difficulty of
+making these changes ourselves. It is show in
+`the full report<https://github.com/iritkatriel/finally/commits/main/README.md>`__,
+that the change required in each case is small.
 
 Discussion
 ^^^^^^^^^^
@@ -362,28 +314,6 @@ stated that the code is no longer maintained so they will not look into it.
 The 8 instances where the code seems to work as intended, are not hard to
 rewrite.
 
-Conclusion
-^^^^^^^^^^
-
-The results indicate that ``return``, ``break`` and ``continue`` in a finally block
-
-- are rarely used.
-- when they are used, they are usually used incorrectly.
-- code authors are receptive to changing their code, and tend to find it easy to do.
-
-## Acknowledgements
-
-I thank:
-
-- Alyssa Coghlan for
-  `bringing this issue my attention <https://discuss.python.org/t/pep-760-no-more-bare-excepts/67182/97>`__.
-
-- Guido van Rossum and Hugo van Kemenade for the
-  `script <https://github.com/faster-cpython/tools/blob/main/scripts/download_packages.py>`__
-  that downloads the most popular PyPI packages.
-
-- The many code authors I contacted for their responsiveness and grace.
-
 Copyright
 =========