Fix linting

Author: jowilf

README.md

@@ -111,8 +111,8 @@ engine = create_engine(
 )
 Base.metadata.create_all(engine)
 
-with Session(engine) as session:
-    session.add(Attachment(name="attachment1", content=open("./example.txt", "rb")))
+with Session(engine) as session, open("./example.txt", "rb") as local_file:
+    session.add(Attachment(name="attachment1", content=local_file))
     session.add(Attachment(name="attachment2", content=b"Hello world"))
     session.add(Attachment(name="attachment3", content="Hello world"))
     file = File(content="Hello World", filename="hello.txt", content_type="text/plain")

docs/index.md

@@ -110,8 +110,8 @@ engine = create_engine(
 )
 Base.metadata.create_all(engine)
 
-with Session(engine) as session:
-    session.add(Attachment(name="attachment1", content=open("./example.txt", "rb")))
+with Session(engine) as session, open("./example.txt", "rb") as local_file:
+    session.add(Attachment(name="attachment1", content=local_file))
     session.add(Attachment(name="attachment2", content=b"Hello world"))
     session.add(Attachment(name="attachment3", content="Hello world"))
     file = File(content="Hello World", filename="hello.txt", content_type="text/plain")

docs_src/example.py

@@ -30,8 +30,8 @@ class Attachment(Base):
 )
 Base.metadata.create_all(engine)
 
-with Session(engine) as session:
-    session.add(Attachment(name="attachment1", content=open("./example.txt", "rb")))
+with Session(engine) as session, open("./example.txt", "rb") as local_file:
+    session.add(Attachment(name="attachment1", content=local_file))
     session.add(Attachment(name="attachment2", content=b"Hello world"))
     session.add(Attachment(name="attachment3", content="Hello world"))
     file = File(content="Hello World", filename="hello.txt", content_type="text/plain")

docs_src/tutorial/quick-start/save_your_model.py

@@ -30,8 +30,8 @@ class Attachment(Base):
 )
 Base.metadata.create_all(engine)
 
-with Session(engine) as session:
-    session.add(Attachment(name="attachment1", content=open("./example.txt", "rb")))
+with Session(engine) as session, open("./example.txt", "rb") as local_file:
+    session.add(Attachment(name="attachment1", content=local_file))
     session.add(Attachment(name="attachment2", content=b"Hello world"))
     session.add(Attachment(name="attachment3", content="Hello world"))
     # Use sqlalchemy_file.File object to provide custom filename and content_type

docs_src/tutorial/using-files-in-models/007_multiple_file.py

@@ -29,14 +29,14 @@ class Attachment(Base):
 )
 Base.metadata.create_all(engine)
 
-with Session(engine) as session:
+with Session(engine) as session, open("./example.txt", "rb") as file:
     session.add(
         Attachment(
             name="attachment1",
             multiple_content=[
                 "from str",
                 b"from bytes",
-                open("./example.txt", "rb"),
+                file,
                 File(
                     content="Hello World",
                     filename="hello.txt",

docs_src/tutorial/using-files-in-models/008_file_information.py

@@ -30,8 +30,8 @@ class Attachment(Base):
 )
 Base.metadata.create_all(engine)
 
-with Session(engine) as session:
-    session.add(Attachment(name="attachment1", content=open("./example.txt", "rb")))
+with Session(engine) as session, open("./example.txt", "rb") as local_file:
+    session.add(Attachment(name="attachment1", content=local_file))
     session.add(Attachment(name="attachment2", content=b"Hello world"))
     session.add(Attachment(name="attachment3", content="Hello world"))
     file = File(content="Hello World", filename="hello.txt", content_type="text/plain")

examples/fastapi/app.py

@@ -133,7 +133,7 @@ async def serve_files(storage: str = Path(...), file_id: str = Path(...)):
             return FileResponse(
                 file.get_cdn_url(), media_type=file.content_type, filename=file.filename
             )
-        elif file.get_cdn_url() is not None:
+        elif file.get_cdn_url() is not None:  # noqa: RET505
             """If file has public url, redirect to this url"""
             return RedirectResponse(file.get_cdn_url())
         else:

examples/flask/app.py

@@ -88,7 +88,7 @@ def serve_files(storage, file_id):
                 mimetype=file.content_type,
                 download_name=file.filename,
             )
-        elif file.get_cdn_url() is not None:
+        elif file.get_cdn_url() is not None:  # noqa: RET505
             """If file has public url, redirect to this url"""
             return app.redirect(file.get_cdn_url())
         else:

pyproject.toml

@@ -165,6 +165,7 @@ known-third-party = ["sqlalchemy_file"]
 
 [tool.ruff.per-file-ignores]
 "__init__.py" = ["F401"]
+"docs_src/**" = ["N999"]
 
 [tool.mypy]
 strict = true

sqlalchemy_file/file.py

@@ -24,7 +24,6 @@ class File(BaseFile):
     Default attributes provided for all ``File`` include:
 
     Attributes:
-    ----------
         filename (str):  This is the name of the uploaded file
         file_id:   This is the generated UUID for the uploaded file
         upload_storage:   Name of the storage used to save the uploaded file