faker_file.storages package

Submodules

faker_file.storages.aws_s3 module

class faker_file.storages.aws_s3.AWSS3Storage(bucket_name: str, rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)

Bases: CloudStorage

AWS S3 Storage.

Usage example:

from faker_file.storages.aws_s3 import AWSS3Storage

s3_storage = AWSS3Storage(

bucket_name=”artur-testing-1”, rel_path=”tmp”,

) file = s3_storage.generate_filename(prefix=”zzz_”, extension=”docx”) s3_storage.write_text(file, “Lorem ipsum”) s3_storage.write_bytes(file, b”Lorem ipsum”)

authenticate(key_id: str, key_secret: str, **kwargs) → None

Authenticate to AWS S3.

schema: str = 's3'

faker_file.storages.azure_cloud_storage module

class faker_file.storages.azure_cloud_storage.AzureCloudStorage(bucket_name: str, rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)

Bases: CloudStorage

Azure Cloud Storage.

Usage example:

from faker_file.storages.azure_cloud_storage import AzureCloudStorage

azure_storage = AzureCloudStorage(

bucket_name=”artur-testing-1”, rel_path=”tmp”,

) file = azure_storage.generate_filename(prefix=”zzz_”, extension=”docx”) azure_storage.write_text(file, “Lorem ipsum”) azure_storage.write_bytes(file, b”Lorem ipsum”)

authenticate(connection_string: str, **kwargs) → None

Authenticate to Azure Cloud Storage.

bucket: Pathy

bucket_name: str

credentials: Dict[str, str]

schema: str = 'azure'

faker_file.storages.base module

class faker_file.storages.base.BaseStorage(*args, **kwargs)

Bases: object

Base storage.

abspath(filename: Any) → str

Return absolute path.

exists(filename: Any) → bool

Check if file exists.

generate_filename(prefix: str, extension: str) → Any

Generate filename.

generate_temporary_local_filename(prefix: str, extension: str) → str

relpath(filename: Any) → str

Return relative path.

write_bytes(filename: Any, data: bytes) → int

Write bytes.

write_text(filename: Any, data: str, encoding: Optional[str] = None) → int

Write text.

faker_file.storages.cloud module

class faker_file.storages.cloud.CloudStorage(bucket_name: str, rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)

Bases: BaseStorage

Base cloud storage.

Usage example:

from faker_file.storages.cloud import CloudStorage

storage = CloudStorage(

schema=”s3”, bucket_name=”artur-testing-1”, rel_path=”tmp”,

) file = storage.generate_filename(prefix=”zzz_”, extension=”docx”) storage.write_text(file, “Lorem ipsum”) storage.write_bytes(file, b”Lorem ipsum”)

abspath(filename: Pathy) → str

Return relative path.

authenticate(**kwargs)

bucket: Pathy

bucket_name: str

credentials: Dict[str, str]

exists(filename: Union[Pathy, str]) → bool

Check if file exists.

generate_filename(prefix: str, extension: str) → Pathy

Generate filename.

relpath(filename: Pathy) → str

Return relative path.

schema: str = None

write_bytes(filename: Pathy, data: bytes) → int

Write bytes.

write_text(filename: Pathy, data: str, encoding: Optional[str] = None) → int

Write text.

class faker_file.storages.cloud.PathyFileSystemStorage(bucket_name: str, rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)

Bases: CloudStorage

Pathy FileSystem Storage.

Usage example:

from faker_file.storages.cloud import PathyFileSystemStorage

fs_storage = PathyFileSystemStorage(

bucket_name=”artur-testing-1”, rel_path=”tmp”,

) file = fs_storage.generate_filename(prefix=”zzz_”, extension=”docx”) fs_storage.write_text(file, “Lorem ipsum”) fs_storage.write_bytes(file, b”Lorem ipsum”)

authenticate(**kwargs) → None

Authenticate. Does nothing.

schema: str = 'file'

faker_file.storages.filesystem module

class faker_file.storages.filesystem.FileSystemStorage(root_path: Optional[str] = '/tmp', rel_path: Optional[str] = 'tmp', *args, **kwargs)

Bases: BaseStorage

File storage.

Usage example:

from faker_file.storages.filesystem import FileSystemStorage

storage = FileSystemStorage() file = storage.generate_filename(prefix=”zzz_”, extension=”docx”) storage.write_text(file, “Lorem ipsum”) storage.write_bytes(file, b”Lorem ipsum”)

Initialization with params:

storage = FileSystemStorage()

abspath(filename: str) → str

Return absolute path.

exists(filename: str) → bool

Write bytes.

generate_filename(prefix: str, extension: str) → str

Generate filename.

relpath(filename: str) → str

Return relative path.

write_bytes(filename: str, data: bytes) → int

Write bytes.

write_text(filename: str, data: str, encoding: Optional[str] = None) → int

Write text.

faker_file.storages.google_cloud_storage module

class faker_file.storages.google_cloud_storage.GoogleCloudStorage(bucket_name: str, rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)

Bases: CloudStorage

Google Cloud Storage.

Usage example:

from faker_file.storages.google_cloud_storage import GoogleCloudStorage

gs_storage = GoogleCloudStorage(

bucket_name=”artur-testing-1”, rel_path=”tmp”,

) file = gs_storage.generate_filename(prefix=”zzz_”, extension=”docx”) gs_storage.write_text(file, “Lorem ipsum”) gs_storage.write_bytes(file, b”Lorem ipsum”)

authenticate(json_file_path: str, **kwargs) → None

Authenticate to Google Cloud Storage.

bucket: Pathy

bucket_name: str

credentials: Dict[str, str]

schema: str = 'gs'

Module contents