Skip to content

Commit 02eec0d

Browse files
committed
Add --mpl-use-full-test-name CLI option
1 parent 232f479 commit 02eec0d

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

docs/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ If you specify a filename that has an extension other than ``png``, you must als
160160
Whether to include the module name in the filename
161161
--------------------------------------------------
162162
| **kwarg**: ---
163-
| **CLI**: ---
163+
| **CLI**: ``--mpl-use-full-test-name``
164164
| **INI**: ``mpl-use-full-test-name``
165165
| Default: ``False``
166166

pytest_mpl/plugin.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,9 @@ def pytest_addoption(parser):
164164
help=results_always_help)
165165
parser.addini('mpl-results-always', help=results_always_help)
166166

167-
parser.addini('mpl-use-full-test-name', help="use fully qualified test name as the filename.",
168-
type='bool')
167+
use_full_test_name_help = "use fully qualified test name as the filename."
168+
group.addoption("--mpl-use-full-test-name", help=use_full_test_name_help, action="store_true")
169+
parser.addini('mpl-use-full-test-name', help=use_full_test_name_help, type='bool')
169170

170171
style_help = "default style to use for tests, unless specified in the mpl_image_compare decorator"
171172
group.addoption('--mpl-default-style', help=style_help, action='store')
@@ -195,6 +196,8 @@ def pytest_configure(config):
195196
generate_summary = config.getoption("--mpl-generate-summary")
196197
results_always = (config.getoption("--mpl-results-always") or
197198
config.getini("mpl-results-always"))
199+
use_full_test_name = (config.getoption("--mpl-use-full-test-name") or
200+
config.getini("mpl-use-full-test-name"))
198201

199202
if config.getoption("--mpl-baseline-relative"):
200203
baseline_relative_dir = config.getoption("--mpl-baseline-path")
@@ -233,6 +236,7 @@ def pytest_configure(config):
233236
generate_hash_library=generate_hash_lib,
234237
generate_summary=generate_summary,
235238
results_always=results_always,
239+
use_full_test_name=use_full_test_name,
236240
default_style=default_style,
237241
default_tolerance=default_tolerance))
238242

@@ -291,6 +295,7 @@ def __init__(self,
291295
generate_hash_library=None,
292296
generate_summary=None,
293297
results_always=False,
298+
use_full_test_name=False,
294299
default_style='classic',
295300
default_tolerance=2
296301
):
@@ -312,6 +317,7 @@ def __init__(self,
312317
results_always = True
313318
self.generate_summary = generate_summary
314319
self.results_always = results_always
320+
self.use_full_test_name = use_full_test_name
315321

316322
self.default_style = default_style
317323
self.default_tolerance = default_tolerance
@@ -360,7 +366,7 @@ def generate_filename(self, item):
360366
Given a pytest item, generate the figure filename.
361367
"""
362368
ext = self._file_extension(item)
363-
if self.config.getini('mpl-use-full-test-name'):
369+
if self.use_full_test_name:
364370
filename = generate_test_name(item) + f'.{ext}'
365371
else:
366372
compare = get_compare(item)

0 commit comments

Comments
 (0)