Skip to content

Deprecate the build_arg_string function in v0.12.0 (will be removed in v0.14.0) and use build_arg_list instead #3184

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

Merged
seisman merged 3 commits into from
Apr 22, 2024
Merged

Deprecate the build_arg_string function in v0.12.0 (will be removed in v0.14.0) and use build_arg_list instead #3184

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
88711a6
Deprecate the build_arg_string function in v0.12.0 (will be removed i…
seisman Apr 20, 2024
3ad88f5
Typo
seisman Apr 21, 2024
b720fd0
Update pygmt/helpers/utils.py
seisman Apr 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion pygmt/helpers/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import subprocess
import sys
import time
import warnings
import webbrowser
from collections.abc import Iterable, Sequence
from typing import Any
Expand Down Expand Up @@ -439,6 +440,10 @@ def build_arg_string(kwdict, confdict=None, infile=None, outfile=None):
strings (e.g. "+proj=longlat +datum=WGS84") will have their spaces removed.
See https://github.com/GenericMappingTools/pygmt/pull/1487 for more info.

.. deprecated:: 0.12.0

Use :func:`build_arg_list` instead.

Parameters
----------
kwdict : dict
Expand Down Expand Up @@ -513,8 +518,13 @@ def build_arg_string(kwdict, confdict=None, infile=None, outfile=None):
... )
input.txt -A0 -B -Crainbow --FORMAT_DATE_MAP="o dd" ->output.txt
"""
gmt_args = []
msg = (
"Utility function `build_arg_string()' is deprecated in v0.12.0 and will be "
"removed in v0.14.0. Uease `build_arg_list()' instead."

@seisman seisman Apr 20, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK with removing the function in two releases?

@weiji14 weiji14 Apr 21, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, two releases should be fine since it's meant to be an internal function (though people still use it for good reason).

Comment thread
seisman marked this conversation as resolved.
Outdated
)
Comment thread
seisman marked this conversation as resolved.
warnings.warn(msg, category=FutureWarning, stacklevel=2)

gmt_args = []
for key in kwdict:
if len(key) > 2: # raise an exception for unrecognized options
raise GMTInvalidInput(f"Unrecognized parameter '{key}'.")
Expand Down