coordinator.upload_utils Namespace Reference

Functions
None	handle_upload_request (int content_length, str content_boundary, bytes expect_digest, io.BufferedIOBase stream, str file_name)

Variables
int	READ_CHUNK_SIZE = 4096

Function Documentation

handle_upload_request()

None coordinator.upload_utils.handle_upload_request	(	int	content_length,
		str	content_boundary,
		bytes	expect_digest,
		io.BufferedIOBase	stream,
		str	file_name
	)

Given sufficient header data and an input stream, stream raw content to a
file, hashing it at the same time to verify the given signature.

Definition at line 72 of file upload_utils.py.

def handle_upload_request(
        content_length: int,
        content_boundary: str,
        expect_digest: bytes,
        stream: io.BufferedIOBase,
        file_name: str) -> None:
    """
    Given sufficient header data and an input stream, stream raw content to a
    file, hashing it at the same time to verify the given signature.
    """
 
    final_boundary = f"\r\n--{content_boundary}--\r\n"
    final_boundary_size = len(final_boundary)
 
    # Expect the stream to be formatted:
    #   --------------------------985b875979d96dfa          <boundary>
    #   Content-Disposition: form-data; ....                <part-header>
    #   Content-Type: application/octet-stream              <part-header>
    #   ...                                                 <part-header>
    #                                                       <blank-line>
    #   <raw-content>                                       <part-data>
    #   --------------------------985b875979d96dfa--        <final-boundary>
    # Note, for simplicity we assume content is single-part
 
    remaining_bytes = content_length - final_boundary_size
 
    # Skip the headers
    header_bytes = _read_part_headers(stream)
    remaining_bytes = remaining_bytes - header_bytes
 
    # Read up to the final boundary,
    # print(f"expecting {remaining_bytes} file bytes")
    digest = _read_to_file(stream, file_name, remaining_bytes)
    if digest is None:
        raise Exception("invalid part format")
    if digest != expect_digest:
        raise Exception("digest mismatch")
 
    # Read final boundary and sanity check
    tail = _read_to_memory(stream, final_boundary_size)
    if tail is None or tail.decode() != final_boundary:
        raise Exception("invalid part tail")

Here is the caller graph for this function:

Variable Documentation

READ_CHUNK_SIZE

int coordinator.upload_utils.READ_CHUNK_SIZE = 4096

Definition at line 11 of file upload_utils.py.