Created UDP sockets #36

HermanG05 · 2024-06-27T18:19:08Z

Created UDP server and client sockets

maxlou05 · 2024-06-29T20:41:15Z

network/modules/UDP/socket_wrapper.py

+ Wrapper for Python's socket module.
+ """
+
+ def __init__(self, socket_instance: socket.socket) -> None:


I think you need to give it a default value of None for it to allow not passing in any arguments

maxlou05 · 2024-06-29T20:42:21Z

network/modules/UDP/socket_wrapper.py

+ else:
+ self.__socket = socket_instance
+
+ def send_to(self, data: bytes, address: tuple) -> bool:


Instead of using address as a tuple, please send host and port as 2 different parameters, then you can put them into a tuple yourself in the implementation. It's kind of annoying for users to have to do this themselves.

Also, UDP sockets will give an error when data size is too large. Can you setup a while loop to break up the data into smaller chunks, such as 4096 bytes (have this as some sort of constant)

maxlou05 · 2024-06-29T20:44:19Z

network/modules/UDP/socket_wrapper.py

+
+ return True
+
+ def recv_from(self, buf_size: int) -> "tuple[bool, bytes | None]":


Please edit the type hint. We want to return a tuple of length 2: (success, data). No need to return the address from which it was sent. Also, could we rename this to just recv? It will be more consistent and easier for users to use.

maxlou05 · 2024-06-29T20:44:42Z

network/modules/UDP/socket_wrapper.py

+
+ Returns
+ -------
+ tuple: If the data and address were received


Can you update the docstring to reflect the data returned?

maxlou05 · 2024-06-29T20:48:12Z

network/modules/UDP/socket_wrapper.py

+
+ """
+ try:
+ data, addr = self.__socket.recvfrom(buf_size)


Can you put this in a while loop? I believe that networks usually split large data into smaller packets, and may not send the whole thing in one go. Thus, you need to keep on looping until you get all of the data. Additionally, you should check that it all comes from the same address (for now, use the first recv's returned address).

maxlou05 · 2024-06-29T21:27:41Z

network/modules/UDP/server_socket.py

+ print(f"Could not create socket, error: {e}.")
+ return False, None
+
+ def receive(self, buffer_size: int = 1024) -> "tuple[bytes, tuple]":


We don't need to make a new recv function here, we can just use the base class's recv function (since technically both server and client can send and recv)

maxlou05 · 2024-06-29T21:27:56Z

network/modules/UDP/server_socket.py

+ print(f"Error receiving data: {e}.")
+ return b"", ()
+
+ def close(self) -> None:


Same with close, we can re-use base class's close

network/modules/UDP/client_socket.py

maxlou05 · 2024-06-29T21:33:04Z

network/modules/UDP/client_socket.py

+ print(f"Failed to send data: {e}")
+ return False
+
+ def close(self) -> None:


No need to customize close here

maxlou05 · 2024-06-29T21:39:23Z

network/modules/UDP/server_socket.py

+ Parameters
+ ----------
+ host: str (default "")
+ The hostname or IP address to bind the socket to.


Add explanation that empty string is the open address

maxlou05

Reviewed

network/modules/UDP/client_socket.py

maxlou05 · 2024-06-30T19:52:44Z

network/modules/UDP/socket_wrapper.py

+ while data_sent < data_size:
+
+ chunk = data[data_sent:data_sent+4096]
+ packed_data = struct.pack(f'!{len(chunk)}s', chunk)


Sorry, my bad. There's no need to pack our data using struct, I kind of overthinked for a moment. This is only necessary when you are say sending an array of integers, but we are sending raw bytes to be interpreted by the image_decode module later anyways.

maxlou05 · 2024-06-30T19:53:48Z

network/modules/UDP/socket_wrapper.py

+
+ while data_sent < data_size:
+
+ chunk = data[data_sent:data_sent+4096]


Please use a global constant declared at the top ie CHUNK_SIZE instead of a value here. Also, you should probably check for when data_sent + 4096 > data_size before it throws index out of bounds or something like that.

maxlou05 · 2024-06-30T19:56:40Z

network/modules/UDP/socket_wrapper.py

+ try:
+ unpacked_data = struct.unpack(f'!{len(data)}', data)
+ except struct.error as e:
+ print(f"Could not unpack data: {e}")
+ return False, None


Sorry, my bad, we don't need this anymore.

maxlou05 · 2024-06-30T19:58:50Z

network/modules/UDP/socket_wrapper.py

+ data += packet # Add the received packet to the accumulated data
+
+ # Assuming that receiving less than buf_size means end of data
+ if len(packet) < buf_size:


What if we were trying to receive exactly 4096 bytes? Then this would break as it will be listening for more when there is no more. Just have a variable tracking progress so far or use len(data)

I'm a little confused here. Did you want a condition that would break out of the loop if the length of the data was exactly 4096 bytes? I don't really see how that would work independently of the other condition unless the user somehow specified that they wanted exactly 4096 bytes beforehand.

I just meant you should have a variable that keeps track of how many bytes you've received so far, because this won't work if the user wanted to receive a byte length that is a multiple of 4096. Sort of like in the send function, just have a variable that you keep on adding to.

maxlou05

Reviewed

…y, addressed minor changes in socket_wrapper.py

maxlou05 · 2024-07-01T22:07:51Z

network/modules/UDP/socket_wrapper.py

+ elif addr != current_addr:
+ print(f"Data received from multiple addresses: {addr} and {current_addr}")
+ return False, None


Rather than returning, we can just drop the unwanted packet and continue.

maxlou05 · 2024-07-01T22:09:21Z

network/modules/UDP/socket_wrapper.py

+ if data_size >= buf_size:
+ break


It's probably better to just put this in the while condition rather than down here, makes it more readable.

maxlou05 · 2024-07-01T22:11:48Z

network/modules/UDP/server_socket.py

+ self.server_address = server_address
+
+ @classmethod
+ def create(cls, host: str = "", port: int = 5000) -> "tuple[bool, UdpServerSocket | None]":


Can we add a parameter for setting a timeout? Have a default of like 10seconds (see settimeout())

maxlou05

Reviewed

maxlou05 · 2024-07-01T22:12:06Z

network/modules/UDP/client_socket.py

+ self.server_address = server_address
+
+ @classmethod
+ def create(


Can we add a parameter for setting a timeout? Have a default of like 10seconds (see settimeout())

maxlou05 · 2024-07-01T22:15:50Z

network/modules/UDP/socket_wrapper.py

+
+ data_sent = 0
+ data_size = len(data)
+ chunk_size = 4096


Can we set this as a global constant like at the top of the file in all caps?

maxlou05 · 2024-07-01T22:19:38Z

network/modules/UDP/socket_wrapper.py

+ data_size = len(data)
+ chunk_size = 4096
+
+ while data_sent + chunk_size < data_size:


Don't put the check here, because if the user wanted to send 5000 bytes, the last 904 bytes will not be sent. Please keep this as data_sent < data_size and move the check to just prevent index out of bounds when (prevent it from trying to send 8192 bytes when there are only 5000 bytes)

maxlou05 · 2024-07-01T22:20:42Z

network/modules/UDP/socket_wrapper.py

+ For initializing Socket with an existing socket object.
+ """
+ if socket_instance is None:
+ self.__socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)


Add the timeout here as well, just in case

maxlou05

Approved!

* Created UDP Sockets * Addressed Comments * Added send() function and override recv() function in client_socket.py, addressed minor changes in socket_wrapper.py * Made requested changes * Updated docstrings

* Add image_encode and socket_wrapper in lte module * Refactor socket classes into client/server * Refactor network wrapper into "ClientSocket" and "ServerSocket" classes. Write tests for sending images * Run linters/formatters * Black and Pylint changes * Fixes for test_network.py * Refactor pytest into sender and receiver scripts * Fix in ServerSocket constructor * bug fixes for tests, and linter formats * - Refactored to indicate current sockets are TCP specific - Simplified many steps by using higher-level APIs - Added some comments and changed README * Created UDP sockets (#36) * Created UDP Sockets * Addressed Comments * Added send() function and override recv() function in client_socket.py, addressed minor changes in socket_wrapper.py * Made requested changes * Updated docstrings * Modify TCP unit tests to remove image encoding + linter and other fixes * fix rebase to main * add UDP unit tests + pytest automated unit tests for TCP & UDP. Refactored UDP class. * linter fixes * fix relative path issues * add integration test and slight modification to image_encoding * fix network address overuse in pytest due to teardown not fast enough * Update to python 3.11 (#47) * Using own forked dronekit, which is now compatible with python 3.11 * update to python 3.11 * incorporate WARG's dronekit fork as a submodule * fix new dronekit import in tests * fix linter issues * update submodules * minor fixes * add project setup scripts which update submodules as well * remove submodule libraries from requirements * remove empty comment in requirement.txt * Fix mavutil imports (#49) * mavutil is imported from pymavlink and not dronekit * fix linter and add __init__ file for root directory (since common is meant to be a module) * Apparently pytest cannot work if root dir has __init__ file * switch to relative imports * edit ci workflow to upgrade pip first * udpate CI workflow to newer versions * try adding __init__ again * move comment to doc string for test_image_encode_decode * Add image_encode and socket_wrapper in lte module * Refactor socket classes into client/server * Refactor network wrapper into "ClientSocket" and "ServerSocket" classes. Write tests for sending images * Run linters/formatters * Black and Pylint changes * Fixes for test_network.py * Refactor pytest into sender and receiver scripts * Fix in ServerSocket constructor * bug fixes for tests, and linter formats * - Refactored to indicate current sockets are TCP specific - Simplified many steps by using higher-level APIs - Added some comments and changed README * Created UDP sockets (#36) * Created UDP Sockets * Addressed Comments * Added send() function and override recv() function in client_socket.py, addressed minor changes in socket_wrapper.py * Made requested changes * Updated docstrings * Modify TCP unit tests to remove image encoding + linter and other fixes * fix rebase to main * add UDP unit tests + pytest automated unit tests for TCP & UDP. Refactored UDP class. * linter fixes * use relative imports * rename modules to be lower case * make socket's server_address variable private, fixed logger pytest --------- Co-authored-by: Maxwell Lou <[email protected]> Co-authored-by: Herman Gahra <[email protected]> Co-authored-by: Maxwell Lou <[email protected]>

Created UDP Sockets

2449aec

maxlou05 changed the base branch from main to lte-module June 29, 2024 20:01

maxlou05 reviewed Jun 29, 2024

View reviewed changes

network/modules/UDP/client_socket.py Show resolved Hide resolved

maxlou05 reviewed Jun 29, 2024

View reviewed changes

Addressed Comments

e0b67ea

maxlou05 reviewed Jun 30, 2024

View reviewed changes

network/modules/UDP/client_socket.py Show resolved Hide resolved

maxlou05 reviewed Jun 30, 2024

View reviewed changes

Added send() function and override recv() function in client_socket.p…

dce1b55

…y, addressed minor changes in socket_wrapper.py

maxlou05 reviewed Jul 1, 2024

View reviewed changes

HermanG05 added 2 commits July 1, 2024 17:25

Made requested changes

2d4f807

Updated docstrings

0405fb3

maxlou05 approved these changes Jul 2, 2024

View reviewed changes

HermanG05 merged commit 157846f into lte-module Jul 2, 2024

HermanG05 deleted the test-branch branch July 2, 2024 01:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Created UDP sockets #36

Created UDP sockets #36

HermanG05 commented Jun 27, 2024

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024 •

edited

Loading

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024 •

edited

Loading

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024

maxlou05 Jun 29, 2024

maxlou05 left a comment

maxlou05 Jun 30, 2024

maxlou05 Jun 30, 2024 •

edited

Loading

maxlou05 Jun 30, 2024

maxlou05 Jun 30, 2024

HermanG05 Jul 1, 2024

maxlou05 Jul 1, 2024

maxlou05 left a comment

maxlou05 Jul 1, 2024

maxlou05 Jul 1, 2024

maxlou05 Jul 1, 2024

maxlou05 left a comment

maxlou05 Jul 1, 2024

maxlou05 Jul 1, 2024

maxlou05 Jul 1, 2024

maxlou05 Jul 1, 2024

maxlou05 left a comment


		return True

		def recv_from(self, buf_size: int) -> "tuple[bool, bytes \| None]":


		while data_sent < data_size:

		chunk = data[data_sent:data_sent+4096]

Created UDP sockets #36

Created UDP sockets #36

Conversation

HermanG05 commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 Jun 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 Jun 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 Jun 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxlou05 left a comment

Choose a reason for hiding this comment

maxlou05 Jun 29, 2024 •

edited

Loading

maxlou05 Jun 29, 2024 •

edited

Loading

maxlou05 Jun 30, 2024 •

edited

Loading