Package: parinx
Parinx======Parinx implements a basic Sphinx docstring parser language which providesa interface to extract the relavant parameter. You might findit most useful for tasks involving automated data extraction from sphinxdocs. Typical usage often looks like this::```python#!/usr/bin/env pythonfrom parinx import parserdef test_parse_docstring(self):docstring = """Return a dict.:type zone_id: ``str``:param zone_id: Required zone id (required):keyword    auth:   Initial authentication information for the node(optional):rtype:    ``dict``"""result = parser.parse_docstring(docstring)print (result)```(Note parse_docstrings return a dictionary)`Parinx` is a Python module that makes working with Sphinx feel like you are working with [JSON](http://docs.python.org/library/json.html):parse_docstring===============`parse_docstring` takes `docstring` and `cls` i.e. class name as argument.Default value for cls is `None`.It returns dict which contains <br/><pre>`description` of method <br/>`arguments` contains dict of dict: zone_id{type_name, desciption and required} <br/>`return` contains dict: {type_name, class, description} <br/></pre>### When `cls=None````python>>> from parinx.parser import parse_docstring>>> docstring = """...         Return a Zone instance....         Second line docsting.......         :type zone_id: ``str``...         :param zone_id: Required zone id (required)......         :keyword    auth:   Initial authentication information for the node...                             (optional)...         :type       auth: :class:`NodeAuthSSHKey` or `NodeAuthPassword`......         :return:    instance...         :rtype: :class:`Zone` or `Node`...         """>>> result = parse_docstring(docstring)>>> result{'return':{'type_name': 'class:`Zone` or `Node`','description': 'instance'},'description': 'Return a Zone instance. Second line docsting.','arguments':defaultdict(<function <lambda> at 0x200be60>,{'zone_id':{'type_name': '``str``','description': 'Required zone id (required)','required': True},'auth':{'type_name': 'class:`NodeAuthSSHKey` or `NodeAuthPassword`','description':'Initial authentication information for the node(optional)','required': False}})}>>> result['arguments']defaultdict(<function <lambda> at 0x200bed8>,{'zone_id':{'type_name': '``str``','description': 'Required zone id (required)','required': True},'auth':{'type_name': 'class:`NodeAuthSSHKey` or `NodeAuthPassword`','description': 'Initial authentication information for the node (optional)','required': False}})>>> result['description']'Return a Zone instance. Second line docsting.'>>> return_type = result['return']['type_name']>>> return_type'class:`Zone` or `Node`'```### When `cls!= None````python>>> class Foo(object):...     def create_node(self, **kwargs):...             """...             Create a new node instance.......             :keyword    name:   String with a name for this new node (required)...             :type       name:   ``str``......             :keyword    size:   The size of resources allocated to this node....                                 (required)...             :type       size:   ``dict``......             :return: The newly created node....             :rtype: :class:`Node`...             """...>>> docstring = get_method_docstring(Foo, 'create_node')>>> parse_docstring(docstring, Foo){'return':{'type_name': 'class:`Node`','description': 'The newly created node.'},'description': 'Create a new node instance.','arguments': defaultdict(<function <lambda> at 0x17eb8c0>,{'name':{'type_name': '``str``','description': 'String with a name for this new node (required)','required': True},'size':{'type_name': '``dict``','description': 'The size of resources allocated to this node.(required)','required': True}})}```split_docstring===============`split_docstring' return description and list of fields strings.Supported field strings are:* ':param' <br/>* ':type' <br/>* ':keyword' <br/>* ':rtype:' <br/>* '@inherits:' <br/>* ':return:' <br/>```python>>> result = split_docstring(docstring)>>> result('Return a node instance.',[':keyword    name:   String with a name for this new node (required)',':type       name:   ``str`` ',':keyword    size: The size of resources allocated to this node. (required)',':type       size: ``dict`` ',':return: instance',':rtype: :class:`Node` '])>>> result[1][':keyword    name:   String with a name for this new node (required)',':type name:   ``str`` ',':keyword    size:   The size of resources allocated to this node.(required)',':type       size:   ``dict`` ',':return: instance',':rtype: :class:`Node` ']>>> result[1][3]':type       size:   ``dict`` '```get_method_docstring====================`get_method_docstring` takes class name(cls) and method name as argument(method_name).It returns method docstring. <br/>If method docstring is empty then it takes it from parent class.```python>>> class Parent(object):def create_node(self, **kwargs):"""Create a new node instance.:keyword    name:   String with a name for this new node (required):type       name:   ``str``:keyword    size:   The size of resources allocated to this node.(required):type       size:   ``dict``:return: The newly created node.:rtype: :class:`Node`""">>> class Child(Parent):def return_node(self, **kwargs):"""Return a Zone instance.Second line docsting.:type zone_id: ``str``:param zone_id: Required zone id (required):keyword    auth:   Initial authentication information for the node(optional):type       auth: :class:`NodeAuthSSHKey` or `NodeAuthPassword`:return:    instance:rtype: :class:`Zone` or `Node`"""``````python>>> from parinx.parser import get_method_string>>> get_method_docstring(Parent, 'create_node').split('\n')['Create a new node instance.', '',':keyword    name:   String with a name for this new node (required)',':type       name:   ``str``', '',':keyword    size:   The size of resources allocated to this node.','                        (required)',':type       size:   ``dict``', '',':return: The newly created node.',':rtype: :class:`Node`']>>> get_method_docstring(Child, 'return_node').split('\n')['Return a Zone instance.','Second line docsting.', '',':type zone_id: ``str``',':param zone_id: Required zone id (required)', '',':keyword    auth: Initial authentication information for the node','                    (optional)',':type       auth: :class:`NodeAuthSSHKey` or `NodeAuthPassword`', '',':return:    instance', ':rtype: :class:`Zone` or `Node`']>>> get_method_docstring(Child, 'create_node').split('\n')['Create a new node instance.', '',':keyword    name:String with a name for this new node (required)',':type       name:   ``str``', '',':keyword    size:   The size of resources allocated to this node.','                        (required)',':type       size:   ``dict``', '',':return: The newly created node.',':rtype: :class:`Node`']>>> get_method_docstring(Parent, 'return_node').split('\n')```