Skip to content

Add function build_arg_list for building arguments list from keyword dictionaries - #3149

Merged
seisman merged 7 commits into
mainfrom
build_arg_list
Apr 8, 2024
Merged

Add function build_arg_list for building arguments list from keyword dictionaries#3149
seisman merged 7 commits into
mainfrom
build_arg_list

Conversation

@seisman

@seismanseisman commented Mar 31, 2024•
edited
Loading

Copy link
Copy Markdown
Member

This PR contains the changes of commit 1149b37 in PR #3132.

In this PR, a new utility function build_arg_list function is added. The new function is modified from the build_arg_string function and it differs from the build_arg_string function in the following aspects:

  1. returns a list of arguments, instead of a single argument string
  2. no hacky solutions for handling whitespaces
  3. Only apply the non_ascii_to_octal function to the single-letter option arguments, not to the configuration arguments and input/output files
  4. Doctests are also simplified.

The goal is to replace build_arg_string with build_arg_list in all module wrappers and deprecate/remove build_arg_string in future releases.

PR #3132 contains more changes that we will apply after this PR is merged.

@seismanseisman added enhancement Improving an existing feature needs review This PR has higher priority and needs review. labels Mar 31, 2024
@seismanseisman added this to the 0.12.0 milestone Mar 31, 2024
@seismanseisman mentioned this pull request Mar 31, 2024
Merged
10 tasks
yvonnefroehlich
yvonnefroehlich reviewed Mar 31, 2024
View reviewed changes
Comment threadpygmt/helpers/utils.py Outdated
seismanand others added 2 commits April 1, 2024 07:50
@seisman@yvonnefroehlich
Update pygmt/helpers/utils.py
05ab2fc
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Merge branch 'main' into build_arg_list
c69b531
@seisman
seisman requested a review from a teamApril 2, 2024 01:25
@seismanseisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Apr 7, 2024
weiji14
weiji14 reviewed Apr 7, 2024
View reviewed changes

@weiji14weiji14 left a comment

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.

Code logic ok, just some suggestions related to the type hints.

Comment threadpygmt/helpers/utils.py Outdated
Comment threadpygmt/helpers/utils.py Outdated
Comment threadpygmt/helpers/utils.py Outdated
Comment threadpygmt/helpers/utils.py Outdated
seismanand others added 2 commits April 8, 2024 09:53
@seisman@weiji14
Apply suggestions from code review
4559e1d
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman
Fix typing issues
914cb46
@seisman
seisman enabled auto-merge (squash) April 8, 2024 03:05
@seisman
seisman merged commit 79cda63 into mainApr 8, 2024
@seisman
seisman deleted the build_arg_list branch April 8, 2024 03:08
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 8, 2024
@seismanseisman mentioned this pull request Apr 20, 2024
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yvonnefroehlichyvonnefroehlichyvonnefroehlich left review comments
@michaelgrundmichaelgrundmichaelgrund approved these changes
@weiji14weiji14weiji14 approved these changes

Assignees

No one assigned

Labels

enhancementImproving an existing feature

Projects

None yet

Milestone

0.12.0

Development

Successfully merging this pull request may close these issues.

4 participants

@seisman@michaelgrund@weiji14@yvonnefroehlich