Skip to content

Types

Bases: TypeDecorator

Provides support for storing attachments to SQLAlchemy models.

FileField can be used as a Column type to store files into the model. The actual file itself will be uploaded to a specific libcloud.storage.base.Container, and only the File information will be stored on the database as JSON.

FileField is transaction aware, so it will delete every uploaded file whenever the transaction is rolled back and will delete any old file whenever the transaction is committed.

You can save str, bytes or any python file object

Each file will be validated by provided validators before being saved into associate storage libcloud.storage.base.Container and can go through different processors before being saved in the database.

Source code in sqlalchemy_file/types.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class FileField(types.TypeDecorator):  # type: ignore
    """Provides support for storing attachments to **SQLAlchemy** models.

    [FileField][sqlalchemy_file.types.FileField] can be used as a Column type to
    store files into the model. The actual file itself will be uploaded to a specific
    `libcloud.storage.base.Container`, and only the [File][sqlalchemy_file.file.File]
    information will be stored on the database as JSON.

    [FileField][sqlalchemy_file.types.FileField] is transaction aware, so it will delete
    every uploaded file whenever the transaction is rolled back and will
    delete any old file whenever the transaction is committed.

    You can save `str`, `bytes` or any python `file` object

    Each file will be validated by provided validators before being saved into
    associate storage `libcloud.storage.base.Container` and can go through different
    processors before being saved in the database.

    """

    impl = types.JSON
    cache_ok = False

    @property
    def python_type(self) -> Type[Union[File, List[File]]]:
        if self.multiple:
            return MutableList[File]
        return File

    def __init__(
        self,
        *args: Tuple[Any],
        upload_storage: Optional[str] = None,
        validators: Optional[List[Validator]] = None,
        processors: Optional[List[Processor]] = None,
        upload_type: Type[File] = File,
        multiple: Optional[bool] = False,
        extra: Optional[Dict[str, Any]] = None,
        headers: Optional[Dict[str, str]] = None,
        **kwargs: Dict[str, Any],
    ) -> None:
        """Parameters:
        upload_storage: storage to use
        validators: List of validators to apply
        processors: List of processors to apply
        upload_type: File class to use, could be
        used to set custom File class
        multiple: Use this to save multiple files
        extra: Extra attributes (driver specific)
        headers: Additional request headers,
        such as CORS headers. For example:
        headers = {'Access-Control-Allow-Origin': 'http://mozilla.com'}.
        """
        super().__init__(*args, **kwargs)
        if processors is None:
            processors = []
        if validators is None:
            validators = []
        self.upload_storage = upload_storage
        self.upload_type = upload_type
        self.multiple = multiple
        self.extra = extra
        self.headers = headers
        self.validators = validators
        self.processors = processors

    def process_bind_param(
        self, value: Any, dialect: Dialect
    ) -> Union[None, Dict[str, Any], List[Dict[str, Any]]]:
        if not value:
            return None
        if not self.multiple and not isinstance(
            value, self.upload_type
        ):  # pragma: no cover
            raise ValueError(f"Expected {self.upload_type}, received: {type(value)}")
        if self.multiple and not (
            isinstance(value, list)
            and all(isinstance(v, self.upload_type) for v in value)
        ):  # pragma: no cover
            raise ValueError(
                f"Expected MutableList[{self.upload_type}], received: {type(value)}"
            )
        return [v.encode() for v in value] if self.multiple else value.encode()

    def process_result_value(
        self, value: Any, dialect: Dialect
    ) -> Union[None, MutableList[File], File]:
        if value is None:
            return None
        if isinstance(value, dict):
            return (
                MutableList([self.upload_type.decode(value)])
                if self.multiple
                else self.upload_type.decode(value)
            )
        return MutableList([self.upload_type.decode(v) for v in value])

__init__(*args, upload_storage=None, validators=None, processors=None, upload_type=File, multiple=False, extra=None, headers=None, **kwargs)

Parameters: upload_storage: storage to use validators: List of validators to apply processors: List of processors to apply upload_type: File class to use, could be used to set custom File class multiple: Use this to save multiple files extra: Extra attributes (driver specific) headers: Additional request headers, such as CORS headers. For example: headers = {'Access-Control-Allow-Origin': 'http://mozilla.com'}.

Source code in sqlalchemy_file/types.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def __init__(
    self,
    *args: Tuple[Any],
    upload_storage: Optional[str] = None,
    validators: Optional[List[Validator]] = None,
    processors: Optional[List[Processor]] = None,
    upload_type: Type[File] = File,
    multiple: Optional[bool] = False,
    extra: Optional[Dict[str, Any]] = None,
    headers: Optional[Dict[str, str]] = None,
    **kwargs: Dict[str, Any],
) -> None:
    """Parameters:
    upload_storage: storage to use
    validators: List of validators to apply
    processors: List of processors to apply
    upload_type: File class to use, could be
    used to set custom File class
    multiple: Use this to save multiple files
    extra: Extra attributes (driver specific)
    headers: Additional request headers,
    such as CORS headers. For example:
    headers = {'Access-Control-Allow-Origin': 'http://mozilla.com'}.
    """
    super().__init__(*args, **kwargs)
    if processors is None:
        processors = []
    if validators is None:
        validators = []
    self.upload_storage = upload_storage
    self.upload_type = upload_type
    self.multiple = multiple
    self.extra = extra
    self.headers = headers
    self.validators = validators
    self.processors = processors

Bases: FileField

Inherits all attributes and methods from FileField, but also validates that the uploaded object is a valid image.

Source code in sqlalchemy_file/types.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
class ImageField(FileField):
    """Inherits all attributes and methods from [FileField][sqlalchemy_file.types.FileField],
    but also validates that the uploaded object is a valid image.
    """

    cache_ok = False

    def __init__(
        self,
        *args: Tuple[Any],
        upload_storage: Optional[str] = None,
        thumbnail_size: Optional[Tuple[int, int]] = None,
        image_validator: Optional[ImageValidator] = None,
        validators: Optional[List[Validator]] = None,
        processors: Optional[List[Processor]] = None,
        upload_type: Type[File] = File,
        multiple: Optional[bool] = False,
        extra: Optional[Dict[str, str]] = None,
        headers: Optional[Dict[str, str]] = None,
        **kwargs: Dict[str, Any],
    ) -> None:
        """Parameters
        upload_storage: storage to use
        image_validator: ImageField use default image
        validator, Use this property to customize it.
        thumbnail_size: If set, a thumbnail will be generated
        from original image using [ThumbnailGenerator]
        [sqlalchemy_file.processors.ThumbnailGenerator]
        validators: List of additional validators to apply
        processors: List of validators to apply
        upload_type: File class to use, could be
        used to set custom File class
        multiple: Use this to save multiple files
        extra: Extra attributes (driver specific).
        """
        if validators is None:
            validators = []
        if image_validator is None:
            image_validator = ImageValidator()
        if thumbnail_size is not None:
            if processors is None:
                processors = []
            processors.append(ThumbnailGenerator(thumbnail_size))
        validators.append(image_validator)
        super().__init__(
            *args,
            upload_storage=upload_storage,
            validators=validators,
            processors=processors,
            upload_type=upload_type,
            multiple=multiple,
            extra=extra,
            headers=headers,
            **kwargs,
        )

__init__(*args, upload_storage=None, thumbnail_size=None, image_validator=None, validators=None, processors=None, upload_type=File, multiple=False, extra=None, headers=None, **kwargs)

Parameters upload_storage: storage to use image_validator: ImageField use default image validator, Use this property to customize it. thumbnail_size: If set, a thumbnail will be generated from original image using ThumbnailGenerator validators: List of additional validators to apply processors: List of validators to apply upload_type: File class to use, could be used to set custom File class multiple: Use this to save multiple files extra: Extra attributes (driver specific).

Source code in sqlalchemy_file/types.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def __init__(
    self,
    *args: Tuple[Any],
    upload_storage: Optional[str] = None,
    thumbnail_size: Optional[Tuple[int, int]] = None,
    image_validator: Optional[ImageValidator] = None,
    validators: Optional[List[Validator]] = None,
    processors: Optional[List[Processor]] = None,
    upload_type: Type[File] = File,
    multiple: Optional[bool] = False,
    extra: Optional[Dict[str, str]] = None,
    headers: Optional[Dict[str, str]] = None,
    **kwargs: Dict[str, Any],
) -> None:
    """Parameters
    upload_storage: storage to use
    image_validator: ImageField use default image
    validator, Use this property to customize it.
    thumbnail_size: If set, a thumbnail will be generated
    from original image using [ThumbnailGenerator]
    [sqlalchemy_file.processors.ThumbnailGenerator]
    validators: List of additional validators to apply
    processors: List of validators to apply
    upload_type: File class to use, could be
    used to set custom File class
    multiple: Use this to save multiple files
    extra: Extra attributes (driver specific).
    """
    if validators is None:
        validators = []
    if image_validator is None:
        image_validator = ImageValidator()
    if thumbnail_size is not None:
        if processors is None:
            processors = []
        processors.append(ThumbnailGenerator(thumbnail_size))
    validators.append(image_validator)
    super().__init__(
        *args,
        upload_storage=upload_storage,
        validators=validators,
        processors=processors,
        upload_type=upload_type,
        multiple=multiple,
        extra=extra,
        headers=headers,
        **kwargs,
    )