Skip to content
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

Jump to bottom

Support tab completion in Jupyter by inserting aliases into the method signature #1282

Merged
merged 14 commits into from
Jun 16, 2021
Merged

Support tab completion in Jupyter by inserting aliases into the method signature #1282

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8d21c1b
Try injecting one parameter into method signature
maxrjones May 21, 2021
8082150
Update decorator
maxrjones May 21, 2021
49aa7b5
Update decorator to work with all aliases
maxrjones May 21, 2021
c2a2979
Fix formatting errors
maxrjones May 21, 2021
c6477d7
Update function name
maxrjones May 21, 2021
d3a046e
Use insert_alias for all functions with use_alias
maxrjones May 22, 2021
cd12847
Revert "Use insert_alias for all functions with use_alias"
maxrjones May 23, 2021
dc25707
Call insert_alias from inside use_alias
maxrjones May 23, 2021
f37faea
Make inserted alias parameters KEYWORD_ONLY
maxrjones May 23, 2021
377ba97
Merge branch 'master' into inject-aliases
May 24, 2021
6ed7e93
Merge branch 'master' into inject-aliases
maxrjones Jun 2, 2021
3c63ecc
Apply suggestions from code review
maxrjones Jun 16, 2021
d0acb50
Merge branch 'master' into inject-aliases
seisman Jun 16, 2021
fcc0e34
Merge branch 'master' into inject-aliases
maxrjones Jun 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "Use insert_alias for all functions with use_alias" 
This reverts commit d3a046e.
  • Loading branch information
@maxrjones
maxrjones committed May 23, 2021
commit cd1284707d7fb3c7bea969fe3d57d8ccd8ac13f7
2 changes: 0 additions & 2 deletions pygmt/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
launch_external_viewer,
unique_name,
Expand Down Expand Up @@ -125,7 +124,6 @@ def region(self):
return wesn

@fmt_docstring
@insert_alias
@use_alias(
A="crop",
C="gs_option",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/basemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
args_in_kwargs,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/coast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
args_in_kwargs,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/colorbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,10 @@
"""

from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/contour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@
data_kind,
dummy_context,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
A="annotation",
B="frame",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/grd2cpt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,10 @@

from pygmt.clib import Session
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
A="transparency",
C="cmap",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdclip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
GMTTempFile,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
G="outgrid",
R="region",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/grdcontour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,10 @@
grdcontour - Plot a contour figure.
"""
from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
A="annotation",
B="frame",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdcut.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
GMTTempFile,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
G="outgrid",
R="region",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdfill.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
GMTTempFile,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
A="mode",
G="outgrid",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdfilter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
GMTTempFile,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
D="distance",
F="filter",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/grdimage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,10 @@
grdimage - Plot grids or images.
"""
from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
A="img_out",
B="frame",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdinfo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@
GMTTempFile,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
C="per_column",
D="tiles",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdtrack.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,11 @@
build_arg_string,
data_kind,
fmt_docstring,
insert_alias,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(V="verbose", f="coltypes", n="interpolation")
def grdtrack(points, grid, newcolname=None, outfile=None, **kwargs):
"""
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/grdview.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@
build_arg_string,
data_kind,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/histogram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,10 @@
Histogram - Create a histogram
"""
from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
A="horizontal",
B="frame",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,10 @@
image - Plot an image.
"""
from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@
GMTTempFile,
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
C="per_column",
I="spacing",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/inset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,11 @@
import contextlib

from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@contextlib.contextmanager
@insert_alias
@use_alias(D="position", F="box", M="margin", N="no_clip", V="verbose")
@kwargs_to_strings(D="sequence", M="sequence")
def inset(self, **kwargs):
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/legend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@
build_arg_string,
data_kind,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/logo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,10 @@
"""

from pygmt.clib import Session
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
9 changes: 1 addition & 8 deletions pygmt/src/makecpt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,10 @@
"""
from pygmt.clib import Session
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import (
build_arg_string,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias


@fmt_docstring
@insert_alias
@use_alias(
A="transparency",
C="cmap",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/meca.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
data_kind,
dummy_context,
fmt_docstring,
insert_alias,
kwargs_to_strings,
use_alias,
)
Expand Down Expand Up @@ -96,7 +95,6 @@ def data_format_code(convention, component="full"):


@fmt_docstring
@insert_alias
@use_alias(
R="region",
J="projection",
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/plot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,13 @@
data_kind,
deprecate_parameter,
fmt_docstring,
insert_alias,
is_nonstr_iter,
kwargs_to_strings,
use_alias,
)


@fmt_docstring
@insert_alias
@use_alias(
A="straight_line",
B="frame",
Expand Down