Skip to content

Remove sequence_space converter from kwargs_to_string #3183

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
weiji14 merged 1 commit into from
Apr 21, 2024
Merged

Remove sequence_space converter from kwargs_to_string #3183

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,6 @@ def kwargs_to_strings(**conversions):
string
* 'sequence_comma': transforms a sequence into a ``','`` separated string
* 'sequence_plus': transforms a sequence into a ``'+'`` separated string
* 'sequence_space': transforms a sequence into a ``' '`` separated string

Parameters
----------
Expand All @@ -645,7 +644,7 @@ def kwargs_to_strings(**conversions):

Examples
--------
>>> @kwargs_to_strings(R="sequence", i="sequence_comma", files="sequence_space")
>>> @kwargs_to_strings(R="sequence", i="sequence_comma")
... def module(*args, **kwargs):
... "A module that prints the arguments it received"
... print("{", end="")
Expand All @@ -670,7 +669,7 @@ def kwargs_to_strings(**conversions):
>>> module(i=[1, 2])
{'i': '1,2'}
>>> module(files=["data1.txt", "data2.txt"])
{'files': 'data1.txt data2.txt'}
{'files': ['data1.txt', 'data2.txt']}
>>> # Other non-boolean arguments are passed along as they are
>>> module(123, bla=(1, 2, 3), foo=True, A=False, i=(5, 6))
{'A': False, 'bla': (1, 2, 3), 'foo': True, 'i': '5,6'}
Expand All @@ -695,7 +694,6 @@ def kwargs_to_strings(**conversions):
>>> # Here is a more realistic example
>>> # See https://github.com/GenericMappingTools/pygmt/issues/2361
>>> @kwargs_to_strings(
... files="sequence_space",
... offset="sequence",
... R="sequence",
... i="sequence_comma",
Expand All @@ -711,21 +709,20 @@ def kwargs_to_strings(**conversions):
... )
... print("}")
>>> module(files=["data1.txt", "data2.txt"])
data1.txt data2.txt -54p/-54p {}
['data1.txt', 'data2.txt'] -54p/-54p {}
>>> module(["data1.txt", "data2.txt"])
data1.txt data2.txt -54p/-54p {}
['data1.txt', 'data2.txt'] -54p/-54p {}
>>> module(files=["data1.txt", "data2.txt"], offset=("20p", "20p"))
data1.txt data2.txt 20p/20p {}
['data1.txt', 'data2.txt'] 20p/20p {}
>>> module(["data1.txt", "data2.txt"], ("20p", "20p"))
data1.txt data2.txt 20p/20p {}
['data1.txt', 'data2.txt'] 20p/20p {}
>>> module(["data1.txt", "data2.txt"], ("20p", "20p"), R=[1, 2, 3, 4])
data1.txt data2.txt 20p/20p {'R': '1/2/3/4'}
['data1.txt', 'data2.txt'] 20p/20p {'R': '1/2/3/4'}
"""
separators = {
"sequence": "/",
"sequence_comma": ",",
"sequence_plus": "+",
"sequence_space": " ",
}

for arg, fmt in conversions.items():
Expand Down