Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature request]: Make gempyor Testing Utilities Private #464

Open
TimothyWillard opened this issue Jan 13, 2025 · 0 comments
Open

[Feature request]: Make gempyor Testing Utilities Private #464

TimothyWillard opened this issue Jan 13, 2025 · 0 comments
Labels
enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. low priority Low priority. quick issue Short or easy fix.

Comments

@TimothyWillard
Copy link
Contributor

Label

enhancement, gempyor, quick issue

Priority Label

low priority

Is your feature request related to a problem? Please describe.

Currently the testing utilities provided by gempyor.testing are publicly available, these APIs should not be exported as we do not want external/operational users to make use of these directly. See:

"""
Unit testing utilities for `gempyor`
This module contains unit testing utilities, mostly pytest fixtures. To use this module
the optional test dependencies must be installed.
"""
__all__ = [
"change_directory_to_temp_directory",
"mock_empty_config",
"create_confuse_config_from_file",
"create_confuse_configview_from_dict",
"create_confuse_config_from_dict",
"partials_are_similar",
"sample_fits_distribution",
]
.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

No response

Describe the solution you'd like

Move gempyor.testing to gempyor._testing so it is hidden by default and change the __all__ dunder above to []. After doing this the test suite will have to be updated to accommodate. Doing these changes without adjusting the test suite results in lots of errors:

== 15 failed, 428 passed, 24 errors in 223.39s (0:03:43) ==
@TimothyWillard TimothyWillard added enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. low priority Low priority. quick issue Short or easy fix. labels Jan 13, 2025
@TimothyWillard TimothyWillard added this to the Software Quality milestone Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. low priority Low priority. quick issue Short or easy fix.
Projects
None yet
Development

No branches or pull requests

1 participant