hal.files.models package

Submodules

hal.files.models.audio module

Songs in various formats

class hal.files.models.audio.MP3Song(path)

Bases: hal.files.models.system.FileSystem

.mp3 song

get_album()

Gets song’s albu

Returns:album

get_artist()

Gets song’s artist

Returns:artist

get_details()

Finds songs details

Returns:Dictionary with songs details about title, artist, album and year

get_genre()

Gets song’s genre

Returns:genre

get_nr_track()

Gets song’s track number

Returns:# of track

get_title()

Gets song’s title

Returns:title

get_year()

Gets song’s year

Returns:year

static is_valid_mp3(path)

Parameters:path – candidate Returns:True iff song is MP3 encoded

set_album(album)

Sets song’s album

Parameters:album – album

set_artist(artist)

Sets song’s artist

Parameters:artist – artist

set_genre(genre)

Sets song’s genre

Parameters:genre – genre

set_nr_track(nr_track)

Sets song’s track numb

Parameters:nr_track – of track

set_title(name)

Sets song’s title

Parameters:name – title

set_year(year)

Sets song’s year

Parameters:year – year

hal.files.models.audio.find_songs(folder, recursive)

Parameters:

• folder – folder path
• recursive – True want to search recursively

Returns:

generator of) paths of the songs in folder

hal.files.models.files module

Documents and folders in system

class hal.files.models.files.Directory(path)

Bases: hal.files.models.system.FileSystem

Folder of a OS

static create_new(path)

Creates new directory

Parameters:path – path to directory to create

get_path_name()

Gets path and name of file

Returns:Name of path, name of file (or folder)

is_empty()

Checks if folder is empty

Returns:BTrue iff empty

class hal.files.models.files.Document(path)

Bases: hal.files.models.system.FileSystem

File with content in a OS

static extract_name_extension(file_name)

Gets name and extension of file

Parameters:file_name – Name of file Returns:Name of file, extension of file

get_path_name()

Gets path and name of song

Returns:Name of path, name of file (or folder)

is_audio()

Checks if file is audio

Returns:True iff document is an audio

is_image()

Checks if file is image

Returns:True iff document is an image

is_subtitle()

Checks if file is subtitle

Returns:True iff document is a subtitle

is_text()

Checks if file is text

Returns:True iff document is a text file

is_video()

Checks if file is video

Returns:True iff document is a video

static move_file_to_directory(file_path, directory_path)

Moves file to given directory

Parameters:

• file_path – path to file to move
• directory_path – path to target directory where to move file

static move_file_to_file(old_path, new_path)

Moves file from old location to new one

Parameters:

• old_path – path of file to move
• new_path – new path

read_data()

Returns:contents of file

write_data(data)

Writes given data to given path file

Parameters:data – data to write to file

hal.files.models.system module

File system utils, renaming and parsing

class hal.files.models.system.FileSystem(path)

Bases: object

Models a folder/file in a OS

is_archive_mac()

Checks if file is a MAC archive

Returns:True iff document is an MACOSX archive

is_hidden()

Checks if file is hidden

Returns:True iff path is hidden

is_russian()

Checks if file path is russian

Returns:True iff document has a russian name

rename(new_path)

Renames to new path

Parameters:new_path – new path to use

trash()

Trashes given file/folder

hal.files.models.system.extract_name_max_chars(name, max_chars=64, blank=' ')

Extracts max chars in name truncated to nearest word

Parameters:

• name – path to edit
• max_chars – max chars of new name
• blank – char that represents the blank between words

Returns:

Name edited to contain at most max_chars

hal.files.models.system.fix_raw_path(path)

Prettify name of path

Parameters:path – path to fix Returns:Good name for path

hal.files.models.system.get_folder_name(file_path)

Finds name of folder

Parameters:file_path – path Returns:Name of folder

hal.files.models.system.get_parent_folder_name(file_path)

Finds parent folder of file

Parameters:file_path – path Returns:Name of folder container

hal.files.models.system.is_file(path)

Checks if path is file

Parameters:path – path to check Returns:True iff path is a file

hal.files.models.system.is_folder(path)

Checks if path is folder

Parameters:path – path to check Returns:True iff path is a file

hal.files.models.system.list_content(path, recurse, include_hidden=False)

Finds content of folder (recursively)

Parameters:

• path – directory to get list of files and folders
• recurse – True iff recurse into subdirectories or not
• include_hidden – True iff include hidden files in list

Returns:

List of paths in given directory recursively

hal.files.models.system.ls_dir(path, include_hidden=False)

Finds content of folder

Parameters:

• path – directory to get list of files and folders
• include_hidden – True iff include hidden files in list

Returns:

List of paths in given directory

hal.files.models.system.ls_recurse(path, include_hidden=False)

Finds content of folder recursively

Parameters:

• path – directory to get list of files and folders
• include_hidden – True iff include hidden files in list

Returns:

List of paths in given directory recursively

hal.files.models.system.prettify(name, blank=' ')

Prettify name of path

Parameters:

• name – path Name: to edit
• blank – default blanks in name

Returns:

Prettier name from given one: replace bad chars with good ones

hal.files.models.system.remove_brackets(name)

Removes brackets form input

Parameters:name – path to fix Returns:inputs with no brackets

hal.files.models.system.remove_year(name)

Removes year from input

Parameters:name – path to edit Returns:inputs with no years