File: interface.py

package info (click to toggle)
python-tuspy 1.0.3-0.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 212 kB
  • sloc: python: 884; makefile: 3
file content (35 lines) | stat: -rw-r--r-- 877 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
"""
Interface module defining a url storage API.
"""
import abc


class Storage(object, metaclass=abc.ABCMeta):
    @abc.abstractmethod
    def get_item(self, key):
        """
        Return the tus url of a file, identified by the key specified.

        :Args:
            - key[str]: The unique id for the stored item (in this case, url)
        :Returns: url[str]
        """
        pass

    @abc.abstractmethod
    def set_item(self, key, value):
        """
        Store the url value under the unique key.

        :Args:
            - key[str]: The unique id to which the item (in this case, url) would be stored.
            - value[str]: The actual url value to be stored.
        """
        pass

    @abc.abstractmethod
    def remove_item(self, key):
        """
        Remove/Delete the url value under the unique key from storage.
        """
        pass