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")
authenticate(key_id: str, key_secret: str, **kwargs) → None[source]

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, 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")
authenticate(connection_string: str, **kwargs) → None[source]

Authenticate to Azure Cloud Storage.

schema: Optional[str] = 'azure'

faker_file.storages.base module

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

Bases: object

Base storage.

abspath(filename: Any) → str[source]

Return absolute path.

exists(filename: Any) → bool[source]

Check if file exists.

generate_filename(extension: str, prefix: Optional[str] = None, basename: Optional[str] = None) → Any[source]

Generate filename.

relpath(filename: Any) → str[source]

Return relative path.

Delete the file.

write_bytes(filename: Any, data: bytes) → int[source]

Write bytes.

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

Write text.

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.

abspath(filename: Pathy) → str[source]

Return relative path.

abstract authenticate(*args, **kwargs)[source]
bucket: Pathy
bucket_name: str
credentials: Dict[str, str]
exists(filename: Union[Pathy, str]) → bool[source]

Check if file exists.

generate_filename(extension: str, prefix: Optional[str] = None, basename: Optional[str] = None) → Pathy[source]

Generate filename.

relpath(filename: Pathy) → str[source]

Return relative path.

schema: Optional[str] = None

Delete the file.

write_bytes(filename: Pathy, data: bytes) → int[source]

Write bytes.

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

Write text.

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")
authenticate(**kwargs) → None[source]

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)[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()
abspath(filename: str) → str[source]

Return absolute path.

exists(filename: str) → bool[source]

Check if file exists.

generate_filename(extension: str, prefix: Optional[str] = None, basename: Optional[str] = None) → str[source]

Generate filename.

relpath(filename: str) → str[source]

Return relative path.

Delete the file.

write_bytes(filename: str, data: bytes) → int[source]

Write bytes.

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

Write text.

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")
authenticate(json_file_path: str, **kwargs) → None[source]

Authenticate to Google Cloud Storage.

schema: Optional[str] = 'gs'

faker_file.storages.sftp_storage module

class faker_file.storages.sftp_storage.SFTPStorage(host: str, port: int = 22, username: str = '', password: Optional[str] = None, key: Optional[PKey] = None, root_path: str = '', rel_path: str = '', *args, **kwargs)[source]

Bases: BaseStorage

SFTP storage.

Usage example:

from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.storages.sftp_storage import SFTPStorage

FAKER = Faker()
FAKER.add_provider(TxtFileProvider)

# SFTP storage class
STORAGE = SFTPStorage(
    host="0.0.0.0",
    username="foo",
    password="pass",
)

# Generate TXT file in the default directory
txt_file = FAKER.txt_file(storage=STORAGE)

# Another SFTP storage class, but inside a `/upload/another` directory
STORAGE_SUB_DIR = SFTPStorage(
    host="0.0.0.0",
    username="foo",
    password="pass",
    root_path="/upload/another",
)

# Generate TXT file inside `/upload/another` directory
txt_file = FAKER.txt_file(storage=STORAGE_SUB_DIR)
abspath(filename: str) → str[source]

Return absolute path.

close()[source]

Explicitly close the connection.

exists(filename: str) → bool[source]

Check if file exists.

generate_filename(extension: str, prefix: Optional[str] = None, basename: Optional[str] = None) → str[source]

Generate filename.

relpath(filename: str) → str[source]

Return relative path.

sftp: Optional[SFTPClient] = None
transport: Optional[Transport] = None

Remove a file.

write_bytes(filename: str, data: bytes) → int[source]

Write bytes.

write_text(filename: str, data: str, encoding: Optional[str] = 'utf-8') → int[source]

Write text.

Module contents