Login
Back to bricks list
Introduction Version

NetworkFile

RESOURCE
Typing name :  RESOURCE.gws_gena.NetworkFile Brick :  gws_gena v
Parent :
File

Metabolic network file

File class.

/!\ 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 VIEW - default_view()Default view
View the file with automatic view
VIEW AS JSON - view_as_json()
View the complete resource as json
NETWORK - view_as_network()
REACTION TABLE - view_as_table()
VIEW FILE CONTENT - view_content_as_str()
View the file content as string

Functions

__INIT__

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.

Parameters:
NameTypeDefault valueDescription
pathstr ''
ADD_TECHNICAL_INFO

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

Parameters:
NameTypeDefault valueDescription
technical_infoTechnicalInfo Technical information to add (key, value)
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:
Union[str, NoneType]
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

Parameters:
NameTypeDefault valueDescription
destinationstr _description_
Return type:
str
COPY_TO_PATH

Copy the file to the target path

Parameters:
NameTypeDefault valueDescription
destinationstr
Return type:
str
DETECT_FILE_ENCODING
Parameters:
NameTypeDefault valueDescription
default_encodingstr utf-8
Return type:
str
EXISTS
GET_BASE_NAME
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_VIEW
Parameters:
NameTypeDefault valueDescription
pageint 1
Return type:
View
GET_SIZE
Return type:
int
GET_TECHNICAL_INFO

Get the technical information of the resource

Parameters:
NameTypeDefault valueDescription
keystr Key of the technical information
Return type:
TechnicalInfo
GET_VIEW_BY_LINES
Parameters:
NameTypeDefault valueDescription
start_lineint 1
Return type:
SimpleTextView
INIT

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

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

Open the file

Parameters:
NameTypeDefault valueDescription
modestr
encodingstr None
Return type:
Any
READ
Parameters:
NameTypeDefault valueDescription
sizeint -1
Return type:
AnyStr
READ_PART
Parameters:
NameTypeDefault valueDescription
from_lineint 0
to_lineint 10
Return type:
str
WRITE

Write in the file

Parameters:
NameTypeDefault valueDescription
datastr