cd31b907c3
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>
55 lines
1.7 KiB
Python
55 lines
1.7 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import glob
|
|
import logging
|
|
import os.path
|
|
|
|
from reno import loader
|
|
from reno import scanner
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def lint_cmd(args, conf):
|
|
"Check some common mistakes"
|
|
LOG.debug('starting lint')
|
|
notesdir = os.path.join(conf.reporoot, conf.notespath)
|
|
notes = glob.glob(os.path.join(notesdir, '*.yaml'))
|
|
|
|
error = 0
|
|
allowed_section_names = [conf.prelude_section_name] + \
|
|
[s[0] for s in conf.sections]
|
|
|
|
uids = {}
|
|
with loader.Loader(conf, ignore_cache=True) as ldr:
|
|
for f in notes:
|
|
LOG.debug('examining %s', f)
|
|
uid = scanner._get_unique_id(f)
|
|
uids.setdefault(uid, []).append(f)
|
|
|
|
content = ldr.parse_note_file(f, None)
|
|
for section_name in content.keys():
|
|
if section_name not in allowed_section_names:
|
|
LOG.warning(
|
|
'unrecognized section name %s in %s',
|
|
section_name, f,
|
|
)
|
|
error = 1
|
|
|
|
for uid, names in sorted(uids.items()):
|
|
if len(names) > 1:
|
|
LOG.warning('UID collision: %s', names)
|
|
error = 1
|
|
|
|
return error
|