Skip to content

Commit 5e383bd

Browse files
seismanseisman
committed
Replace build_arg_string with build_arg_list in all module wrappers
1 parent 58bc9cb commit 5e383bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+119
-123
lines changed

‎pygmt/src/basemap.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"""
44

55
from pygmt.clib import Session
6-
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
6+
from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
77

88

99
@fmt_docstring
@@ -84,4 +84,4 @@ def basemap(self, **kwargs):
8484
"""
8585
kwargs = self._preprocess(**kwargs)
8686
with Session() as lib:
87-
lib.call_module(module="basemap", args=build_arg_string(kwargs))
87+
lib.call_module(module="basemap", args=build_arg_list(kwargs))

‎pygmt/src/binstats.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.helpers import (
77
GMTTempFile,
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -116,7 +116,7 @@ def binstats(data, **kwargs):
116116
if (outgrid := kwargs.get("G")) is None:
117117
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
118118
lib.call_module(
119-
module="binstats", args=build_arg_string(kwargs, infile=vintbl)
119+
module="binstats", args=build_arg_list(kwargs, infile=vintbl)
120120
)
121121

122122
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/blockm.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import pandas as pd
99
from pygmt.clib import Session
1010
from pygmt.helpers import (
11-
build_arg_string,
11+
build_arg_list,
1212
fmt_docstring,
1313
kwargs_to_strings,
1414
use_alias,
@@ -61,7 +61,7 @@ def _blockm(
6161
):
6262
lib.call_module(
6363
module=block_method,
64-
args=build_arg_string(kwargs, infile=vintbl, outfile=vouttbl),
64+
args=build_arg_list(kwargs, infile=vintbl, outfile=vouttbl),
6565
)
6666
return lib.virtualfile_to_dataset(
6767
vfname=vouttbl, output_type=output_type, column_names=column_names

‎pygmt/src/coast.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from pygmt.exceptions import GMTInvalidInput
77
from pygmt.helpers import (
88
args_in_kwargs,
9-
build_arg_string,
9+
build_arg_list,
1010
fmt_docstring,
1111
kwargs_to_strings,
1212
use_alias,
@@ -227,4 +227,4 @@ def coast(self, **kwargs):
227227
lakes, land, water, rivers, borders, dcw, Q, or shorelines"""
228228
)
229229
with Session() as lib:
230-
lib.call_module(module="coast", args=build_arg_string(kwargs))
230+
lib.call_module(module="coast", args=build_arg_list(kwargs))

‎pygmt/src/colorbar.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"""
44

55
from pygmt.clib import Session
6-
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
6+
from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
77

88
__doctest_skip__ = ["colorbar"]
99

@@ -146,4 +146,4 @@ def colorbar(self, **kwargs):
146146
"""
147147
kwargs = self._preprocess(**kwargs)
148148
with Session() as lib:
149-
lib.call_module(module="colorbar", args=build_arg_string(kwargs))
149+
lib.call_module(module="colorbar", args=build_arg_list(kwargs))

‎pygmt/src/contour.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"""
44

55
from pygmt.clib import Session
6-
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
6+
from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
77

88

99
@fmt_docstring
@@ -119,5 +119,5 @@ def contour(self, data=None, x=None, y=None, z=None, **kwargs):
119119
check_kind="vector", data=data, x=x, y=y, z=z, required_z=True
120120
) as vintbl:
121121
lib.call_module(
122-
module="contour", args=build_arg_string(kwargs, infile=vintbl)
122+
module="contour", args=build_arg_list(kwargs, infile=vintbl)
123123
)

‎pygmt/src/dimfilter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from pygmt.exceptions import GMTInvalidInput
77
from pygmt.helpers import (
88
GMTTempFile,
9-
build_arg_string,
9+
build_arg_list,
1010
fmt_docstring,
1111
kwargs_to_strings,
1212
use_alias,
@@ -155,7 +155,7 @@ def dimfilter(grid, **kwargs):
155155
if (outgrid := kwargs.get("G")) is None:
156156
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
157157
lib.call_module(
158-
module="dimfilter", args=build_arg_string(kwargs, infile=vingrd)
158+
module="dimfilter", args=build_arg_list(kwargs, infile=vingrd)
159159
)
160160

161161
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/filter1d.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from pygmt.clib import Session
1010
from pygmt.exceptions import GMTInvalidInput
1111
from pygmt.helpers import (
12-
build_arg_string,
12+
build_arg_list,
1313
fmt_docstring,
1414
use_alias,
1515
validate_output_table_type,
@@ -121,6 +121,6 @@ def filter1d(
121121
):
122122
lib.call_module(
123123
module="filter1d",
124-
args=build_arg_string(kwargs, infile=vintbl, outfile=vouttbl),
124+
args=build_arg_list(kwargs, infile=vintbl, outfile=vouttbl),
125125
)
126126
return lib.virtualfile_to_dataset(vfname=vouttbl, output_type=output_type)

‎pygmt/src/grd2cpt.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from pygmt.clib import Session
66
from pygmt.exceptions import GMTInvalidInput
7-
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
7+
from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
88

99
__doctest_skip__ = ["grd2cpt"]
1010

@@ -186,10 +186,10 @@ def grd2cpt(grid, **kwargs):
186186
with Session() as lib:
187187
with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
188188
if kwargs.get("H") is None: # if no output is set
189-
arg_str = build_arg_string(kwargs, infile=vingrd)
189+
arg_str = build_arg_list(kwargs, infile=vingrd)
190190
else: # if output is set
191191
outfile, kwargs["H"] = kwargs["H"], True
192192
if not outfile or not isinstance(outfile, str):
193193
raise GMTInvalidInput("'output' should be a proper file name.")
194-
arg_str = build_arg_string(kwargs, infile=vingrd, outfile=outfile)
194+
arg_str = build_arg_list(kwargs, infile=vingrd, outfile=outfile)
195195
lib.call_module(module="grd2cpt", args=arg_str)

‎pygmt/src/grd2xyz.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from pygmt.clib import Session
1111
from pygmt.exceptions import GMTInvalidInput
1212
from pygmt.helpers import (
13-
build_arg_string,
13+
build_arg_list,
1414
fmt_docstring,
1515
kwargs_to_strings,
1616
use_alias,
@@ -165,7 +165,7 @@ def grd2xyz(
165165
):
166166
lib.call_module(
167167
module="grd2xyz",
168-
args=build_arg_string(kwargs, infile=vingrd, outfile=vouttbl),
168+
args=build_arg_list(kwargs, infile=vingrd, outfile=vouttbl),
169169
)
170170
return lib.virtualfile_to_dataset(
171171
vfname=vouttbl, output_type=output_type, column_names=column_names

‎pygmt/src/grdclip.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.helpers import (
77
GMTTempFile,
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -101,7 +101,7 @@ def grdclip(grid, **kwargs):
101101
if (outgrid := kwargs.get("G")) is None:
102102
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
103103
lib.call_module(
104-
module="grdclip", args=build_arg_string(kwargs, infile=vingrd)
104+
module="grdclip", args=build_arg_list(kwargs, infile=vingrd)
105105
)
106106

107107
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdcontour.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"""
44

55
from pygmt.clib import Session
6-
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
6+
from pygmt.helpers import build_arg_list, fmt_docstring, kwargs_to_strings, use_alias
77

88
__doctest_skip__ = ["grdcontour"]
99

@@ -125,5 +125,5 @@ def grdcontour(self, grid, **kwargs):
125125
with Session() as lib:
126126
with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
127127
lib.call_module(
128-
module="grdcontour", args=build_arg_string(kwargs, infile=vingrd)
128+
module="grdcontour", args=build_arg_list(kwargs, infile=vingrd)
129129
)

‎pygmt/src/grdcut.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.helpers import (
77
GMTTempFile,
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -105,7 +105,7 @@ def grdcut(grid, **kwargs):
105105
if (outgrid := kwargs.get("G")) is None:
106106
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
107107
lib.call_module(
108-
module="grdcut", args=build_arg_string(kwargs, infile=vingrd)
108+
module="grdcut", args=build_arg_list(kwargs, infile=vingrd)
109109
)
110110

111111
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdfill.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from pygmt.exceptions import GMTInvalidInput
77
from pygmt.helpers import (
88
GMTTempFile,
9-
build_arg_string,
9+
build_arg_list,
1010
fmt_docstring,
1111
kwargs_to_strings,
1212
use_alias,
@@ -83,7 +83,7 @@ def grdfill(grid, **kwargs):
8383
if (outgrid := kwargs.get("G")) is None:
8484
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
8585
lib.call_module(
86-
module="grdfill", args=build_arg_string(kwargs, infile=vingrd)
86+
module="grdfill", args=build_arg_list(kwargs, infile=vingrd)
8787
)
8888

8989
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdfilter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.helpers import (
77
GMTTempFile,
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -138,7 +138,7 @@ def grdfilter(grid, **kwargs):
138138
if (outgrid := kwargs.get("G")) is None:
139139
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
140140
lib.call_module(
141-
module="grdfilter", args=build_arg_string(kwargs, infile=vingrd)
141+
module="grdfilter", args=build_arg_list(kwargs, infile=vingrd)
142142
)
143143

144144
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdgradient.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from pygmt.helpers import (
88
GMTTempFile,
99
args_in_kwargs,
10-
build_arg_string,
10+
build_arg_list,
1111
fmt_docstring,
1212
kwargs_to_strings,
1313
use_alias,
@@ -173,7 +173,7 @@ def grdgradient(grid, **kwargs):
173173
if (outgrid := kwargs.get("G")) is None:
174174
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
175175
lib.call_module(
176-
module="grdgradient", args=build_arg_string(kwargs, infile=vingrd)
176+
module="grdgradient", args=build_arg_list(kwargs, infile=vingrd)
177177
)
178178

179179
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdhisteq.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from pygmt.exceptions import GMTInvalidInput
1111
from pygmt.helpers import (
1212
GMTTempFile,
13-
build_arg_string,
13+
build_arg_list,
1414
fmt_docstring,
1515
kwargs_to_strings,
1616
use_alias,
@@ -129,7 +129,7 @@ def equalize_grid(grid, **kwargs):
129129
if (outgrid := kwargs.get("G")) is None:
130130
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
131131
lib.call_module(
132-
module="grdhisteq", args=build_arg_string(kwargs, infile=vingrd)
132+
module="grdhisteq", args=build_arg_list(kwargs, infile=vingrd)
133133
)
134134
return load_dataarray(outgrid) if outgrid == tmpfile.name else None
135135

@@ -235,7 +235,7 @@ def compute_bins(
235235
):
236236
kwargs["D"] = vouttbl # -D for output file name
237237
lib.call_module(
238-
module="grdhisteq", args=build_arg_string(kwargs, infile=vingrd)
238+
module="grdhisteq", args=build_arg_list(kwargs, infile=vingrd)
239239
)
240240

241241
result = lib.virtualfile_to_dataset(

‎pygmt/src/grdimage.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.exceptions import GMTInvalidInput
77
from pygmt.helpers import (
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -172,5 +172,5 @@ def grdimage(self, grid, **kwargs):
172172
):
173173
kwargs["I"] = vshadegrid
174174
lib.call_module(
175-
module="grdimage", args=build_arg_string(kwargs, infile=vingrd)
175+
module="grdimage", args=build_arg_list(kwargs, infile=vingrd)
176176
)

‎pygmt/src/grdinfo.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.helpers import (
77
GMTTempFile,
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -115,7 +115,7 @@ def grdinfo(grid, **kwargs):
115115
with lib.virtualfile_in(check_kind="raster", data=grid) as vingrd:
116116
lib.call_module(
117117
module="grdinfo",
118-
args=build_arg_string(kwargs, infile=vingrd, outfile=outfile.name),
118+
args=build_arg_list(kwargs, infile=vingrd, outfile=outfile.name),
119119
)
120120
result = outfile.read()
121121
return result

‎pygmt/src/grdlandmask.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from pygmt.exceptions import GMTInvalidInput
77
from pygmt.helpers import (
88
GMTTempFile,
9-
build_arg_string,
9+
build_arg_list,
1010
fmt_docstring,
1111
kwargs_to_strings,
1212
use_alias,
@@ -109,6 +109,6 @@ def grdlandmask(**kwargs):
109109
with Session() as lib:
110110
if (outgrid := kwargs.get("G")) is None:
111111
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
112-
lib.call_module(module="grdlandmask", args=build_arg_string(kwargs))
112+
lib.call_module(module="grdlandmask", args=build_arg_list(kwargs))
113113

114114
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdproject.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from pygmt.exceptions import GMTInvalidInput
77
from pygmt.helpers import (
88
GMTTempFile,
9-
build_arg_string,
9+
build_arg_list,
1010
fmt_docstring,
1111
kwargs_to_strings,
1212
use_alias,
@@ -117,7 +117,7 @@ def grdproject(grid, **kwargs):
117117
if (outgrid := kwargs.get("G")) is None:
118118
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
119119
lib.call_module(
120-
module="grdproject", args=build_arg_string(kwargs, infile=vingrd)
120+
module="grdproject", args=build_arg_list(kwargs, infile=vingrd)
121121
)
122122

123123
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

‎pygmt/src/grdsample.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pygmt.clib import Session
66
from pygmt.helpers import (
77
GMTTempFile,
8-
build_arg_string,
8+
build_arg_list,
99
fmt_docstring,
1010
kwargs_to_strings,
1111
use_alias,
@@ -93,7 +93,7 @@ def grdsample(grid, **kwargs):
9393
if (outgrid := kwargs.get("G")) is None:
9494
kwargs["G"] = outgrid = tmpfile.name # output to tmpfile
9595
lib.call_module(
96-
module="grdsample", args=build_arg_string(kwargs, infile=vingrd)
96+
module="grdsample", args=build_arg_list(kwargs, infile=vingrd)
9797
)
9898

9999
return load_dataarray(outgrid) if outgrid == tmpfile.name else None

0 commit comments

Comments
 (0)