From 48ad7941d1717d6b678fd1cc24a232056a132641 Mon Sep 17 00:00:00 2001
From: Robert Habermann <mail@rhab.de>
Date: Mon, 18 Apr 2016 01:50:03 +0200
Subject: [PATCH] fix docs
---
docs/source/pyotrs.txt | 10 ++--
docs/source/pyotrs_public.txt | 10 ++--
pyotrs/lib.py | 91 +++++++++++++++++++++++++++++++++++
3 files changed, 101 insertions(+), 10 deletions(-)
diff --git a/docs/source/pyotrs.txt b/docs/source/pyotrs.txt
index de0cea1..bce8a43 100644
--- a/docs/source/pyotrs.txt
+++ b/docs/source/pyotrs.txt
@@ -12,7 +12,7 @@ PyOTRS Lib (all)
:mod:`pyotrs.lib.Article`
-------------------------
+-------------------------
.. autoclass:: pyotrs.lib.Article
:members:
@@ -23,7 +23,7 @@ PyOTRS Lib (all)
:mod:`pyotrs.lib.Attachment`
-------------------------
+----------------------------
.. autoclass:: pyotrs.lib.Attachment
:members:
@@ -34,7 +34,7 @@ PyOTRS Lib (all)
:mod:`pyotrs.lib.AttachmentList`
-------------------------
+--------------------------------
.. autoclass:: pyotrs.lib.AttachmentList
:members:
@@ -56,7 +56,7 @@ PyOTRS Lib (all)
:mod:`pyotrs.lib.DynamicField`
-------------------------
+------------------------------
.. autoclass:: pyotrs.lib.DynamicField
:members:
@@ -67,7 +67,7 @@ PyOTRS Lib (all)
:mod:`pyotrs.lib.DynamicFieldList`
-------------------------
+----------------------------------
.. autoclass:: pyotrs.lib.DynamicFieldList
:members:
diff --git a/docs/source/pyotrs_public.txt b/docs/source/pyotrs_public.txt
index 2c5bbcc..0371b28 100644
--- a/docs/source/pyotrs_public.txt
+++ b/docs/source/pyotrs_public.txt
@@ -11,7 +11,7 @@ PyOTRS Lib (public)
:mod:`pyotrs.lib.Article`
-------------------------
+-------------------------
.. autoclass:: pyotrs.lib.Article
:members:
@@ -21,7 +21,7 @@ PyOTRS Lib (public)
:mod:`pyotrs.lib.Attachment`
-------------------------
+----------------------------
.. autoclass:: pyotrs.lib.Attachment
:members:
@@ -31,7 +31,7 @@ PyOTRS Lib (public)
:mod:`pyotrs.lib.AttachmentList`
-------------------------
+--------------------------------
.. autoclass:: pyotrs.lib.AttachmentList
:members:
@@ -51,7 +51,7 @@ PyOTRS Lib (public)
:mod:`pyotrs.lib.DynamicField`
-------------------------
+------------------------------
.. autoclass:: pyotrs.lib.DynamicField
:members:
@@ -61,7 +61,7 @@ PyOTRS Lib (public)
:mod:`pyotrs.lib.DynamicFieldList`
-------------------------
+----------------------------------
.. autoclass:: pyotrs.lib.DynamicFieldList
:members:
diff --git a/pyotrs/lib.py b/pyotrs/lib.py
index a080a41..e4ea241 100644
--- a/pyotrs/lib.py
+++ b/pyotrs/lib.py
@@ -122,6 +122,14 @@ class Article(object):
@classmethod
def create_basic(cls, dct):
+ """ create basic Article
+
+ Args:
+ dct:
+
+ Returns:
+
+ """
for key, value in dct.items():
logger.debug("Create Basic Article: {0} <==> {1}".format(key, value))
@@ -131,6 +139,11 @@ class Article(object):
@classmethod
def dummy(cls):
+ """ dummy data (for testing)
+
+ Returns:
+
+ """
_dct = {"Subject": "Dümmy Subject",
"Body": "Hallo Bjørn,\n[kt]\n\n -- The End",
"TimeUnit": 0,
@@ -139,6 +152,11 @@ class Article(object):
return Article(_dct)
def to_dct(self):
+ """
+
+ Returns:
+
+ """
return {"Article": self.__dict__}
def validate(self):
@@ -180,6 +198,11 @@ class Attachment(object):
@classmethod
def dummy(cls):
+ """ dummy data (for testing)
+
+ Returns:
+
+ """
_content = (
"IyBjb250ZW50IG9mIHNldHVwLmNmZwpbcHl0ZXN0XQpub3JlY3Vyc2VkaXJzID0gL"
"mdpdAphZGRvcHRzID0gLS1kb2N0ZXN0LW1vZHVsZXMKClttZXRhZGF0YV0KZGVzY3"
@@ -219,9 +242,22 @@ class AttachmentList(object):
"""
def add(self, attachment):
+ """ add Attachment to AttachmentList
+
+ Args:
+ attachment:
+
+ Returns:
+
+ """
self.attachments.append(attachment)
def to_dct(self):
+ """ represent AttachmentList and related Attachment objects as dict
+
+ Returns:
+
+ """
_lst = []
for attachments in self:
_lst.append(attachments.__dict__)
@@ -229,6 +265,11 @@ class AttachmentList(object):
@classmethod
def dummy(cls):
+ """ dummy data (for testing)
+
+ Returns:
+
+ """
return AttachmentList(Attachment.dummy())
@@ -255,6 +296,11 @@ class DynamicField(object):
@classmethod
def dummy(cls):
+ """ dummy data (for testing)
+
+ Returns:
+
+ """
_lst = [{'Name': 'lastname', 'Value': 'Doe'},
{'Name': 'firstname', 'Value': 'Jane'}]
return DynamicField(_lst)
@@ -288,9 +334,22 @@ class DynamicFieldList(object):
"""
def add(self, dynamic_field_dicts):
+ """ add DynamicField object to DynamicFieldList
+
+ Args:
+ dynamic_field_dicts:
+
+ Returns:
+
+ """
self.dynamic_field_dicts.append(dynamic_field_dicts)
def to_dct(self):
+ """ represent DynamicFieldList and related DynamicField objects as dict
+
+ Returns:
+
+ """
_lst = []
for dynamic_field_dict in self:
for item in dynamic_field_dict:
@@ -299,6 +358,11 @@ class DynamicFieldList(object):
@classmethod
def dummy(cls):
+ """ dummy data (for testing)
+
+ Returns:
+
+ """
return DynamicFieldList(DynamicField.dummy())
@@ -347,6 +411,22 @@ class Ticket(object):
Priority=None,
CustomerUser=None,
**kwargs):
+ """ create basic ticket
+
+ Args:
+ Title:
+ QueueID:
+ Queue:
+ StateID:
+ State:
+ PriorityID:
+ Priority:
+ CustomerUser:
+ **kwargs:
+
+ Returns:
+
+ """
if not Title:
raise ValueError("Title is required")
@@ -389,10 +469,21 @@ class Ticket(object):
return Ticket(dct)
def to_dct(self):
+ """ represent Ticket objects as dict
+
+ Returns:
+
+ """
+
return {"Ticket": self.__dict__}
@classmethod
def dummy(cls):
+ """ dummy data (for testing)
+
+ Returns:
+
+ """
_queue = u"Raw"
_state = u"open"
_priority = u"3 normal"
--
GitLab