Skip to content

Commit

Permalink
#7: Added docstrings to structures/outgoing.py.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bystroushaak committed Dec 8, 2015
1 parent 3a77646 commit fe76b62
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/edeposit/amqp/rest/structures/outgoing.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,27 @@
#
# Interpreter version: python 2.7
#
"""
Structures which are sent back to edeposit.
"""
# Imports =====================================================================
from collections import namedtuple


# Variables ===================================================================
# Functions & classes =========================================================
class UploadRequest(namedtuple("UploadRequest", ["username",
"rest_id",
"b64_data",
"metadata"])):
"""
User's upload request with following data:
Attributes:
username (str): User's handle in the REST system. See
:class:`.SaveLogin` and :class:`.RemoveLogin`.
rest_id (str): Unique identificator of the request.
b64_data (str): Content of the file packed as base64 data.
metadata (dict): Dictionary with metadata.
"""


Expand Down

0 comments on commit fe76b62

Please sign in to comment.