faker_file.storages package¶
Submodules¶
faker_file.storages.aws_s3 module¶
- class faker_file.storages.aws_s3.AWSS3Storage(bucket_name: str, root_path: Optional[str] = 'tmp', rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]¶
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”)
- schema: str = 's3'¶
faker_file.storages.azure_cloud_storage module¶
- class faker_file.storages.azure_cloud_storage.AzureCloudStorage(bucket_name: str, root_path: Optional[str] = 'tmp', rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]¶
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”)
- bucket: Pathy¶
- bucket_name: str¶
- credentials: Dict[str, str]¶
- schema: Optional[str] = 'azure'¶
faker_file.storages.base module¶
faker_file.storages.cloud module¶
- class faker_file.storages.cloud.CloudStorage(bucket_name: str, root_path: Optional[str] = 'tmp', rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]¶
Bases:
BaseStorage
Base cloud storage.
- bucket: Pathy¶
- bucket_name: str¶
- credentials: Dict[str, str]¶
- generate_filename(extension: str, prefix: Optional[str] = None, basename: Optional[str] = None) Pathy [source]¶
Generate filename.
- schema: Optional[str] = None¶
- class faker_file.storages.cloud.PathyFileSystemStorage(bucket_name: str, root_path: Optional[str] = 'tmp', rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]¶
Bases:
CloudStorage
Pathy FileSystem Storage.
Usage example:
from faker_file.storages.cloud import PathyFileSystemStorage
fs_storage = PathyFileSystemStorage(bucket_name=”artur-testing-1”) file = fs_storage.generate_filename(prefix=”zzz_”, extension=”docx”) fs_storage.write_text(file, “Lorem ipsum”) fs_storage.write_bytes(file, b”Lorem ipsum”)
- 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)[source]¶
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()
faker_file.storages.google_cloud_storage module¶
- class faker_file.storages.google_cloud_storage.GoogleCloudStorage(bucket_name: str, root_path: Optional[str] = 'tmp', rel_path: Optional[str] = 'tmp', credentials: Optional[Dict[str, Any]] = None, *args, **kwargs)[source]¶
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”)
- bucket: Pathy¶
- bucket_name: str¶
- credentials: Dict[str, str]¶
- schema: Optional[str] = 'gs'¶