Skip to content

Fileread

flowtask.components.FileRead

FileRead

FileRead(loop=None, job=None, stat=None, **kwargs)

Bases: FileBase, PandasDataframe

FileRead.

**Overview**

Read an String File and returned as string (non-binary)


.. table:: Properties
:widths: auto

+---------------------+----------+-------------------------------------------------------------------------------------------------------+ | Name | Required | Description | +---------------------+----------+-------------------------------------------------------------------------------------------------------+ | directory (str) | Yes | Path to the directory containing the files to be listed. | +---------------------+----------+-------------------------------------------------------------------------------------------------------+ | pattern (str) | No | Optional glob pattern for filtering files (overrides individual files if provided). | +---------------------+----------+-------------------------------------------------------------------------------------------------------+ | filename (str) | No | Name of the files | +---------------------+----------+-------------------------------------------------------------------------------------------------------+ | file (dict) | No | A dictionary containing two values, "pattern" and "value", "pattern" and "value", | | | | "pattern" contains the path of the file on the server, If it contains the mask "{value}", | | | | then "value" is used to set the value of that mask | +---------------------+----------+-----------+-------------------------------------------------------------------------------------------+

Example:

```yaml
FileRead:
  file: recap_response_payloads.json
  directory: recaps/
  is_json: true
```

close async

close()

Method.

run async

run()

Run File checking.

start async

start(**kwargs)

Check for File and Directory information.