Skip to content

WIP: Split/regroup client components #1326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions tuf/client_rework/fetcher.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Copyright 2021, New York University and the TUF contributors
# SPDX-License-Identifier: MIT OR Apache-2.0

"""Provides an interface for network IO abstraction.
"""

# Imports
import abc


# Classes
class FetcherInterface:
"""Defines an interface for abstract network download.

By providing a concrete implementation of the abstract interface,
users of the framework can plug-in their preferred/customized
network stack.
"""

__metaclass__ = abc.ABCMeta

@abc.abstractmethod
def fetch(self, url, required_length):
"""Fetches the contents of HTTP/HTTPS url from a remote server.

Ensures the length of the downloaded data is up to 'required_length'.

Arguments:
url: A URL string that represents a file location.
required_length: An integer value representing the file length in bytes.

Raises:
tuf.exceptions.SlowRetrievalError: A timeout occurs while receiving data.
tuf.exceptions.FetcherHTTPError: An HTTP error code is received.

Returns:
A bytes iterator
"""
raise NotImplementedError # pragma: no cover
Loading