Folder

Folder module for dost. This module contains functions for working with folders and files.

Examples:

>>> from dost import folder
>>> folder.create_folder(path='tests\demo')
>>> folder.delete_folder(path='tests\demo')

It contains the following functions:

• create_folder(path): Create a folder at the given path.
• delete_folder(path): Delete a folder at the given path.
• rename_folder(path, new_name): Rename a folder at the given path.
• copy_folder(source, destination): Copy a folder from the source to the destination.
• move_folder(source, destination): Move a folder from the source to the destination.
• get_size(path) -> int: Get the size of a folder in bytes.
• get_size_human(path) -> str: Get the size of a folder in human readable format.
• get_contents(path) -> list: Get a list of all files and folders in a folder.
• get_contents_recursive(path) -> list: Get a list of all files and folders in a folder and all subfolders.

copy_folder(source, destination)

Copy a folder from the source to the destination.

Parameters:

Name	Type	Description	Default
source	str || WindowsPath	The path to the source folder.	required
destination	str || WindowsPath	The path to the destination folder.	required

Examples:

>>> folder.copy_folder(source='tests\demo',destination= 'tests\demo2')
>>> os.path.exists('tests\demo2')
True

create_folder(path)

Create a folder at the given path.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required

Examples:

>>> folder.create_folder(path='tests\demo')
>>> os.path.exists('tests\demo')
True

delete_folder(path)

Delete a folder at the given path.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required

Examples:

>>> folder.delete_folder(path='tests\demo')
>>> os.path.exists('tests\demo')
False

get_contents(path)

Get a list of all files and folders in a folder.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required

Returns:

Name	Type	Description
list	list	A list of all files and folders in the folder.

Examples:

>>> folder.get_contents(path='tests')
['demo', 'demo2', 'demo.txt']

get_contents_recursive(path)

Get a list of all files and folders in a folder and all subfolders.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required

Returns:

Name	Type	Description
list	list	A list of all files and folders in the folder and all subfolders.

Examples:

>>> folder.get_contents_recursive(path='tests')
['demo', 'demo2', 'demo.txt']

get_size(path)

Get the size of a folder in bytes.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required

Returns:

Name	Type	Description
int	int	The size of the folder in bytes.

Examples:

>>> folder.get_size(path='tests')
0

get_size_human(path)

Get the size of a folder in human readable format.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required

Returns:

Name	Type	Description
str	str	The size of the folder in human readable format.

Examples:

>>> folder.get_size_human(path='tests')
'0 bytes'

move_folder(source, destination)

Move a folder from the source to the destination.

Parameters:

Name	Type	Description	Default
source	str || WindowsPath	The path to the source folder.	required
destination	str || WindowsPath	The path to the destination folder.	required

Examples:

>>> folder.move_folder(source='tests\demo', destination='tests\demo2')
>>> os.path.exists('tests\demo')
False
>>> os.path.exists('tests\demo2')
True

rename_folder(path, new_name)

Rename a folder at the given path.

Parameters:

Name	Type	Description	Default
path	str || WindowsPath	The path to the folder.	required
new_name	str	The new name of the folder.	required

Examples:

>>> folder.rename_folder(path='tests\demo', new_name='demo2')
>>> os.path.exists('tests\demo2')
True