openstack/reno
Code Issues Proposed changes
04233e0eae
reno/releasenotes/notes
History
Stephen Finucane cd31b907c3 Close files opened by Scanner, Loader 
We're seeing noise like the following in doc builds:

  /foo/.tox/docs/lib/python3.9/site-packages/docutils/statemachine.py:707:
  ResourceWarning: unclosed file <_io.BufferedReader name='/foo/.git/objects/pack/pack-dd69481843ca1b7377f2f109b0022221437aca20.pack'>
    if not hasattr(pattern, 'match'):
  ResourceWarning: Enable tracemalloc to get the object allocation traceback

Enable tracemalloc for Sphinx gives us the 'Loader' as the root cause:

  $ python -W all::ResourceWarning -X tracemalloc=100 -m sphinx.cmd.build ...
  ...
  File "/foo/.tox/docs/lib/python3.9/site-packages/reno/sphinxext.py", lineno 114
    ldr = loader.Loader(conf)
  File "/foo/.tox/docs/lib/python3.9/site-packages/reno/loader.py", lineno 63
    self._load_data()
  ...

(you could also use PYTHONTRACEMALLOC and PYTHONWARNINGS env vars)

Following this thread, it appears 'reno.scanner.Scanner' creates an
instance of 'dulwich.repo.Repo', however, it fails to close it [1]. The
'reno.loader.Loader' uses 'Scanner', meaning this also leaves around
open files.

The solution is simple: add a 'close()' method to both the 'Scanner' and
'Loader', and provide the necessary '__enter__' and '__exit__' magic
methods to use it as a context manager, like the 'Repo' object itself
supports.

[1] https://www.dulwich.io/docs/api/dulwich.repo.html#dulwich.repo.Repo.close

Change-Id: I0b9776f431cf902a9ace5d52961eb77caaae8eaa
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-09-28 17:28:17 +01:00
..
add-closed-branch-config-options-8773caf240e4653f.yaml support scanning closed stable branches 2018-01-29 14:53:28 -05:00
add-config-file-e77084792c1dc695.yaml update release notes 2016-12-14 11:55:16 -05:00
add-deprecations-section-6b0f118fe190585c.yaml Add deprecations section to release notes 2015-11-26 16:22:08 +00:00
add-earliest-version-6f3d634770e855d0.yaml add release note for earliest-version feature 2016-02-08 16:43:21 -05:00
add-linter-ce0a861ade64baf2.yaml add a lint command 2017-05-03 15:53:44 -04:00
add-verbose-flag-88d72cb01812c616.yaml add verbose and quiet options to command line for debugging 2015-11-23 19:14:01 +00:00
allow-short-branch-names-61a35be55f04cea4.yaml allow tracking branch names when the branches only exist on origin 2017-03-02 09:27:44 -05:00
avoid-clashing-uids-e84ffe8132ce996d.yaml do not allow multiple files with the same UID 2017-05-03 13:49:48 -04:00
branches-eol-bcafc2a007a1eb9f.yaml update release notes 2016-12-14 11:55:16 -05:00
bug-1537451-f44591da125ba09d.yaml fix detection of pre-release tags in git log 2016-01-26 12:52:49 -05:00
cache-ordering-6c743f68e3f7107f.yaml preserve the order of tags when reading the cache file 2018-04-27 19:12:12 -04:00
cache-scan-all-branches-a935824a844d1d9f.yaml Scan all branches for cache generation 2019-10-07 14:37:51 +00:00
collapse-pre-releases-0b24e0bab46d7cf1.yaml add flag to collapse pre-releases into final releases 2016-01-27 17:44:50 -05:00
config-option-branch-name-re-8ecfe93195b8824e.yaml fix some minor formatting issues with release notes 2017-02-21 14:25:54 -05:00
config-option-sections-9c68b070698e984a.yaml make sections configurable 2017-02-23 15:04:22 -05:00
custom-tag-versions-d02028b6d35db967.yaml fix some minor formatting issues with release notes 2017-02-21 14:25:54 -05:00
default-repository-root-cli-85d23034bef81619.yaml set the default for reporoot for the command line 2016-07-22 18:45:44 -04:00
drop-python-2-7-73d3113c69d724d6.yaml [ussuri][goal] Drop python 2.7 support and testing 2020-02-04 14:32:27 +01:00
dulwich-rewrite-3a5377162d97402b.yaml update release notes 2016-12-14 11:55:16 -05:00
Enable-using-tempalte-file-be734d8698309409.yaml fix release note markup 2017-11-07 02:00:21 -05:00
file-encoding-option-6aa3e32f2bf830b8.yaml add release note for encoding option 2020-08-29 17:39:06 -04:00
first-release-2857bfc9474c00b4.yaml reverse slug and uuid order in filenames 2015-10-01 21:50:08 +00:00
fix-branch-base-detection-95300805f26a0c15.yaml fix some minor formatting issues with release notes 2017-02-21 14:25:54 -05:00
fix-cli-option-handling-a13652d14507f2d7.yaml only override config values from command line if they are actually set 2018-10-10 12:55:11 -04:00
fix-delete-handling-55232c50b647aa57.yaml fix the way we handle deleted notes 2017-06-01 11:00:15 -04:00
fix-git-log-ordering-0e52f95f66c8db5b.yaml fix notes appearing in releases older than they should 2015-12-09 15:41:09 +00:00
fix-prelude-4e0bcb6f76571b4f.yaml reverse slug and uuid order in filenames 2015-10-01 21:50:08 +00:00
fix-scanner-tag-detection-ef0a95c12a90f167.yaml scan all changes and filter on files in reno not git log 2015-11-23 19:14:01 +00:00
fix-sphinxext-scanner-0aa012ada66db773.yaml fix sphinxext scanner when it has a list of versions to include 2017-03-02 14:30:20 -05:00
flexible-formatting-31c8de2599d3637d.yaml allow release notes sections to be single strings 2017-06-05 15:42:06 -04:00
ignore-notes-option-9d0bde540fbcdf22.yaml add option for ignoring some notes files 2017-06-13 13:42:07 -04:00
ignore-null-merges-56b7a8ed9b20859e.yaml ignore null-merges 2017-06-02 10:18:04 -04:00
include-working-copy-d0aed2e77bb095e6.yaml teach the scanner to look at uncommitted files 2017-01-04 16:00:26 -05:00
keep-scanning-past-branchpoint-61f72023c32cf0b3.yaml Keep scanning master branch after first shared commit 2020-04-21 11:35:20 +01:00
log-levels-and-sphinx-161-6efe0d291718a657.yaml add release note for log level fix 2017-05-18 11:43:16 -04:00
no-show-source-option-ee02766b26fe53be.yaml add --no-show-source option to report command 2017-03-15 10:58:49 -04:00
null-merge-infinite-loop-670367094ad83e19.yaml fix an infinite loop in the topo traversal algorithm 2017-06-14 08:06:07 -04:00
optional-oslosphinx-55843a7f80a14e58.yaml Make oslosphinx requirement optional 2017-05-29 19:10:59 +02:00
reference-name-mangling-3c845ebf88af6944.yaml release note for zuulv3 fix 2017-09-29 10:14:09 -04:00
release-date-3a1dec42c91a3f0b.yaml Add support for release dates 2020-04-20 23:09:23 -07:00
repodir-config-file-b6b8edc2975964fc.yaml Support repodir config files 2017-06-29 11:17:01 +01:00
report-title-option-f0875bfdbc54dd7b.yaml add a --title option to the report command 2017-03-15 11:17:30 -04:00
reverse-slug-order-4c5f94e72d4f6fb9.yaml fix typo in release note 2015-10-06 19:46:04 +00:00
scanner-change-96682cb04fc66c0b.yaml add release note for scanner fix 2017-11-15 16:02:37 -05:00
scanner-loader-context-managers-5d80d95dc3d33fe0.yaml Close files opened by Scanner, Loader 2021-09-28 17:28:17 +01:00
semver-next-63c68cf10ec91f09.yaml add semver-next command 2020-08-29 17:41:39 -04:00
setuptools-integration-950bd8ab6d2970c7.yaml Integrate a setuptools command 2018-04-11 09:26:36 +01:00
show-less-unreleased-802781a1a3bf110e.yaml fix some minor formatting issues with release notes 2017-02-21 14:25:54 -05:00
show-note-filename-in-report-a1118c917588b58d.yaml add filename and sha in comments in report output 2017-02-23 10:33:11 -05:00
sphinx-extension-4a092b4102370246.yaml reverse slug and uuid order in filenames 2015-10-01 21:50:08 +00:00
sphinx-with-tarballs-d3215fc6831c3516.yaml sphinxext: Support rootdir discovery without git 2020-04-20 17:39:47 +01:00
stable-section-anchors-d99258b6df39c0fa.yaml Make section titles have stable anchor links 2018-04-14 10:21:32 -05:00
stop-scanning-branch-e5a8937c248acc99.yaml stop scanning at the base of a branch 2016-10-13 18:53:35 +00:00
stop-scanning-branch-option-6a0156b183814d7f.yaml add configuration option to not stop at branch base 2016-10-13 18:55:40 +00:00
support-custom-template-0534a2199cfec44c.yaml update release notes 2016-12-14 11:55:16 -05:00
support-edit-ec5c01ad6144815a.yaml update release notes 2016-12-14 11:55:16 -05:00
support-multi-line-notes-328853d8d596fd64.yaml support multi-line notes and notes with complex formatting 2015-10-01 21:50:05 +00:00
tag-format-bd5018a813c804fd.yaml Allow tags prefixed with v in default regex 2018-08-27 10:12:45 -04:00
unreleased-version-title-86751f52745fd3b7.yaml add unreleased_version_title configuration option 2018-04-03 17:42:00 -04:00
validate-note-files-1cdbdcde9ae7829b.yaml loader: Validate section keys 2021-07-12 15:27:19 +01:00