FileHelper - gws_core

Class containing only classmethod to simplify file management

Functions

CLEAN_EXTENSION - @classmethod

Return the extension of a file without the '.' if it is present on first caracter

Parameters:

Name	Type	Default value	Description
extension	`str`		Extension of the file

Return type:

str

COPY_DIR - @classmethod

Copy a directory from source to destination

Parameters:

Name	Type	Default value	Description
source_path	`Union`		Source directory path pathtype
destination_path	`Union`		Destination directory path pathtype

COPY_DIR_CONTENT_TO_DIR - @classmethod

Copy the content of a directory to another directory

Parameters:

Name	Type	Default value	Description
source_dir_path	`Union`		Source directory path pathtype
destination_dir_path	`Union`		Destination directory path pathtype

COPY_FILE - @classmethod

Copy a file from source to destination

Parameters:

Name	Type	Default value	Description
source_path	`Union`		Source file path pathtype
destination_path	`Union`		Destination file path pathtype

COPY_NODE - @classmethod

Copy a file or a directory from source to destination

Parameters:

Name	Type	Default value	Description
source_path	`Union`		Source file or directory path pathtype
destination_path	`Union`		Destination file or directory path pathtype

CREATE_DIR_IF_NOT_EXIST - @classmethod

Create a directory and all intermediate directories if they do not exist

Parameters:

Name	Type	Default value	Description
dir_path	`Union`		Path to the directory pathtype

Return type:

Path

CREATE_EMPTY_FILE_IF_NOT_EXIST - @classmethod

Create an empty file if it does not exist. Creates intermediate directories if needed.

Parameters:

Name	Type	Default value	Description
file_path	`Union`		Path to the file pathtype

Return type:

Path

CREATE_FILE_RESPONSE - @classmethod

Create a FastAPI FileResponse from a file path

:raises FileNotFoundError: if the file does not exist

Parameters:

Name	Type	Description
file_path	`Union`	Path to the file pathtype
filename	`str`	Name of the file, defaults to none , optional
media_type	`str`	Media type of the file, defaults to none , optional

Return type:

FileResponse

DELETE_DIR - @classmethod

Delete a directory and all its content

Parameters:

Name	Type	Default value	Description
dir_path	`Union`		Path to the directory pathtype
ignore_errors	`bool`	True	If true, do not raise an exception if the directory does not exist, defaults to true , optional

DELETE_DIR_CONTENT - @classmethod

Delete all the content of a directory but not the directory itself.

Parameters:

Name	Type	Default value	Description
dir_path	`Union`		Path to the directory to empty pathtype
ignore_errors	`bool`	True	If true, do not raise an exception if the directory does not exist, defaults to true , optional

DELETE_FILE - @classmethod

Delete a file

Parameters:

Name	Type	Default value	Description
file_path	`Union`		Path to the file pathtype
ignore_errors	`bool`	True	If true, do not raise an exception if the file does not exist, defaults to true , optional

DELETE_NODE - @classmethod

Delete a file or a directory

Parameters:

Name	Type	Default value	Description
node_path	`Union`		Path to the file or directory pathtype
ignore_errors	`bool`	True	If true, do not raise an exception if the node does not exist, defaults to true , optional

DETECT_FILE_ENCODING - @classmethod

Detect the encoding of a file using charset-normalizer.

Parameters:

Name	Type	Default value	Description
file_path	`Union`		Path to the file pathtype
default_encoding	`str`	utf-8	Default encoding to use if the encoding is not detected, defaults to 'utf-8' , optional

Return type:

str

EXISTS_ON_OS - @classmethod

Exist on local machine

Parameters:

Name	Type	Default value	Description
path	`Union`

GET_DIR - @classmethod

Return the parent directory of a file or a folder

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the file or folder pathtype

Return type:

Path

GET_DIR_CONTENT_AS_JSON - @classmethod

Return the content of a directory as a json nested object.

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the directory pathtype

Return type:

Any

GET_DIR_NAME - @classmethod

Return the name of the folder. If the path is a file, return the name of the parent folder. If the path is a folder, return the name of the folder.

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the file or folder pathtype

GET_EXTENSION - @classmethod

Return the extension of a file without the '.'. Return None if no extension is found (like folder).

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the file or folder pathtype

Return type:

str

GET_EXTENSION_FROM_CONTENT_TYPE - @classmethod

Return the extension of a file from its content type

Parameters:

Name	Type	Default value	Description
content_type	`str`		Content type of the file

Return type:

str

GET_FILE_SIZE_PRETTY_TEXT - @classmethod

Return a human readable size from a size in bytes. Ex : 1024 -> 1 KB

Parameters:

Name	Type	Default value	Description
size	`float`		Size in bytes

Return type:

str

GET_MIME - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

str

GET_NAME - @classmethod

Return the name of the file without the extension or the name of the folder

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the file or folder pathtype

GET_NAME_WITH_EXTENSION - @classmethod

Return the name of the file with the extension or the name of the folder

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the file or folder pathtype

GET_PATH - @classmethod

Return a Path object from a string or a Path object

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to convert pathtype

Return type:

Path

GET_SIZE - @classmethod

Return the size of a file or a folder. For folder, it is the sum of the size of all files in the folder (recursive).

Parameters:

Name	Type	Default value	Description
path	`Union`		Path to the file or folder pathtype

Return type:

int

IS_AUDIO - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_CSV - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_DIR - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_FILE - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_IMAGE - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_JPG - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_JSON - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_PNG - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

IS_TXT - @classmethod

Parameters:

Name	Type	Default value	Description
path	`Union`

Return type:

bool

MOVE_FILE_OR_DIR - @classmethod

Move a file or a directory from source to destination

Parameters:

Name	Type	Default value	Description
source_path	`Union`		Source file or directory path pathtype
destination_path	`Union`		Destination file or directory path pathtype

SANITIZE_NAME - @classmethod

Sanitize a file name, folder name or path in order to prevent injection when using the file name Basically, it keeps only the alphanumeric characters and -,_,,/

Parameters:

Name	Type	Default value	Description
name	`str`		Name to sanitize

Return type:

str

GENERATE_UNIQUE_FS_NODE_FOR_DIR - @staticmethod

Generate a unique fs node name for a list of node names. Append _1, _2... before the extension if the str is already in the list. Useful to avoid name collision when adding a file to a directory.

Parameters:

Name	Type	Default value	Description
fs_node_name	`str`		Name of the new fs node
dir_path	`str`		Path to the directory

Return type:

str

GENERATE_UNIQUE_FS_NODE_FOR_LIST - @staticmethod

Generate a unique fs node name for a list of node names. Append _1, _2... before the extension if the str is already in the list. Useful to avoid name collision when adding a file to a directory.

Parameters:

Name	Type	Default value	Description
list_fs_node_names	`List`		List of existing fs node names [str]
fs_node_name	`str`		Name of the new fs node

Return type:

str