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.

Sign up for GitHub

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

Jump to bottom

Synonym functions for backward compatibility with matplotlib #111

Merged
merged 1 commit into from Feb 14, 2022
Merged

Synonym functions for backward compatibility with matplotlib #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/top.rst
View file
Open in desktop
Expand Up @@ -22,5 +22,6 @@ contourpy
.. autoclass:: SerialContourGenerator
:members:
:special-members: __init__
:exclude-members: create_contour, create_filled_contour

.. autoclass:: ThreadedContourGenerator
26 changes: 25 additions & 1 deletion src/wrap.cpp
View file
Open in desktop
Expand Up @@ -89,6 +89,12 @@ PYBIND11_MODULE(_contourpy, m) {
py::kw_only(),
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0)
.def("create_contour", &Mpl2005ContourGenerator::lines,
"Synonym for :func:`~contourpy.Mpl2005ContourGenerator.lines` to provide backward "
"compatibility with Matplotlib.")
.def("create_filled_contour", &Mpl2005ContourGenerator::filled,
"Synonym for :func:`~contourpy.Mpl2005ContourGenerator.filled` to provide backward "
"compatibility with Matplotlib.")
.def("filled", &Mpl2005ContourGenerator::filled)
.def("lines", &Mpl2005ContourGenerator::lines)
.def_property_readonly("chunk_count", &Mpl2005ContourGenerator::get_chunk_count)
Expand Down Expand Up @@ -143,6 +149,12 @@ PYBIND11_MODULE(_contourpy, m) {
py::arg("corner_mask"),
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0)
.def("create_contour", &mpl2014::Mpl2014ContourGenerator::lines,
"Synonym for :func:`~contourpy.Mpl2014ContourGenerator.lines` to provide backward "
"compatibility with Matplotlib.")
.def("create_filled_contour", &mpl2014::Mpl2014ContourGenerator::filled,
"Synonym for :func:`~contourpy.Mpl2014ContourGenerator.filled` to provide backward "
"compatibility with Matplotlib.")
.def("filled", &mpl2014::Mpl2014ContourGenerator::filled)
.def("lines", &mpl2014::Mpl2014ContourGenerator::lines)
.def_property_readonly("chunk_count", &mpl2014::Mpl2014ContourGenerator::get_chunk_count)
Expand Down Expand Up @@ -195,6 +207,12 @@ PYBIND11_MODULE(_contourpy, m) {
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0)
.def("_write_cache", &SerialContourGenerator::write_cache)
.def("create_contour", &SerialContourGenerator::lines,
"Synonym for :func:`~contourpy.SerialContourGenerator.lines` to provide backward "
"compatibility with Matplotlib.")
.def("create_filled_contour", &SerialContourGenerator::filled,
"Synonym for :func:`~contourpy.SerialContourGenerator.filled` to provide backward "
"compatibility with Matplotlib.")
.def("filled", &SerialContourGenerator::filled,
"Calculate and return filled contours between two levels.\n\n"
"Args:\n"
Expand Down Expand Up @@ -279,7 +297,13 @@ PYBIND11_MODULE(_contourpy, m) {
py::arg("x_chunk_size") = 0,
py::arg("y_chunk_size") = 0,
py::arg("thread_count") = 0)
.def("debug_write_cache", &ThreadedContourGenerator::write_cache)
.def("_write_cache", &ThreadedContourGenerator::write_cache)
.def("create_contour", &ThreadedContourGenerator::lines,
"Synonym for :func:`~contourpy.ThreadedContourGenerator.lines` to provide backward "
"compatibility with Matplotlib.")
.def("create_filled_contour", &ThreadedContourGenerator::filled,
"Synonym for :func:`~contourpy.ThreadedContourGenerator.filled` to provide backward "
"compatibility with Matplotlib.")
.def("filled", &ThreadedContourGenerator::filled)
.def("lines", &ThreadedContourGenerator::lines)
.def_property_readonly("chunk_count", &ThreadedContourGenerator::get_chunk_count)
Expand Down
8 changes: 8 additions & 0 deletions tests/test_static.py
View file
Open in desktop
Expand Up @@ -35,6 +35,14 @@ def test_default_line_type(class_name):
assert default == expect


@pytest.mark.parametrize("class_name", util_test.all_class_names())
def test_has_lines_and_filled(class_name):
cls = get_class_from_name(class_name)
for func_name in ["create_contour", "create_filled_contour", "filled", "lines"]:
assert hasattr(cls, func_name)
assert callable(getattr(cls, func_name))


@pytest.mark.parametrize("class_name", util_test.all_class_names())
def test_supports_corner_mask(class_name):
cls = get_class_from_name(class_name)
Expand Down