py4u blog

Uploading a File and Reading Its Content in CherryPy Python

CherryPy is a minimalistic and flexible Python web framework that allows developers to quickly build web applications. One common task in web development is handling file uploads and reading the content of the uploaded files. In this blog post, we will explore how to implement file upload functionality in a CherryPy application and read the content of the uploaded files.

2026-06

Table of Contents#

  1. Prerequisites
  2. Setting Up a CherryPy Application
  3. Creating a File Upload Form
  4. Handling File Uploads in CherryPy
  5. Reading the Content of the Uploaded File
  6. Common Practices and Best Practices
  7. Example Usage
  8. Conclusion
  9. References

Prerequisites#

  • Python installed on your system (Python 3.6 or higher is recommended).
  • CherryPy installed. You can install it using pip install cherrypy.

Setting Up a CherryPy Application#

First, let's create a basic CherryPy application. Here is a simple example:

import cherrypy
 
class Root:
    @cherrypy.expose
    def index(self):
        return "Welcome to the file upload application!"
 
if __name__ == '__main__':
    cherrypy.quickstart(Root())

Save this code in a file named app.py and run it using python app.py. You should see a message indicating that the CherryPy server is running. Open your web browser and navigate to http://localhost:8080 to see the welcome message.

Creating a File Upload Form#

To allow users to upload files, we need to create an HTML form. Here is an example of a simple file upload form:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>File Upload</title>
</head>
<body>
    <form action="/upload" method="post" enctype="multipart/form-data">
        <input type="file" name="file" />
        <input type="submit" value="Upload" />
    </form>
</body>
</html>

Save this code in a file named upload_form.html in the same directory as your app.py file.

Handling File Uploads in CherryPy#

Now, let's modify our CherryPy application to handle file uploads. Here is the updated code:

import cherrypy
 
class Root:
    @cherrypy.expose
    def index(self):
        with open('upload_form.html', 'r') as f:
            return f.read()
 
    @cherrypy.expose
    def upload(self, file):
        # Here, 'file' is a file-like object
        # You can access the file name and other attributes
        file_name = file.filename
        return f"File {file_name} uploaded successfully!"
 
if __name__ == '__main__':
    cherrypy.quickstart(Root())

In this code, the upload method is responsible for handling the file upload. The file parameter is a file-like object that represents the uploaded file. We can access the file name using the filename attribute.

Reading the Content of the Uploaded File#

To read the content of the uploaded file, we can use the read method of the file-like object. Here is the updated upload method:

import cherrypy
 
class Root:
    @cherrypy.expose
    def index(self):
        with open('upload_form.html', 'r') as f:
            return f.read()
 
    @cherrypy.expose
    def upload(self, file):
        file_name = file.filename
        file_content = file.file.read().decode('utf-8')
        return f"File {file_name} uploaded successfully. Content: {file_content}"
 
if __name__ == '__main__':
    cherrypy.quickstart(Root())

In this code, we use the read method to read the content of the file and then decode it using UTF-8 encoding.

Common Practices and Best Practices#

  • File Validation: Before processing the uploaded file, it's important to validate its type and size. You can use the content_type attribute of the file-like object to check the file type.
  • Error Handling: Handle errors that may occur during file upload or reading, such as file not found or encoding errors.
  • Security: Be aware of security risks associated with file uploads, such as uploading malicious files. You can implement security measures like file type whitelisting and virus scanning.

Example Usage#

  1. Run the CherryPy application by executing python app.py in your terminal.
  2. Open your web browser and navigate to http://localhost:8080.
  3. You should see the file upload form. Select a text file and click the "Upload" button.
  4. The application will display a message indicating that the file was uploaded successfully and show the content of the file.

Conclusion#

In this blog post, we have learned how to implement file upload functionality in a CherryPy application and read the content of the uploaded files. We have also discussed common practices and best practices for handling file uploads. By following these steps, you can easily add file upload capabilities to your CherryPy applications.

References#