Skip to content

FileField

Field of Model for upload file.

FileField

Bases: Field

Field of Model for upload file.

Source code in src/ramifice/fields/file_field.py 
 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
111
112
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
class FileField(Field):
    """Field of Model for upload file."""

    def __init__(
        self,
        label: str = "",
        placeholder: str = "",
        default: str | None = None,
        is_hide: bool = False,
        is_disable: bool = False,
        is_ignore: bool = False,
        hint: str = "",
        warning: list[str] = [],  # ruff:ignore[mutable-argument-default]
        is_require: bool = False,
        # The maximum size of the file in bytes.
        max_size: int = 2097152,  # 2 MB = 2097152 Bytes (in binary)
        target_dir: str = "files",
        accept: str = "",  # Example: ".pdf,.doc,.docx,application/msword"
    ) -> None:
        """Field of Model for upload file.

        Agrs:
            label: Text label for a web form field.
            placeholder: Displays prompt text.
            default: Value by default.
            is_hide: Hide field from user.
            is_disable: Blocks access and modification of the element.
            is_ignore: If true, the value of this field is not saved in the database.
            hint: An alternative for the `placeholder` parameter.
            warning: Warning information.
            is_require: Required field.
            max_size: The maximum allowed file size in bytes.
            target_dir: Directory for files inside media directory.
            accept: Describing which file types to allow. Example: ".pdf,.doc,.docx,application/msword".
        """
        if Config.DEBUG:
            try:  # ruff:ignore[too-many-statements-in-try-clause]
                if default is not None:
                    if not isinstance(default, str):
                        raise AssertionError("Parameter `default` - Not а `str` type!")
                    if len(default) == 0:
                        raise AssertionError("The `default` parameter should not contain an empty string!")
                if not isinstance(label, str):
                    raise AssertionError("Parameter `label` - Not а `str` type!")
                if not isinstance(is_disable, bool):
                    raise AssertionError("Parameter `is_disable` - Not а `bool` type!")
                if not isinstance(is_hide, bool):
                    raise AssertionError("Parameter `is_hide` - Not а `bool` type!")
                if not isinstance(is_ignore, bool):
                    raise AssertionError("Parameter `is_ignore` - Not а `bool` type!")
                if not isinstance(hint, str):
                    raise AssertionError("Parameter `hint` - Not а `str` type!")
                if not isinstance(warning, list):
                    raise AssertionError("Parameter `warning` - Not а `list` type!")
                if not isinstance(placeholder, str):
                    raise AssertionError("Parameter `placeholder` - Not а `str` type!")
                if not isinstance(is_require, bool):
                    raise AssertionError("Parameter `is_require` - Not а `bool` type!")
                if not isinstance(max_size, int):
                    raise AssertionError("Parameter `max_size` - Not а `int` type!")
                if not isinstance(target_dir, str):
                    raise AssertionError("Parameter `target_dir` - Not а `str` type!")
                if not isinstance(accept, str):
                    raise AssertionError("Parameter `accept` - Not а `str` type!")
            except AssertionError as err:
                logger.critical(str(err))
                raise err

        Field.__init__(self, supported_types=(dict, type(None)))

        field_core: dict[str, Any] = {
            "id": "",
            "name": "",
            "label": label,
            "input_type": "file",
            "value": None,
            "default": default,
            "placeholder": placeholder,
            "is_hide": is_hide,
            "is_disable": is_disable,
            "is_ignore": is_ignore,
            "hint": hint,
            "warning": warning,
            "is_require": is_require,
            "max_size": max_size,
            "target_dir": target_dir,
            "accept": accept,
            "errors": [],
            "field_type": "FileField",
            "group": "file",
        }

        self.__dict__["field_core"] = FieldCore(**field_core)
        self.field_core.from_base64 = MethodType(from_base64, self.field_core)
        self.field_core.from_path = MethodType(from_path, self.field_core)

__init__(label='', placeholder='', default=None, is_hide=False, is_disable=False, is_ignore=False, hint='', warning=[], is_require=False, max_size=2097152, target_dir='files', accept='')

Field of Model for upload file.

Agrs

label: Text label for a web form field. placeholder: Displays prompt text. default: Value by default. is_hide: Hide field from user. is_disable: Blocks access and modification of the element. is_ignore: If true, the value of this field is not saved in the database. hint: An alternative for the placeholder parameter. warning: Warning information. is_require: Required field. max_size: The maximum allowed file size in bytes. target_dir: Directory for files inside media directory. accept: Describing which file types to allow. Example: ".pdf,.doc,.docx,application/msword".

Source code in src/ramifice/fields/file_field.py 
 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
111
112
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
def __init__(
    self,
    label: str = "",
    placeholder: str = "",
    default: str | None = None,
    is_hide: bool = False,
    is_disable: bool = False,
    is_ignore: bool = False,
    hint: str = "",
    warning: list[str] = [],  # ruff:ignore[mutable-argument-default]
    is_require: bool = False,
    # The maximum size of the file in bytes.
    max_size: int = 2097152,  # 2 MB = 2097152 Bytes (in binary)
    target_dir: str = "files",
    accept: str = "",  # Example: ".pdf,.doc,.docx,application/msword"
) -> None:
    """Field of Model for upload file.

    Agrs:
        label: Text label for a web form field.
        placeholder: Displays prompt text.
        default: Value by default.
        is_hide: Hide field from user.
        is_disable: Blocks access and modification of the element.
        is_ignore: If true, the value of this field is not saved in the database.
        hint: An alternative for the `placeholder` parameter.
        warning: Warning information.
        is_require: Required field.
        max_size: The maximum allowed file size in bytes.
        target_dir: Directory for files inside media directory.
        accept: Describing which file types to allow. Example: ".pdf,.doc,.docx,application/msword".
    """
    if Config.DEBUG:
        try:  # ruff:ignore[too-many-statements-in-try-clause]
            if default is not None:
                if not isinstance(default, str):
                    raise AssertionError("Parameter `default` - Not а `str` type!")
                if len(default) == 0:
                    raise AssertionError("The `default` parameter should not contain an empty string!")
            if not isinstance(label, str):
                raise AssertionError("Parameter `label` - Not а `str` type!")
            if not isinstance(is_disable, bool):
                raise AssertionError("Parameter `is_disable` - Not а `bool` type!")
            if not isinstance(is_hide, bool):
                raise AssertionError("Parameter `is_hide` - Not а `bool` type!")
            if not isinstance(is_ignore, bool):
                raise AssertionError("Parameter `is_ignore` - Not а `bool` type!")
            if not isinstance(hint, str):
                raise AssertionError("Parameter `hint` - Not а `str` type!")
            if not isinstance(warning, list):
                raise AssertionError("Parameter `warning` - Not а `list` type!")
            if not isinstance(placeholder, str):
                raise AssertionError("Parameter `placeholder` - Not а `str` type!")
            if not isinstance(is_require, bool):
                raise AssertionError("Parameter `is_require` - Not а `bool` type!")
            if not isinstance(max_size, int):
                raise AssertionError("Parameter `max_size` - Not а `int` type!")
            if not isinstance(target_dir, str):
                raise AssertionError("Parameter `target_dir` - Not а `str` type!")
            if not isinstance(accept, str):
                raise AssertionError("Parameter `accept` - Not а `str` type!")
        except AssertionError as err:
            logger.critical(str(err))
            raise err

    Field.__init__(self, supported_types=(dict, type(None)))

    field_core: dict[str, Any] = {
        "id": "",
        "name": "",
        "label": label,
        "input_type": "file",
        "value": None,
        "default": default,
        "placeholder": placeholder,
        "is_hide": is_hide,
        "is_disable": is_disable,
        "is_ignore": is_ignore,
        "hint": hint,
        "warning": warning,
        "is_require": is_require,
        "max_size": max_size,
        "target_dir": target_dir,
        "accept": accept,
        "errors": [],
        "field_type": "FileField",
        "group": "file",
    }

    self.__dict__["field_core"] = FieldCore(**field_core)
    self.field_core.from_base64 = MethodType(from_base64, self.field_core)
    self.field_core.from_path = MethodType(from_path, self.field_core)

from_base64(self, base64_str=None, filename=None, is_delete=False) async

Convert base64 to a file, get file information and save in the target directory.

Source code in src/ramifice/fields/file_field.py 
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
async def from_base64(
    self,
    base64_str: str | None = None,
    filename: str | None = None,
    is_delete: bool = False,
) -> None:
    """Convert base64 to a file, get file information and save in the target directory."""
    base64_str = base64_str or None
    filename = filename or None
    file_info: dict[str, Any] = {"save_as_is": False}
    file_info["is_new_file"] = True
    file_info["is_delete"] = is_delete

    if base64_str is not None and filename is not None:
        # Get file extension.
        extension = Path(filename).suffix
        if len(extension) == 0:
            msg = f"The file `{filename}` has no extension."
            logger.error(msg)
            raise FileHasNoExtensionError(msg)
        # Prepare Base64 content.
        for item in enumerate(base64_str):
            if item[1] == ",":
                base64_str = base64_str[item[0] + 1 :]
                break
            if item[0] == 40:
                break
        # Create new (uuid) file name.
        f_uuid_name = f"{uuid.uuid4()}{extension}"
        # Create the current date for the directory name.
        date_str: str = str(datetime.now(Config.UTC_TIMEZONE).date())
        # Create path to target directory.
        dir_target_path = Path(
            Config.MEDIA_ROOT,
            "uploads",
            self.target_dir,
            date_str,
        )
        # Create target directory if it does not exist.
        if not await dir_target_path.exists():
            await dir_target_path.mkdir(parents=True)
        # Create path to target file.
        f_target_path = f"{dir_target_path.as_posix()}/{f_uuid_name}"
        # Save file in target directory.
        async with await open_file(f_target_path, mode="wb") as open_f:
            f_content = b64decode(base64_str)
            await open_f.write(f_content)
        # Add paths to target file.
        file_info["path"] = f_target_path
        file_info["url"] = f"{Config.MEDIA_URL}/uploads/{self.target_dir}/{date_str}/{f_uuid_name}"
        # Add original file name.
        file_info["name"] = filename
        # Add file extension.
        file_info["extension"] = extension
        # Add file size (in bytes).
        file_info["size"] = await to_thread.run_sync(getsize, f_target_path)
        # Convert the number of bytes into a human-readable format.
        # Examples: 200 bytes | 1 KB | 1.5 MB.
        file_info["human_size"] = to_human_size(file_info["size"])
    #
    # result to value
    self.value = file_info

from_path(self, src_path=None, is_delete=False) async

Get file information and copy the file to the target directory.

Source code in src/ramifice/fields/file_field.py 
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
async def from_path(
    self,
    src_path: str | None = None,
    is_delete: bool = False,
) -> None:
    """Get file information and copy the file to the target directory."""
    src_path = src_path or None
    file_info: dict[str, Any] = {"save_as_is": False}
    file_info["is_new_file"] = True
    file_info["is_delete"] = is_delete

    if src_path is not None:
        # Get file extension.
        extension = Path(src_path).suffix
        if len(extension) == 0:
            msg = f"The file `{src_path}` has no extension."
            logger.error(msg)
            raise FileHasNoExtensionError(msg)
        # Create new (uuid) file name.
        f_uuid_name = f"{uuid.uuid4()}{extension}"
        # Create the current date for the directory name.
        date_str: str = str(datetime.now(Config.UTC_TIMEZONE).date())
        # Create path to target directory.
        dir_target_path = Path(
            Config.MEDIA_ROOT,
            "uploads",
            self.target_dir,
            date_str,
        )
        # Create target directory if it does not exist.
        if not await dir_target_path.exists():
            await dir_target_path.mkdir(parents=True)
        # Create path to target file.
        f_target_path = f"{dir_target_path.as_posix()}/{f_uuid_name}"
        # Save file in target directory.
        await to_thread.run_sync(copyfile, src_path, f_target_path)
        # Add paths to target file.
        file_info["path"] = f_target_path
        file_info["url"] = f"{Config.MEDIA_URL}/uploads/{self.target_dir}/{date_str}/{f_uuid_name}"
        # Add original file name.
        file_info["name"] = Path(src_path).name
        # Add file extension.
        file_info["extension"] = extension
        # Add file size (in bytes).
        file_info["size"] = await to_thread.run_sync(getsize, f_target_path)
        # Convert the number of bytes into a human-readable format.
        # Examples: 200 bytes | 1 KB | 1.5 MB.
        file_info["human_size"] = to_human_size(file_info["size"])
    #
    # result to value
    self.value = file_info