CTRL + K
Apps
Stories
Agents
Bricks
Constellab Space LogoSpace
Login
Back to bricks list
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

File

RESOURCE
Typing name :  RESOURCE.gws_core.File Brick :  gws_core
Parent :
Fs node

Resource that represents a file in the system.

Technical notes:

/!\ The class that extend file can only have a path and file_store_id attributes. Other attributes will not be provided when creating the resource.

Views
DEFAULT VIEWDefault view
View the file with automatic view
VIEW AS JSON
View the complete resource as json
VIEW FILE CONTENT
View the file content as string
Attributes
file_store_id: strflagged: boolis_symbolic_link: boolname: strpath: strstyle: TypingStyletags: TagListtechnical_info: TechnicalInfoDictuid: str
Functions
__INIT__

Create a new FSNode

path : str - ''
absolute path to the file
ADD_TECHNICAL_INFO

Add technical information on the resource. Technical info are useful to set additional information on the resource.

technical_info : TechnicalInfo
technical information to add (key, value) this is a long description of the technical information
CHECK_IF_EXISTS
CHECK_RESOURCE

You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded

Return type : Optional
CLONE

Clone the resource to create a new instance with a new id. It copies the RFields.

Return type : ResourceType
COPY_TO_DIRECTORY

Copy the node to the directory and keep the same base name

destination : str
the destination directory
Return type : str
COPY_TO_PATH

Copy the file or folder to the destination and rename the base name

destination : str
complete path to the destination
Return type : str
DETECT_FILE_ENCODING

Detect the encoding of the file using charset-normalizer

default_encoding : str - utf-8
default encoding to use if the encoding is not detected
Return type : str
EXISTS
Return type : bool
GET_BASE_NAME

Get the name of the file or folder without the path

Return type : str
GET_DEFAULT_NAME

You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource

Return type : str
GET_DEFAULT_STYLE

Get the default style of the resource

Return type : TypingStyle
GET_DEFAULT_VIEW

Get the default view of the file.

page : int - 1
page number
Return type : View
GET_ICON_FROM_EXTENSION
Return type : Optional
GET_MODEL_ID

Get the id of the resource model in the database. It is provided by the system for input resources of a task.

Return type : str
GET_NAME
Return type : str
GET_NAME_OR_DEFAULT

Get the name of the resource or the default name if the name is None

Return type : str
GET_SIZE
Return type : int
GET_TECHNICAL_INFO

Get the technical information of the resource

key : str
key of the technical information
Return type : TechnicalInfo
GET_VIEW_BY_LINES
start_line : int - 1
Return type : SimpleTextView
INIT

This can be overwritten to perform custom initialization of the resource. This method is called after the init (constructor) of the resource. The values of RFields are set when this method is called.

IS_AUDIO
IS_CSV
IS_EMPTY
Return type : bool
IS_IMAGE
IS_JPG
IS_JSON
IS_PNG
IS_READABLE
Return type : bool
IS_TXT
OPEN

Open the file

mode : str
mode of the file
encoding : str
encoding used to open the file. If none the encoding is automatically detected with charset-normalizer
Return type : Any
READ

Read the file

size : int - -1
size of the file to read
encoding : str
encoding used to read the file. If none the encoding is automatically detected with charset-normalizer
mode : str - r+t
mode of the file
Return type : AnyStr
READ_PART

Read a part of the file

from_line : int - 0
start line
to_line : int - 10
end line (excluded)
encoding : str
encoding used to read the file. If none the encoding is automatically detected with charset-normalizer
mode : str - r+t
mode of the file
Return type : str
WRITE

Write data to the file

data : str
data to write
encoding : str
encoding used to write the file. If none the encoding is automatically detected with charset-normalizer
mode : str - a+t
mode of the file
CLASSNAME - @classmethod

Returns the name of the class

slugify : bool - False
True to slugify the class name if True
snakefy : bool - False
True to snakefy the class name if True
replace_uppercase : bool - False
Replace upper cases by "-" if True
Return type : str
COPY_STYLE - @classmethod

Copy the style of the resource with the possibility to override some properties. Useful when settings the style for a task based on the resource style.

Icon technical name : str
technical name of the icon if provided, the icon_type must also be provided
Icon type : TypingIconType
type of the icon if provided, the icon_technical_name must also be provided
background_color : str
background color
icon_color : TypingIconColor
icon color
Return type : TypingStyle
FULL_CLASSNAME - @classmethod

Returns the full name of the class

slugify : bool - False
Slugify the returned class name if True
snakefy : bool - False
Snakefy the returned class name if True
Return type : str
GET_HUMAN_NAME - @classmethod

Get the human name of the resource

Return type : str
GET_SHORT_DESCRIPTION - @classmethod

Get the short description of the resource

Return type : str
GET_STYLE - @classmethod

Get the style of the resource

Return type : TypingStyle
GET_TYPING_NAME - @classmethod

Get the typing name of the resource

Return type : str
INHERITORS - @classmethod

Get all the classes that inherit this class

Return type : List