almalinux/pungi
14
1
Fork 0
Code Issues Pull Requests Releases Activity

[media-split] Add code documentation

Browse Source 
Add a docstring to MediaSplitter class explaining what it does and how
to use it.

Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
This commit is contained in:
Lubomír Sedlář 2016-06-01 14:05:49 +02:00
parent 97f9cc9abc
commit 79035ea7e6
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pungi/media_split.py
View File

@ -53,6 +53,15 @@ def convert_file_size(size, block_size=2048):
class MediaSplitter(object): class MediaSplitter(object):
"""
MediaSplitter splits files so that they fit on a media of given size.
Each file added to the spliter has a size in bytes that will be rounded to
the nearest multiple of block size. If the file is sticky, it will be
included on each disk. The files will be on disks in the same order they
are added; there is no re-ordering. The number of disk is thus not the
possible minimum.
"""
def __init__(self, media_size, compose=None): def __init__(self, media_size, compose=None):
self.media_size = convert_media_size(media_size) self.media_size = convert_media_size(media_size)
self.files = [] # to preserve order self.files = [] # to preserve order