Skip to content

Session.inquire_virtualfile: Raise GMTCLibError if invalid virtualfile name is passed #4863

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

Open
seisman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Session.inquire_virtualfile: Raise GMTCLibError if invalid virtualfile name is passed #4863

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion pygmt/clib/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1971,20 +1971,36 @@ def inquire_virtualfile(self, vfname: str) -> int:
family
The integer value for the family of the virtual file.

Raises
------
GMTCLibError
If the virtual file is not found, i.e., ``vfname`` is not a valid virtual
file name.

Examples
--------
>>> from pygmt.clib import Session
>>> with Session() as lib:
... with lib.virtualfile_out(kind="dataset") as vfile:
... family = lib.inquire_virtualfile(vfile)
... assert family == lib["GMT_IS_DATASET"]
>>> with Session() as lib:
... lib.inquire_virtualfile("not-a-virtual-file")
Traceback (most recent call last):
...
pygmt.exceptions.GMTCLibError: Failed to inquire the family of virtual file ...
"""
c_inquire_virtualfile = self.get_libgmt_func(
"GMT_Inquire_VirtualFile",
argtypes=[ctp.c_void_p, ctp.c_char_p],
restype=ctp.c_int,
)
return c_inquire_virtualfile(self.session_pointer, vfname.encode())
family = c_inquire_virtualfile(self.session_pointer, vfname.encode())

if family not in {self[name] for name in FAMILIES}:
msg = f"Failed to inquire the family of virtual file {vfname!r}."
raise GMTCLibError(msg)
return family

def read_virtualfile(
self,
Expand Down
Loading