fmutils 0.1.5

Package for easily accessing and managing large number of files and dirs (e.g. in ML datasets).

File Management Utilities (fmutils)

For easily accessing and managing large number of files and dirs in ML datasets.

Updates

version 0.1.4 includes some more functions

• rename_wrt_dirname
• filename_replacer
• plot_data_dist

Implemented Functions

class DirectoryTree generator.

[source][usage]

generates a dir tree displaying the full structure of the root dir, showing all the sub-dirs and the files.

Parameters:

• root_dir – absolute/relative path to root directory containing all files.
• dir_only – whether to only show sub-dirs in the dir-tree (excluding the files inside of each dir and sub-dir, good for getting an overview of large databases). The default is False.
• write_tree – write the full dir-tree in a txt file in current working dir. The default is True.

Returns:

None.

get_all_files(main_dir, sort=True)

[source][usage]

returns the list of all files inside the root dir.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.
• sort – wether to sort the output lost in Alphabetical order.

Returns:

list containing full paths of all files..

get_all_dirs(main_dir, sort=True)

[source][usage]

returns the list of all the sub-dirs inside the root dir.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.
• sort – wether to sort the output lost in Alphabetical order.

Returns:

list containing full paths of all sub directories in root.

get_num_of_files(main_dir)

[source][usage]

counts the number of files inside each sub-dir of the root.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.

Returns:

A Dictionary containing follwoing keys/info;

files_in_sub_dirs – an array containing number of file in all sub dirs of root.

sub_dirs – name of all the sub-dirs/classes inside the root.

total_files – total number of files in all the sub-dir/classes.

get_basename(full_path, include_extension=True)

[source][usage]

returns the basename of the file or the dir name at end of given path. In case of file you can choose wether to include the extension or not.

Parameters:

• full_path – absolute/relative path to root directory containing all files.
• include_extension – if the input full_path leads to file the by default the the file's extension in included in output string.

Returns:

name of the file with/without extension or the base dir.

get_random_files(main_dir, count=1)

[source][usage]

returns a list of randomly selected files from the root dir.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.
• count – the number of files to get from root and its sub-dir.

Returns:

list containing full paths to randomly selected files.

rename_wrt_dirname(main_dir)

[source][usage]

Change the names of all files inside the main_dir w.r.t their sub_dir names.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.

Returns:

None.

file_name_replacer(data_dir, new_name, name2replace)

[source][usage]

Changes the names of all files inside a dir by replacing the specific strings in old file name with new ones, specified via 2 input lists.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.
• new_name – list containing the new names which will replace the old ones..
• name2replace – list containing the strings which will be replaced wiht new ones.

Returns:

None.

del_all_files(main_dir, confirmation=True)

[source][usage]

delete all files from root and all its sub-dirs.

Parameters:

• main_dir – absolute/relative path to root directory containing all files.
• confirmation – confirm before deleting the files.

Returns:

None.

plot_data_dist(main_dir)

[source][usage]

Plots the bargaph showing number of files in all the sub dir of main dir.

Parameters:

• main_dir – main directory which contains all the classes.

Returns:

None. just plots (bargrpah) the data distribution graph

Usage

For further details and more examples visit my github