.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.52.0 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "guestfs-python 3"
.TH guestfs-python 3 2024-01-05 libguestfs-1.52.0 "Virtualization Support"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH 名前
.IX Header "名前"
guestfs-python \- Python から libguestfs を使用する方法
.SH 書式
.IX Header "書式"
.Vb 4
\& import guestfs
\& g = guestfs.GuestFS(python_return_dict=True)
\& g.add_drive_opts("disk.img", format="raw", readonly=1)
\& g.launch()
.Ve
.SH 説明
.IX Header "説明"
This manual page documents how to call libguestfs from the Python programming language.  This page just documents the differences from the C API and gives some examples.  If you are not familiar with using libguestfs, you also need to read \fBguestfs\fR\|(3).
.SS python_return_dict=True
.IX Subsection "python_return_dict=True"
All new code should construct the handle using:
.PP
.Vb 1
\& g = guestfs.GuestFS(python_return_dict=True)
.Ve
.PP
This indicates that your program wants to receive Python dicts for methods in the API that return hashtables.
.PP
In a future version of libguestfs, this will become the default.
.SS 例外
.IX Subsection "例外"
Errors from libguestfs functions are mapped into \f(CW\*(C`RuntimeException\*(C'\fR with a single string argument which is the error message.
.SS "MORE DOCUMENTATION"
.IX Subsection "MORE DOCUMENTATION"
Type:
.PP
.Vb 3
\& $ python
\& >>> import guestfs
\& >>> help(guestfs)
.Ve
.SS "USING PYTHON BINDINGS IN A VIRTUALENV"
.IX Subsection "USING PYTHON BINDINGS IN A VIRTUALENV"
These bindings are \fInot\fR available in pypi owing to a licensing problem. See https://bugzilla.redhat.com/1075594 for current status.
.PP
However we do publish a Python distribution for selected stable versions of libguestfs in http://libguestfs.org/download/python.  You can use it like this:
.PP
.Vb 1
\& pip install http://libguestfs.org/download/python/guestfs\-1.XX.YY.tar.gz
.Ve
.SH "例 1: ディスクイメージの作成"
.IX Header "例 1: ディスクイメージの作成"
\&\f(CW@EXAMPLE1\fR@
.SH "例 2: 仮想マシンのディスクイメージの検査"
.IX Header "例 2: 仮想マシンのディスクイメージの検査"
\&\f(CW@EXAMPLE2\fR@
.SH 関連項目
.IX Header "関連項目"
\&\fBguestfs\fR\|(3), \fBguestfs\-examples\fR\|(3), \fBguestfs\-erlang\fR\|(3), \fBguestfs\-gobject\fR\|(3), \fBguestfs\-golang\fR\|(3), \fBguestfs\-java\fR\|(3), \fBguestfs\-lua\fR\|(3), \fBguestfs\-ocaml\fR\|(3), \fBguestfs\-perl\fR\|(3), \fBguestfs\-recipes\fR\|(1), \fBguestfs\-ruby\fR\|(3), http://libguestfs.org/.
.SH 著者
.IX Header "著者"
Richard W.M. Jones (\f(CW\*(C`rjones at redhat dot com\*(C'\fR)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2010\-2023 Red Hat Inc.
.SH LICENSE
.IX Header "LICENSE"
.SH BUGS
.IX Header "BUGS"
To get a list of bugs against libguestfs, use this link:
https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
.PP
To report a new bug against libguestfs, use this link:
https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
.PP
When reporting a bug, please supply:
.IP \(bu 4
The version of libguestfs.
.IP \(bu 4
Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
.IP \(bu 4
Describe the bug accurately and give a way to reproduce it.
.IP \(bu 4
Run \fBlibguestfs\-test\-tool\fR\|(1) and paste the \fBcomplete, unedited\fR
output into the bug report.