nannyml.io.file_reader module

class nannyml.io.file_reader.FileReader(filepath: str, read_args: Optional[Dict[str, Any]] = None, credentials: Optional[Dict[str, Any]] = None, fs_args: Optional[Dict[str, Any]] = None)[source]

Bases: Reader

A Reader implementation that reads a local or cloud-based file.

Creates a new FileReader instance.

Parameters:

  • filepath (str) – The path to read data from. Can be a regular file path or contain a protocol.

  • read_args (Dict[str, Any], default=None) – Specific arguments passed along to the methods doing the actual reading (mostly Pandas-based).

  • credentials (Dict[str, Any], default=None) – Used to provide credential information following specific fsspec implementations.

  • fs_args (default=None) – Specific arguments passed along to the fsspec filesystem initializer.

Examples

>>> local_reader = FileReader(
...   filepath='/my-data-directory/data.pq'
... )

>>> aws_reader = FileReader(
...   filepath='s3://my-data-directory/data.pq',
...   credentials={'key': 'my_key', 'secret': 'my_secret'}
... )

>>> aws_reader2 = FileReader(
...   filepath='s3://my-data-directory/data.pq',
...   credentials={'aws_access_key_id': 'access_key_id', 'aws_secret_access_key': 'secret_access_key'}
... )

>>> gcp_reader = FileReader(
...   filepath='s3://my-data-directory/data.pq',
...   credentials={'token': 'my_service_account_credential_file.json'}
... )