Skip to content

Fixed marshaller documentation typo's in http #76

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 27, 2020
Merged

Fixed marshaller documentation typo's in http #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0ee282
Fixed marshaller documentation in http directory
Jul 27, 2020
dad29cd
adjusted marshaller documentation
Jul 27, 2020
af4388a
Merge branch 'v1.0.0-dev' into documentation-overhaul
cumason123 Jul 27, 2020
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
8 changes: 4 additions & 4 deletions cloudevents/sdk/http/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def from_http(
:type data: typing.IO
:param headers: the HTTP headers
:type headers: typing.Dict[str, str]
:param data_unmarshaller: Callable function to map data arg to python object
:param data_unmarshaller: Callable function to map data to a python object
e.g. lambda x: x or lambda x: json.loads(x)
:type data_unmarshaller: types.UnmarshallerType
"""
Expand Down Expand Up @@ -106,9 +106,9 @@ def from_json(
Cast json encoded data into an EventClass
:param data: json encoded cloudevent data
:type event: typing.Union[str, bytes]
:param data_unmarshaller: Callable function which will cast json encoded
data into a python object retrievable from returned EventClass.data
:type data_marshaller: typing.Callable
:param data_unmarshaller: Callable function which will cast data to a
python object
:type data_unmarshaller: typing.Callable
:returns: EventClass representing given cloudevent json object
"""
return from_http(data=data, headers={}, data_unmarshaller=data_unmarshaller)
20 changes: 13 additions & 7 deletions cloudevents/sdk/http/event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,10 @@ def __init__(
):
"""
Event Constructor
:param attributes: a dict with HTTP headers
:param attributes: a dict with cloudevent attributes. Minimally
expects the attributes 'type' and 'source'. If not given the
attributes 'specversion', 'id' or 'time', this will create
those attributes with default values.
e.g. {
"content-type": "application/cloudevents+json",
"id": "16fb5f0b-211e-1102-3dfe-ea6e2806f124",
Expand Down Expand Up @@ -122,8 +125,9 @@ def _to_http(

:param format: constant specifying an encoding format
:type format: str
:param data_unmarshaller: Function used to read the data to string.
:type data_unmarshaller: types.UnmarshallerType
:param data_marshaller: Callable function to cast event.data into
either a string or bytes
:type data_marshaller: types.MarshallerType
:returns: (http_headers: dict, http_body: bytes or str)
"""
if data_marshaller is None:
Expand Down Expand Up @@ -152,8 +156,9 @@ def to_structured_http(

:param event: CloudEvent to cast into http data
:type event: CloudEvent
:param data_unmarshaller: Function used to read the data to string.
:type data_unmarshaller: types.UnmarshallerType
:param data_marshaller: Callable function to cast event.data into
either a string or bytes
:type data_marshaller: types.MarshallerType
:returns: (http_headers: dict, http_body: bytes or str)
"""
return _to_http(event=event, data_marshaller=data_marshaller)
Expand All @@ -167,8 +172,9 @@ def to_binary_http(

:param event: CloudEvent to cast into http data
:type event: CloudEvent
:param data_unmarshaller: Function used to read the data to string.
:type data_unmarshaller: types.UnmarshallerType
:param data_marshaller: Callable function to cast event.data into
either a string or bytes
:type data_marshaller: types.UnmarshallerType
:returns: (http_headers: dict, http_body: bytes or str)
"""
return _to_http(
Expand Down