Convert booleans arguments in build_arg_string, not in kwargs_to_strings by seisman · Pull Request #1125 · GenericMappingTools/pygmt

seisman · 2021-03-26T06:27:18Z

Description of proposed changes

See #640 and #639 (the discussions and the fix) for context.

Changes in this PR:

06bee27: Remove convert_bools parameter from kwargs_to_strings. So kwargs_to_strings won't convert boolean arguments.
b7210ff: Handle boolean arguments in the build_arg_string function.
59a2b28: The boolean use_srtm parameter of load_earth_relief won't be converted to an empty string or removed anymore. Now it's safe to check if use_strm.
a9d167d: The autolabel parameter of subplot function can be either bool or str, but we had to check if autolabel is not None. It's not intuitive. Actually, we made a mistake in the initial version (4126c16) and then fixed it (eadb847).
aac61c2: Similarly, justify, angle, and font can be boolean, but we have to check if it's None. This commit also fixes the weird codes.

Fixes#640.

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

See 4126c16 and eadb847

weiji14

Just some minor comments for now. I think there's some room for improvement but will suggest more later (possibly after the weekend).

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

weiji14

A few suggestions, mostly on refactoring the if-then blocks. Feel free to disagree if it feels less readable to you.

weiji14 · 2021-04-05T02:00:57Z

+
+ if angle is True:
+ kwargs["F"] += "+a"
+ elif isinstance(angle, (int, float, str)):
 kwargs["F"] += f"+a{str(angle)}"


Just thinking ahead to resolve #483 (allowing list inputs to angle/list/justify), we could simply use if angle (returns True for list/int/float/str inputs) like so:
Suggested change
ifangleisTrue:
kwargs["F"] +="+a"
elifisinstance(angle, (int, float, str)):
kwargs["F"] +=f"+a{str(angle)}"
ifangle:
kwargs["F"] +="+a"
ifisinstance(angle, (int, float, str)):
kwargs["F"] +=str(angle)

Actually, I was planing to work on #483, but I realized that the Figure.text() function needs more refactoring, so I opened PR #1121.
Personally, I prefer to make the changes to text.py as small as possible, and will address #483 after #1121 is merged.

Ok, as you wish then.

weiji14 · 2021-04-05T02:01:57Z

+ if font is True:
+ kwargs["F"] += "+f"
+ elif isinstance(font, str):
 kwargs["F"] += f"+f{font}"


Suggested change
iffontisTrue:
kwargs["F"] +="+f"
elifisinstance(font, str):
kwargs["F"] +=f"+f{font}"
iffont:
kwargs["F"] +="+f"
ifisinstance(font, str):
kwargs["F"] +=font

weiji14 · 2021-04-05T02:02:39Z

+ if justify is True:
+ kwargs["F"] += "+j"
+ elif isinstance(justify, str):
 kwargs["F"] += f"+j{justify}"


Suggested change
ifjustifyisTrue:
kwargs["F"] +="+j"
elifisinstance(justify, str):
kwargs["F"] +=f"+j{justify}"
ifjustify:
kwargs["F"] +="+j"
ifisinstance(justify, str):
kwargs["F"] +=justify

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

weiji14

Thanks @seisman, good to finally close #640, and this change will open up a lot of new possibilities with PyGMT functions!

…ngs (GenericMappingTools#1125) * Do not convert booleans in the kwargs_to_strings decorator * Deal with boolean values in build_arg_string * load_earth_relief no longer need the convert_bools=False hack * Fix the weird codes in subplot autolabel * Fix the weird codes in text Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

seisman added 5 commits March 26, 2021 01:53

Do not convert booleans in the kwargs_to_strings decorator
06bee27

Deal with boolean values in build_arg_string
b7210ff

load_earth_relief no longer need the convert_bools=False hack
59a2b28

Fix the weird codes in subplot autolabel
a9d167d
See 4126c16 and eadb847

Fix the weird codes in text
aac61c2

seisman marked this pull request as ready for review March 26, 2021 06:44

seisman self-assigned this Mar 26, 2021

seisman added the maintenance Boring but important stuff for the core devs label Mar 26, 2021

seisman added this to the 0.4.0 milestone Mar 26, 2021

weiji14 reviewed Mar 26, 2021
View reviewed changes

Comment threadpygmt/helpers/utils.py Outdated
Comment threadpygmt/helpers/utils.py Outdated

Apply suggestions from code review
bf38deb
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercelBottemporarily deployed to Preview March 26, 2021 15:38 Inactive

Merge branch 'master' into fix-bools
69aa4fb

vercelBottemporarily deployed to Preview April 1, 2021 23:34 Inactive

weiji14 reviewed Apr 5, 2021
View reviewed changes

Refactor the build_arg_string function
2e4b60d
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercelBottemporarily deployed to Preview April 5, 2021 04:09 Inactive

Fix a broken test
2193053

vercelBottemporarily deployed to Preview April 5, 2021 04:56 Inactive

weiji14 approved these changes Apr 5, 2021
View reviewed changes

seisman added 2 commits April 5, 2021 01:12

Remove an unnecessary blank line
11be35d

Merge branch 'master' into fix-bools
8f1a53e

vercelBottemporarily deployed to Preview April 5, 2021 05:12 Inactive

seisman merged commit 26d00e0 into masterApr 5, 2021

seisman deleted the fix-bools branch April 5, 2021 05:47

weiji14 mentioned this pull request Sep 7, 2021
Allow passing arguments containing spaces into pygmt functions #1487
Merged
8 tasks

weiji14 mentioned this pull request Mar 13, 2022
Setting frame=None gives unexpected results #1665
Closed

Navigation Menu

Uh oh!

Convert booleans arguments in build_arg_string, not in kwargs_to_strings - #1125

Convert booleans arguments in build_arg_string, not in kwargs_to_strings#1125
seisman merged 11 commits into
masterfrom
fix-bools

seisman commented Mar 26, 2021•
edited
Loading

Uh oh!

weiji14 left a comment

Uh oh!

Uh oh!

Uh oh!

weiji14 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weiji14Apr 5, 2021

Uh oh!

seismanApr 5, 2021

Uh oh!

weiji14Apr 5, 2021

Uh oh!

weiji14Apr 5, 2021

Uh oh!

weiji14Apr 5, 2021

Uh oh!

weiji14 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-ifangleisTrue:
-kwargs["F"] +="+a"
-elifisinstance(angle, (int, float, str)):
-kwargs["F"] +=f"+a{str(angle)}"
+ifangle:
+kwargs["F"] +="+a"
+ifisinstance(angle, (int, float, str)):
+kwargs["F"] +=str(angle)

-iffontisTrue:
-kwargs["F"] +="+f"
-elifisinstance(font, str):
-kwargs["F"] +=f"+f{font}"
+iffont:
+kwargs["F"] +="+f"
+ifisinstance(font, str):
+kwargs["F"] +=font

-ifjustifyisTrue:
-kwargs["F"] +="+j"
-elifisinstance(justify, str):
-kwargs["F"] +=f"+j{justify}"
+ifjustify:
+kwargs["F"] +="+j"
+ifisinstance(justify, str):
+kwargs["F"] +=justify

Uh oh!

Conversation

seisman commented Mar 26, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weiji14Apr 5, 2021

Choose a reason for hiding this comment

Uh oh!

seismanApr 5, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14Apr 5, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14Apr 5, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14Apr 5, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

seisman commented Mar 26, 2021•
edited
Loading