| |
Methods defined here:
- __init__(self, always_consistent=False)
- Initialize self. See help(type(self)) for accurate signature.
- add_directory(self, iso_path=None, rr_name=None, joliet_path=None, file_mode=None, udf_path=None)
- Add a directory to the ISO. At least one of an iso_path, joliet_path,
or udf_path must be provided. Providing joliet_path on a non-Joliet
ISO, or udf_path on a non-UDF ISO, is an error. If the ISO contains
Rock Ridge, then a Rock Ridge name must be provided.
Parameters:
iso_path - The ISO9660 absolute path to use for the directory.
rr_name - The Rock Ridge name to use for the directory.
joliet_path - The Joliet absolute path to use for the directory.
file_mode - The POSIX file mode to use for the directory. This only
applies for Rock Ridge ISOs.
udf_path - The UDF absolute path to use for the directory.
Returns:
Nothing.
- add_eltorito(self, bootfile_path, bootcatfile=None, rr_bootcatname=None, joliet_bootcatfile=None, boot_load_size=None, platform_id=0, boot_info_table=False, efi=False, media_name='noemul', bootable=True, boot_load_seg=0, udf_bootcatfile=None)
- Add an El Torito Boot Record, and associated files, to the ISO. The
file that will be used as the bootfile must be passed into this function
and must already be present on the ISO.
Parameters:
bootfile_path - The file to use as the boot file; it must already
exist on this ISO.
bootcatfile - The fake file to use as the boot catalog entry; set to
BOOT.CAT;1 by default.
rr_bootcatname - The Rock Ridge name for the fake file to use as the
boot catalog entry; set to 'boot.cat' by default.
joliet_bootcatfile - The Joliet name for the fake file to use as the
boot catalog entry; set to 'boot.cat' by default.
boot_load_size - The number of sectors to use for the boot entry; if
set to None (the default), the number of sectors will
be calculated.
platform_id - The platform ID to set for the El Torito entry; 0 is for
x86, 1 is for Power PC, 2 is for Mac, and 0xef is for
UEFI. 0 is the default.
boot_info_table - Whether to add a boot info table to the ISO. The
default is False.
efi - Whether this is an EFI entry for El Torito. The default is False.
media_name - The name of the media type, one of 'noemul', 'floppy', or 'hdemul'.
bootable - Whether the boot media is bootable. The default is True.
boot_load_seg - The load segment address of the boot image.
udf_bootcatfile - The name of the boot.cat file on the UDF filesystem.
Returns:
Nothing.
- add_file(self, filename, iso_path=None, rr_name=None, joliet_path=None, file_mode=None, udf_path=None)
- Add a file to the ISO. If the ISO is a Rock Ridge one, then a Rock
Ridge name must also be provided. If the ISO is a Joliet one, then a
Joliet path may also be provided; while it is optional to do so, it is
highly recommended.
Parameters:
filename - The filename to use for the data contents for the new file.
iso_path - The ISO9660 absolute path to the file destination on the ISO.
rr_name - The Rock Ridge name of the file destination on the ISO.
joliet_path - The Joliet absolute path to the file destination on the ISO.
file_mode - The POSIX file_mode to apply to this file. This only
applies if this is a Rock Ridge ISO. If this is None (the
default), the permissions from the original file are used.
udf_path - The UDF name of the file destination on the ISO.
Returns:
Nothing.
- add_fp(self, fp, length, iso_path=None, rr_name=None, joliet_path=None, file_mode=None, udf_path=None)
- Add a file to the ISO. If the ISO is a Rock Ridge one, then a Rock
Ridge name must also be provided. If the ISO is a Joliet one, then a
Joliet path may also be provided; while it is optional to do so, it is
highly recommended. Note that the caller must ensure that 'fp' remains
open for the lifetime of the PyCdlib object, as the PyCdlib class uses
the file descriptor internally when writing (mastering) the ISO. To
have PyCdlib manage this automatically, use 'add_file' instead.
Parameters:
fp - The file object to use for the contents of the new file.
length - The length of the data for the new file.
iso_path - The ISO9660 absolute path to the file destination on the ISO.
rr_name - The Rock Ridge name of the file destination on the ISO.
joliet_path - The Joliet absolute path to the file destination on the ISO.
file_mode - The POSIX file_mode to apply to this file. This only
applies if this is a Rock Ridge ISO. If this is None (the
default), the permissions from the original file are used.
udf_path - The UDF name of the file destination on the ISO.
Returns:
Nothing.
- add_hard_link(self, **kwargs)
- Add a hard link to the ISO. Hard links are alternate names for the
same file contents that don't take up any additional space on the the
ISO. This API can be used to create hard links between two files on
the ISO9660 filesystem, between two files on the Joliet filesystem, or
between a file on the ISO9660 filesystem and the Joliet filesystem.
In all cases, exactly one old path must be specified, and exactly one
new path must be specified.
Note that this is an advanced API, so using it in combination with the
higher-level APIs (like rm_file()) may result in unexpected behavior.
Once this API has been used, this API and rm_hard_link() should be
preferred over add_file() and rm_file(), respectively.
Parameters:
iso_old_path - The old path on the ISO9660 filesystem to link from.
iso_new_path - The new path on the ISO9660 filesystem to link to.
joliet_old_path - The old path on the Joliet filesystem to link from.
joliet_new_path - The new path on the Joliet filesystem to link to.
rr_name - The Rock Ridge name to use for the new file if this is a Rock
Ridge ISO and the new path is on the ISO9660 filesystem.
boot_catalog_old - Use the El Torito boot catalog as the old path.
udf_old_path - The old path on the UDF filesystem to link from.
udf_new_path - The new path on the UDF filesystem to link to.
Returns:
Nothing.
- add_isohybrid(self, part_entry=1, mbr_id=None, part_offset=0, geometry_sectors=32, geometry_heads=64, part_type=None, mac=False, efi=None)
- Make an ISO a 'hybrid', which means that it can be booted either from a
CD or from more traditional media (like a USB stick). This requires
that the ISO already have El Torito, and will use the El Torito boot
file as a bootable image. That image must contain a certain signature
in order to work as a hybrid (if using syslinux, this generally means
the isohdpfx.bin files).
Parameters:
part_entry - The partition entry to use; one by default.
mbr_id - The mbr_id to use. If set to None (the default), a random one
will be generated.
part_offset - The partition offset to use; zero by default.
geometry_sectors - The number of sectors to assign; thirty-two by
default.
geometry_heads - The number of heads to assign; sixty-four by default.
part_type - The partition type to assign; twenty-three by default, but
will automatically be set to 0 if mac or efi are True.
mac - Add support for Mac; False by default.
efi - Add support for EFI; False by default, but will automatically
be set to True if mac is True.
Returns:
Nothing.
- add_joliet_directory(self, joliet_path)
- (deprecated) Add a directory to the Joliet portion of the ISO. Since
Joliet occupies a completely different context than ISO9660, this
method can be invoked to create a completely different directory
structure in the Joliet context, though that is generally not advised.
It is recommended to use the 'joliet_path' argument of the
'add_directory' instead of this method.
Parameters:
joliet_path - The Joliet directory to create.
Returns:
Nothing.
- add_symlink(self, symlink_path=None, rr_symlink_name=None, rr_path=None, joliet_path=None, udf_symlink_path=None, udf_target=None)
- Add a symlink from rr_symlink_name to the rr_path. The ISO must have
either Rock Ridge or UDF support (or both).
Parameters:
symlink_path - The ISO9660 path of the symlink itself on the ISO.
rr_symlink_name - The Rock Ridge name of the symlink itself on the ISO.
rr_path - The path that the symlink points to on the Rock Ridge part
of the ISO.
joliet_path - The Joliet path of the symlink (if this ISO has Joliet).
udf_symlink_path - The UDF path of the symlink itself on the ISO.
udf_target - The UDF name of the entry on the ISO that the symlink
points to.
Returns:
Nothing.
- clear_hidden(self, iso_path=None, rr_path=None, joliet_path=None)
- Clear the ISO9660 hidden attribute on a file or directory. This will
cause the file or directory to show up when listing entries on the ISO.
Exactly one of iso_path, rr_path, or joliet_path must be specified.
Parameters:
iso_path - The path on the ISO to clear the hidden bit from.
rr_path - The Rock Ridge path on the ISO to clear the hidden bit from.
joliet_path - The Joliet path on the ISO to clear the hidden bit from.
Returns:
Nothing.
- close(self)
- Close the PyCdlib object, and re-initialize the object to the defaults.
The object can then be re-used for manipulation of another ISO.
Parameters:
None.
Returns:
Nothing.
- duplicate_pvd(self)
- Add a duplicate PVD to the ISO. This is a mostly useless feature
allowed by Ecma-119 to have duplicate PVDs to avoid possible corruption.
Parameters:
None.
Returns:
Nothing.
- file_mode(self, **kwargs)
- Get the POSIX file mode of the file if is a Rock Ridge file.
Parameters:
iso_path - The absolute ISO path to the file on the ISO.
rr_path - The absolute Rock Ridge path to the file on the ISO.
joliet_path - The absolute Joliet path to the file on the ISO.
udf_path - The absolute UDF path to the file on the ISO.
Returns:
An integer representing the POSIX file mode of the file if it is Rock
Ridge, or None otherwise.
- force_consistency(self)
- Make sure the ISO object is fully consistent. PyCdlib typically delays
doing work until it is necessary, and this detail is usually hidden
from users. However, there are times that a user may want a fully
consistent view of the ISO without calling one of the methods that
forces consistency. This method allows the user to force a consistent
view of this object.
Parameters:
None.
Returns:
Nothing.
- full_path_from_dirrecord(self, rec, rockridge=False)
- Get the absolute path of a directory record.
Parameters:
rec - The directory record to get the full path for.
rockridge - Whether to get the rock ridge full path.
Returns:
A string representing the absolute path to the file on the ISO.
- get_and_write(self, iso_path, local_path, blocksize=8192)
- (deprecated) Fetch a single file from the ISO and write it out to the
specified file. Note that this will overwrite the contents of the local
file if it already exists. Also note that 'iso_path' must be an
absolute path to the file. Finally, the 'iso_path' can be an ISO9660
path, a Rock Ridge path, or a Joliet path. In the case of ambiguity,
the Joliet path is tried first, followed by the ISO9660 path, followed
by the Rock Ridge path. It is recommended to use the get_file_from_iso
API instead to resolve this ambiguity.
Parameters:
iso_path - The absolute path to the file to get data from.
local_path - The local filename to write the contents to.
blocksize - The blocksize to use when copying data; the default is 8192.
Returns:
Nothing.
- get_and_write_fp(self, iso_path, outfp, blocksize=8192)
- (deprecated) Fetch a single file from the ISO and write it out to the
file object. Note that 'iso_path' must be an absolute path to the file.
Also note that the 'iso_path' can be an ISO9660 path, a Rock Ridge path,
or a Joliet path. In the case of ambiguity, the Joliet path is tried
first, followed by the ISO9660 path, followed by the Rock Ridge path.
It is recommend to use the get_file_from_iso_fp API instead to resolve
this ambiguity.
Parameters:
iso_path - The absolute path to the file to get data from.
outfp - The file object to write data to.
blocksize - The blocksize to use when copying data; the default is 8192.
Returns:
Nothing.
- get_entry(self, iso_path, joliet=False)
- (deprecated) Get the directory record for a particular path. It is
recommended to use the 'get_record' API instead.
Parameters:
iso_path - The path on the ISO to look up information for.
joliet - Whether to look for the path in the Joliet portion of the ISO.
Returns:
A dr.DirectoryRecord object representing the path.
- get_file_from_iso(self, local_path, **kwargs)
- Fetch a single file from the ISO and write it out to a local file.
Parameters:
local_path - The local file to write to.
blocksize - The number of bytes in each transfer.
iso_path - The absolute ISO9660 path to lookup on the ISO (exclusive
with rr_path, joliet_path, and udf_path).
rr_path - The absolute Rock Ridge path to lookup on the ISO (exclusive
with iso_path, joliet_path, and udf_path).
joliet_path - The absolute Joliet path to lookup on the ISO (exclusive
with iso_path, rr_path, and udf_path).
udf_path - The absolute UDF path to lookup on the ISO (exclusive with
iso_path, rr_path, and joliet_path).
Returns:
Nothing.
- get_file_from_iso_fp(self, outfp, **kwargs)
- Fetch a single file from the ISO and write it out to the file object.
Parameters:
outfp - The file object to write data to.
blocksize - The number of bytes in each transfer.
iso_path - The absolute ISO9660 path to lookup on the ISO (exclusive
with rr_path, joliet_path, and udf_path).
rr_path - The absolute Rock Ridge path to lookup on the ISO (exclusive
with iso_path, joliet_path, and udf_path).
joliet_path - The absolute Joliet path to lookup on the ISO (exclusive
with iso_path, rr_path, and udf_path).
udf_path - The absolute UDF path to lookup on the ISO (exclusive with
iso_path, rr_path, and joliet_path).
Returns:
Nothing.
- get_iso9660_facade(self)
- Return a 'facade' that simplifies some of the complexities of the
PyCdlib class, while giving up some of the full power. This facade
only allows manipulation of the ISO9660 portions of the ISO.
Parameters:
None.
Returns:
A PyCdlibISO9660 object that can be used to interact with the ISO.
- get_joliet_facade(self)
- Return a 'facade' that simplifies some of the complexities of the
PyCdlib class, while giving up some of the full power. This facade
only allows manipulation of the Joliet portions of the ISO.
Parameters:
None.
Returns:
A PyCdlibJoliet object that can be used to interact with the ISO.
- get_record(self, **kwargs)
- Get the directory record for a particular path.
Parameters:
iso_path - The absolute path on the ISO9660 filesystem to get the
record for.
rr_path - The absolute path on the Rock Ridge filesystem to get the
record for.
joliet_path - The absolute path on the Joliet filesystem to get the
record for.
udf_path - The absolute path on the UDF filesystem to get the record
for.
Returns:
An object that represents the path. This may be a dr.DirectoryRecord
object (in the cases of iso_path, rr_path, or joliet_path), or a
udf.UDFFileEntry object (in the case of udf_path).
- get_rock_ridge_facade(self)
- Return a 'facade' that simplifies some of the complexities of the
PyCdlib class, while giving up some of the full power. This facade
only allows manipulation of the Rock Ridge portions of the ISO.
Parameters:
None.
Returns:
A PyCdlibRockRidge object that can be used to interact with the ISO.
- get_udf_facade(self)
- Return a 'facade' that simplifies some of the complexities of the
PyCdlib class, while giving up some of the full power. This facade
only allows manipulation of the UDF portions of the ISO.
Parameters:
None.
Returns:
A PyCdlibUDF object that can be used to interact with the ISO.
- has_joliet(self)
- Returns whether this ISO has Joliet extensions.
Parameters:
None.
Returns:
True if this ISO has Joliet, False otherwise.
- has_rock_ridge(self)
- Returns whether this ISO has Rock Ridge extensions.
Parameters:
None.
Returns:
True if this ISO has Rock Ridge extensions, False otherwise.
- has_udf(self)
- Returns whether this ISO has UDF extensions.
Parameters:
None.
Returns:
True if this ISO has UDF, False otherwise.
- list_children(self, **kwargs)
- Generate a list of all of the file/directory objects in the
specified location on the ISO.
Parameters:
iso_path - The absolute path on the ISO to list the children for.
rr_path - The absolute Rock Ridge path on the ISO to list the children for.
joliet_path - The absolute Joliet path on the ISO to list the children for.
udf_path - The absolute UDF path on the ISO to list the children for.
Yields:
Children of this path.
Returns:
Nothing.
- list_dir(self, iso_path, joliet=False)
- (deprecated) Generate a list of all of the file/directory objects in the
specified location on the ISO. It is recommended to use the
'list_children' API instead.
Parameters:
iso_path - The path on the ISO to look up information for.
joliet - Whether to look for the path in the Joliet portion of the ISO.
Yields:
Children of this path.
Returns:
Nothing.
- modify_file_in_place(self, fp, length, iso_path, rr_name=None, joliet_path=None, udf_path=None)
- An API to modify a file in place on the ISO. This can be extremely fast
(much faster than calling the write method), but has many restrictions.
1. The original ISO file pointer must have been opened for reading
and writing.
2. Only an existing *file* can be modified; directories cannot be
changed.
3. Only an existing file can be *modified*; no new files can be added
or removed.
4. The new file contents must use the same number of extents (typically
2048 bytes) as the old file contents. If using this API to shrink
a file, this is usually easy since the new contents can be padded
out with zeros or newlines to meet the requirement. If using this
API to grow a file, the new contents can only grow up to the next
extent boundary.
Unlike all other APIs in PyCdlib, this API actually modifies the
originally opened on-disk file, so use it with caution.
Parameters:
fp - The file object to use for the contents of the new file.
length - The length of the new data for the file.
iso_path - The ISO9660 absolute path to the file destination on the ISO.
rr_name - The Rock Ridge name of the file destination on the ISO.
joliet_path - The Joliet absolute path to the file destination on the ISO.
udf_path - The UDF absolute path to the file destination on the ISO.
Returns:
Nothing.
- new(self, interchange_level=1, sys_ident='', vol_ident='', set_size=1, seqnum=1, log_block_size=2048, vol_set_ident=' ', pub_ident_str='', preparer_ident_str='', app_ident_str='', copyright_file='', abstract_file='', bibli_file='', vol_expire_date=None, app_use='', joliet=None, rock_ridge=None, xa=False, udf=None)
- Create a new ISO from scratch.
Parameters:
interchange_level - The ISO9660 interchange level to use; this dictates
the rules on the names of files. Levels 1, 2, 3,
and 4 are supported. Level 1 is the most
conservative, and is the default, but level 3 is
recommended.
sys_ident - The system identification string to use on the new ISO.
vol_ident - The volume identification string to use on the new ISO.
set_size - The size of the set of ISOs this ISO is a part of.
seqnum - The sequence number of the set of this ISO.
log_block_size - The logical block size to use for the ISO. While ISO9660
technically supports sizes other than 2048 (the default),
this almost certainly doesn't work.
vol_set_ident - The volume set identification string to use on the new ISO.
pub_ident_str - The publisher identification string to use on the new ISO.
preparer_ident_str - The preparer identification string to use on the new ISO.
app_ident_str - The application identification string to use on the new ISO.
copyright_file - The name of a file at the root of the ISO to use as the
copyright file.
abstract_file - The name of a file at the root of the ISO to use as the
abstract file.
bibli_file - The name of a file at the root of the ISO to use as the
bibliographic file.
vol_expire_date - The date that this ISO will expire at.
app_use - Arbitrary data that the application can stuff into the primary
volume descriptor of this ISO.
joliet - A integer that can have the value 1, 2, or 3 for Joliet
levels 1, 2, or 3 (3 is by far the most common), or None for
no Joliet support (the default). For legacy reasons, this
parameter also accepts a boolean, where the value of 'False'
means no Joliet and a value of 'True' means level 3.
rock_ridge - Whether to make this ISO have the Rock Ridge extensions or
not. The default value of None does not add Rock Ridge
extensions. A string value of '1.09', '1.10', or '1.12'
adds the specified Rock Ridge version to the ISO. If
unsure, pass '1.09' to ensure maximum compatibility.
xa - Whether to add the ISO9660 Extended Attribute extensions to this
ISO. The default is False.
udf - Whether to add UDF support to this ISO. If it is None (the
default), no UDF support is added. If it is "2.60", version 2.60
of the UDF spec is used. All other values are disallowed.
Returns:
Nothing.
- open(self, filename, mode='rb')
- Open up an existing ISO for inspection and modification.
Parameters:
filename - The filename containing the ISO to open up.
mode - The mode to use when opening the ISO file; the default is 'rb'.
Returns:
Nothing.
- open_file_from_iso(self, **kwargs)
- Open a file for reading in a context manager. This allows the user to
operate on the file in user-defined chunks (utilizing the read() method
of the returned context manager).
Parameters:
iso_path - The absolute ISO path to the file on the ISO.
rr_path - The absolute Rock Ridge path to the file on the ISO.
joliet_path - The absolute Joliet path to the file on the ISO.
udf_path - The absolute UDF path to the file on the ISO.
Returns:
A PyCdlibIO object allowing access to the file.
- open_fp(self, fp)
- Open up an existing ISO for inspection and modification. Note that the
file object passed in here must stay open for the lifetime of this
object, as the PyCdlib class uses it internally to do writing and reading
operations. To have PyCdlib manage this automatically, use 'open'
instead.
Parameters:
fp - The file object containing the ISO to open up.
Returns:
Nothing.
- rm_directory(self, iso_path=None, rr_name=None, joliet_path=None, udf_path=None)
- Remove a directory from the ISO. The directory must be empty.
Parameters:
iso_path - The path to the directory to remove.
rr_name - The Rock Ridge name of the directory to remove.
joliet_path - The Joliet path to the directory to remove.
udf_path - The UDF absolute path to the directory to remove.
Returns:
Nothing.
- rm_eltorito(self)
- Remove the El Torito boot record (and Boot Catalog) from the ISO.
Parameters:
None.
Returns:
Nothing.
- rm_file(self, iso_path=None, rr_name=None, joliet_path=None, udf_path=None)
- Remove a file from the ISO. This removes the data and the listing of
the file from all contexts, even when only one path is given (to only
remove it from a single context, use rm_hard_link() instead). Due to
some complexities of the ISO format, removal of zero-byte files from all
contexts does not automatically happen, so this method may need to be
called more than once for zero-byte files.
Parameters:
iso_path - The path to the file to remove.
rr_name - The Rock Ridge name of the file to remove.
joliet_path - The Joliet path to the file to remove.
udf_path - The UDF path to the file to remove.
Returns:
Nothing.
- rm_hard_link(self, iso_path=None, joliet_path=None, udf_path=None)
- Remove a hard link from the ISO. If the number of links to a piece of
data drops to zero, then the contents will be removed from the ISO.
This can be thought of as a lower-level interface to rm_file(). Either
an ISO9660 path or a Joliet path must be passed to this API, but not
both. Thus, this interface can be used to hide files from either the
ISO9660 filesystem, the Joliet filesystem, or both (if there is another
reference to the data on the ISO, such as in El Torito). Note that this
is an advanced API, so using it in combination with the higher-level APIs
(like rm_file()) may result in unexpected behavior. Once this API has
been used, this API and add_hard_link() should be preferred over
rm_file() and add_file().
Parameters:
iso_path - The ISO link path to remove.
joliet_path - The Joliet link path to remove.
udf_path - The UDF link path to remove.
Returns:
Nothing.
- rm_isohybrid(self)
- Remove the 'hybridization' of an ISO, making it a traditional ISO again.
This means the ISO will no longer be able to be copied and booted off
of traditional media (like USB sticks).
Parameters:
None.
Returns:
Nothing.
- rm_joliet_directory(self, joliet_path)
- (deprecated) Remove a Joliet directory from the ISO. It is recommended
to use the 'joliet_path' parameter to 'rm_directory' instead.
Parameters:
joliet_path - The Joliet path to the directory to remove.
Returns:
Nothing.
- set_hidden(self, iso_path=None, rr_path=None, joliet_path=None)
- Set the ISO9660 hidden attribute on a file or directory. This will
cause the file or directory not to show up when listing entries on the
ISO. Exactly one of iso_path, rr_path, or joliet_path must be specified.
Parameters:
iso_path - The path on the ISO to set the hidden bit on.
rr_path - The Rock Ridge path on the ISO to set the hidden bit on.
joliet_path - The Joliet path on the ISO to set the hidden bit on.
Returns:
Nothing.
- set_relocated_name(self, name, rr_name)
- Set the name of the relocated directory on a Rock Ridge ISO. The ISO
must be a Rock Ridge one, and must not have previously had the relocated
name set.
Parameters:
name - The name for a relocated directory.
rr_name - The Rock Ridge name for a relocated directory.
Returns:
Nothing.
- walk(self, **kwargs)
- Walk the entries on the ISO, starting at the given path. One, and only
one, of iso_path, rr_path, joliet_path, and udf_path is allowed.
Similar to os.walk(), yield a 3-tuple of (path-to-here, dirlist, filelist)
for each directory level.
Parameters:
iso_path - The absolute ISO path to the starting entry on the ISO.
rr_path - The absolute Rock Ridge path to the starting entry on the ISO.
joliet_path - The absolute Joliet path to the starting entry on the ISO.
udf_path - The absolute UDF path to the starting entry on the ISO.
Yields:
3-tuples of (path-to-here, dirlist, filelist)
Returns:
Nothing.
- write(self, filename, blocksize=32768, progress_cb=None, progress_opaque=None)
- Write a properly formatted ISO out to the filename passed in. This
also goes by the name of 'mastering'.
Parameters:
filename - The filename to write the data to.
blocksize - The blocksize to use when copying data; the default is 32768.
progress_cb - If not None, a function to call as the write call does its
work. The callback function must have a signature of:
def func(done, total, opaque).
progress_opaque - User data to be passed to the progress callback; the
default is None.
Returns:
Nothing.
- write_fp(self, outfp, blocksize=32768, progress_cb=None, progress_opaque=None)
- Write a properly formatted ISO out to the file object passed in. This
also goes by the name of 'mastering'.
Parameters:
outfp - The file object to write the data to.
blocksize - The blocksize to use when copying data; the default is 32768.
progress_cb - If not None, a function to call as the write call does its
work. The callback function must have a signature of:
def func(done, total, opaque).
progress_opaque - User data to be passed to the progress callback; the
default is None.
Returns:
Nothing.
Data descriptors defined here:
- brs
- eltorito_boot_catalog
- enhanced_vd
- inodes
- interchange_level
- isohybrid_mbr
- joliet_vd
- logical_block_size
- pvd
- pvds
- rock_ridge
- svds
- udf_anchors
- udf_beas
- udf_boots
- udf_file_set
- udf_file_set_terminator
- udf_logical_volume_integrity
- udf_logical_volume_integrity_terminator
- udf_main_descs
- udf_nsr
- udf_reserve_descs
- udf_root
- udf_teas
- vdsts
- version_vd
- xa
|