Skip to content

File class

ravyn.core.datastructures.file.File

Bases: ResponseContainer[FileResponse]

path instance-attribute 

path

The path to the file to download.

filename instance-attribute 

filename

The name of the file to be added to the Content-Disposition attachment.

stat_result class-attribute instance-attribute 

stat_result = None

The equivalent of the os.stat_result.

validate_fields 

validate_fields(values)
Source code in ravyn/core/datastructures/file.py 
41
42
43
44
45
@model_validator(mode="before")
def validate_fields(cls, values: dict[str, Any]) -> Any:
    stat_result = values.get("stat_result")
    values["stat_result"] = stat_result or os.stat(cast("str", values.get("path")))
    return values

to_response 

to_response(headers, media_type, status_code, app)
Source code in ravyn/core/datastructures/file.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def to_response(
    self,
    headers: dict[str, Any],
    media_type: Union["MediaType", str],
    status_code: int,
    app: Type["Ravyn"],
) -> FileResponse:
    return FileResponse(
        background=self.background,
        filename=self.filename,
        headers=headers,
        media_type=media_type,
        path=self.path,
        stat_result=self.stat_result,
        status_code=status_code,
    )

    - "!^model_config"
    - "!^stat_result"
    - "!^validate_fields"