Tutorial Python - File transfer using Websockets

Learn how to transfer files using WebSockets in Python with this comprehensive tutorial. Streamline data exchange efficiently for real-time communication.

Equipment list

Here you can find the list of equipment used to create this tutorial.

Equipment list

This link will also show the software list used to create this tutorial.

What is WebSocket?

WebSocket is a communication protocol that provides full-duplex communication channels over a single, long-lived connection between clients and servers. Unlike traditional HTTP, WebSocket allows for real-time, two-way communication, enabling interactive web applications and efficient data transfer. It is commonly used for applications requiring live updates, such as online gaming, chat applications, and real-time data transfer.

Is it possible to send files using WebSockets?

Yes, it is possible to send files using WebSockets. To achieve this, the file data needs to be encoded into a format suitable for transmission, such as base64 or binary data. Once encoded, the data can be sent in smaller chunks or as a continuous stream through the WebSocket connection. On the receiving end, the data is decoded and reconstructed into its original file format. This approach allows for the efficient and reliable transfer of files in real-time, making it ideal for applications requiring the exchange of various types of data, including images, documents, and multimedia files.

Why transfer files using WebSockets?

Transferring files using WebSockets offers several advantages, including real-time, bidirectional communication, which allows for seamless data transfer without the need for frequent polling. WebSockets enable efficient handling of large or frequent data transfers, making them suitable for applications that require immediate data updates.

Tutorial Python - File transfer using Websockets

Create a server script to receive a file transfer using Websockets.

Copy to Clipboard

Here is the Python Websockets server script.

Copy to Clipboard

import asyncio
import websockets
import json

async def receive_file(websocket, path):
    # Receive data from the WebSocket connection
    data_received = await websocket.recv()
    # Convert received data to a Python dictionary from JSON format
    data_received = json.loads(data_received.replace("'", '"'))
    # Extract the filename to save from the received data
    filename_to_save = data_received["filename"]
    # Convert the content to bytes for writing to a file
    file_content = bytes(data_received["content"])
    # Write the content to a file with the specified filename
    with open(f"{filename_to_save}", 'wb') as file:
        file.write(file_content)

# Save the received data to a JSON file (commented out for now)
    # with open("mylog.json", 'w') as log_file:
    #     json.dump(data_received, log_file)

# Start the WebSocket server
start_server = websockets.serve(receive_file, '0.0.0.0', 8765)

# Run the event loop until the server is complete
asyncio.get_event_loop().run_until_complete(start_server)

# Run the event loop forever to keep the server running
asyncio.get_event_loop().run_forever()

Start the Websockets server on the TCP port 8765.

Copy to Clipboard

Create a client script to send a file using Websockets.

Copy to Clipboard

Here is the Python Websockets client script.

Copy to Clipboard

import asyncio
import websockets
import json

async def send_file(websocket, filename, save_as):
    # Open the specified file for reading in binary mode
    with open(filename, 'rb') as file:
        # Read the content of the file as bytes
        file_content = file.read()
        # Create a dictionary with the filename and its content to send
        data_to_send = {"filename": save_as, "content": list(file_content)}
        # Convert the dictionary to a JSON string and send it via the WebSocket
        await websocket.send(json.dumps(data_to_send))

async def client(filename, save_as):
    # Establish a WebSocket connection to the specified address
    async with websockets.connect('ws://localhost:8765') as websocket:
        # Call the send_file function to send the specified file
        await send_file(websocket, filename, save_as)

# Define the filename and the save filename here
filename = "calc.exe"
#save_as = "c:\\tmp\\test1.txt"
save_as = "mycalc.exe"
# Run the client function to initiate the file sending process
asyncio.run(client(filename, save_as))

Send a file using the Websockets client script.

Copy to Clipboard

The client script did connect to localhost TCP port 8765.

In our example, we sent a binary file named CALC and saved it as MYCALC on the server.

Conclusion

In summary, harness the power of Python's WebSockets to facilitate real-time, secure file transfer. Implement our script for data transfer and change it to fit your needs.

Python - File transfer using Websockets

Python - File transfer using Websockets

Equipment list

Related tutorial - Python

What is WebSocket?

Is it possible to send files using WebSockets?

Why transfer files using WebSockets?

Tutorial Python - File transfer using Websockets

Conclusion

Related Posts