Allow passing arguments containing spaces into pygmt functions

examples/gallery/embellishments/legend.py

@@ -19,7 +19,7 @@
  pen="faint",
  label="Apples",
 )
-fig.plot(data="@Table_5_11.txt", pen="1.5p,gray", label='"My lines"')
+fig.plot(data="@Table_5_11.txt", pen="1.5p,gray", label="My lines")
 fig.plot(data="@Table_5_11.txt", style="t0.15i", color="orange", label="Oranges")
 
 fig.legend(position="JTR+jTR+o0.2c", box=True)

pygmt/figure.py

@@ -192,8 +192,6 @@ def psconvert(self, **kwargs):
  # Default cropping the figure to True
  if "A" not in kwargs:
  kwargs["A"] = ""
- # allow for spaces in figure name
- kwargs["F"] = f'"{kwargs.get("F")}"' if kwargs.get("F") else None
  with Session() as lib:
  lib.call_module("psconvert", build_arg_string(kwargs))
 

pygmt/helpers/utils.py

@@ -107,7 +107,7 @@ def dummy_context(arg):
 
 
 def build_arg_string(kwargs):
- """
+ r"""
  Transform keyword arguments into a GMT argument string.
 
  Make sure all arguments have been previously converted to a string
@@ -159,6 +159,16 @@ def build_arg_string(kwargs):
  ... )
  ... )
  -BWSen -Bxaf -Byaf -I1/1p,blue -I2/0.25p,blue -JX4i -R1/2/3/4
+ >>> print(
+ ... build_arg_string(
+ ... dict(
+ ... B=["af", "WSne+tBlank Space"],
+ ... F='+t"Empty Spaces"',
+ ... l="'Void Space'",
+ ... ),
+ ... )
+ ... )
+ -BWSne+tBlank\040Space -Baf -F+t"Empty\040\040Spaces" -l'Void\040Space'
  """
  gmt_args = []
  # Exclude arguments that are None and False
@@ -168,11 +178,13 @@ def build_arg_string(kwargs):
  for key in filtered_kwargs:
  if is_nonstr_iter(kwargs[key]):
  for value in kwargs[key]:
- gmt_args.append(f"-{key}{value}")
+ _value = str(value).replace(" ", r"\040")
+ gmt_args.append(rf"-{key}{_value}")
  elif kwargs[key] is True:
  gmt_args.append(f"-{key}")
  else:
- gmt_args.append(f"-{key}{kwargs[key]}")
+ _value = str(kwargs[key]).replace(" ", r"\040")
+ gmt_args.append(rf"-{key}{_value}")
  return " ".join(sorted(gmt_args))
 
 

pygmt/src/subplot.py

@@ -148,10 +148,6 @@ def subplot(self, nrows=1, ncols=1, **kwargs):
  {XY}
  """
  kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
- # allow for spaces in string without needing double quotes
- if isinstance(kwargs.get("A"), str):
- kwargs["A"] = f'"{kwargs.get("A")}"'
- kwargs["T"] = f'"{kwargs.get("T")}"' if kwargs.get("T") else None
 
  if nrows < 1 or ncols < 1:
  raise GMTInvalidInput("Please ensure that both 'nrows'>=1 and 'ncols'>=1.")
@@ -222,8 +218,6 @@ def set_panel(self, panel=None, **kwargs):
  {V}
  """
  kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
- # allow for spaces in string with needing double quotes
- kwargs["A"] = f'"{kwargs.get("A")}"' if kwargs.get("A") is not None else None
  # convert tuple or list to comma-separated str
  panel = ",".join(map(str, panel)) if is_nonstr_iter(panel) else panel
 

pygmt/src/text.py

@@ -209,7 +209,7 @@ def text_(
  kwargs["F"] += f"+j{justify}"
 
  if isinstance(position, str):
- kwargs["F"] += f'+c{position}+t"{text}"'
+ kwargs["F"] += f"+c{position}+t{text}"
 
  extra_arrays = []
  # If an array of transparency is given, GMT will read it from

pygmt/tests/baseline/test_rose_no_sectors.png.dvc

@@ -1,4 +1,4 @@
 outs:
-- md5: 8e1c47b1cf6001dad3b3c0875af4562e
- size: 150390
+- md5: ce2d5cd1415b7c7bbeea5bf6ff39c480
+ size: 150288
  path: test_rose_no_sectors.png

pygmt/tests/test_figure.py

@@ -116,6 +116,7 @@ def test_figure_savefig_filename_with_spaces():
  fig.basemap(region=[0, 1, 0, 1], projection="X1c/1c", frame=True)
  with GMTTempFile(prefix="pygmt-filename with spaces", suffix=".png") as imgfile:
  fig.savefig(imgfile.name)
+ assert r"\040" not in os.path.abspath(imgfile.name)
  assert os.path.exists(imgfile.name)
 
 

pygmt/tests/test_legend.py

@@ -52,7 +52,7 @@ def test_legend_entries():
  pen="faint",
  label="Apples",
  )
- fig.plot(data="@Table_5_11.txt", pen="1.5p,gray", label='"My lines"')
+ fig.plot(data="@Table_5_11.txt", pen="1.5p,gray", label="My lines")
  fig.plot(data="@Table_5_11.txt", style="t0.15i", color="orange", label="Oranges")
  fig.legend(position="JTR+jTR")
 

pygmt/tests/test_rose.py

@@ -152,7 +152,7 @@ def test_rose_no_sectors(data_fractures_compilation):
  region=[0, 500, 0, 360],
  diameter="10c",
  labels="180/0/90/270",
- frame=["xg100", "yg45", "+t'Windrose diagram'"],
+ frame=["xg100", "yg45", "+tWindrose diagram"],
  pen="1.5p,red3",
  transparency=40,
  scale=0.5,