Title: agent: contextlib.contextmanager does NOT restore state on exception unless try-finally is used · Issue #1818 · usethis-python/usethis-python · GitHub
Open Graph Title: agent: contextlib.contextmanager does NOT restore state on exception unless try-finally is used · Issue #1818 · usethis-python/usethis-python
X Title: agent: contextlib.contextmanager does NOT restore state on exception unless try-finally is used · Issue #1818 · usethis-python/usethis-python
Description: Lesson learned from PR #1795 (infer dependencies from setup.cfg) When using @contextmanager to implement UsethisConfig.set(), the cleanup code after yield does NOT run if an exception is raised inside the with block — UNLESS the code use...
Open Graph Description: Lesson learned from PR #1795 (infer dependencies from setup.cfg) When using @contextmanager to implement UsethisConfig.set(), the cleanup code after yield does NOT run if an exception is raised ins...
X Description: Lesson learned from PR #1795 (infer dependencies from setup.cfg) When using @contextmanager to implement UsethisConfig.set(), the cleanup code after yield does NOT run if an exception is raised ins...
Opengraph URL: https://github.com/usethis-python/usethis-python/issues/1818
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"agent: contextlib.contextmanager does NOT restore state on exception unless try-finally is used","articleBody":"## Lesson learned from PR #1795 (infer dependencies from setup.cfg)\n\nWhen using `@contextmanager` to implement `UsethisConfig.set()`, the cleanup code after `yield` does NOT run if an exception is raised inside the `with` block — UNLESS the code uses `try-finally`.\n\n## Root cause\n\nPython's `@contextmanager` works by re-raising exceptions at the `yield` point inside the generator. Without a `try-finally` wrapper around `yield`, the code after `yield` never executes when an exception occurs:\n\n```python\n@contextmanager\ndef set(self, *, quiet=None, ...):\n old_quiet = self.quiet\n self.quiet = quiet\n yield # If exception raised here → code below NEVER runs!\n self.quiet = old_quiet # ← NEVER runs on exception without try-finally\n```\n\nThe fix is:\n```python\n@contextmanager\ndef set(self, *, quiet=None, ...):\n old_quiet = self.quiet\n self.quiet = quiet\n try:\n yield\n finally:\n self.quiet = old_quiet # ← ALWAYS runs, even on exception\n```\n\n## How this caused cascading CI failures\n\n1. My changes made `get_dep_groups()` require `SetupCFGManager()` to be locked\n2. Tests without `SetupCFGManager()` in their context raised `UnexpectedSetupCFGIOError`\n3. This exception propagated through `with usethis_config.set(quiet=True):` blocks in production code (`_core/tool.py`)\n4. Without `try-finally`, `quiet=True` was NOT restored after the exception\n5. All subsequent tests produced empty output (since `quiet=True` suppresses all print functions)\n\nThis caused ~80 cascading test failures across `test_console.py`, `test_base.py`, and all `_tool/impl/base/` test files.\n\n## Fix applied in PR #1795\n\nAdded `try-finally` to `UsethisConfig.set()` in `src/usethis/_config.py` (commit bfb2905).\n\n## Recommendation\n\nAny `@contextmanager` that modifies shared state MUST wrap the `yield` in `try-finally` to guarantee cleanup runs on exceptions:\n\n```python\n@contextmanager\ndef my_context_manager():\n # setup...\n try:\n yield\n finally:\n # cleanup (always runs, even on exception)\n```","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2026-04-04T18:11:28.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/1818/usethis-python/issues/1818"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:2e678edc-5f2d-fd01-d27f-1b4f9503a305 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A890:2AB98E:AE878A:F39CB4:6A4C9F21 |
| html-safe-nonce | 673547d013e2befb92d1ae4faad0b7d3b70d7fb9bed4d15e0bffc38a4df5956c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBODkwOjJBQjk4RTpBRTg3OEE6RjM5Q0I0OjZBNEM5RjIxIiwidmlzaXRvcl9pZCI6IjEwMjIxNDQxMTE2MTg4NTg3ODUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 7c0b3c4d3b85a39c20145efbb6ebe7342eee661af0ad9cba9a2179f8a85bf676 |
| hovercard-subject-tag | issue:4205509037 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/usethis-python/usethis-python/1818/issue_layout |
| twitter:image | https://opengraph.githubassets.com/caf992f27a45ccd85b5d3058d9c6c369de96a6552be47b1a9c0bfd1f8eb97781/usethis-python/usethis-python/issues/1818 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/caf992f27a45ccd85b5d3058d9c6c369de96a6552be47b1a9c0bfd1f8eb97781/usethis-python/usethis-python/issues/1818 |
| og:image:alt | Lesson learned from PR #1795 (infer dependencies from setup.cfg) When using @contextmanager to implement UsethisConfig.set(), the cleanup code after yield does NOT run if an exception is raised ins... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | nathanjmcdougall |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c |
| turbo-cache-control | no-preview |
| go-import | github.com/usethis-python/usethis-python git https://github.com/usethis-python/usethis-python.git |
| octolytics-dimension-user_id | 216362695 |
| octolytics-dimension-user_login | usethis-python |
| octolytics-dimension-repository_id | 842189705 |
| octolytics-dimension-repository_nwo | usethis-python/usethis-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 842189705 |
| octolytics-dimension-repository_network_root_nwo | usethis-python/usethis-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ae90d426644ca15e89bacceb72e51f4e9dbf85f7 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width