BIND 10 #2853: Python wrapper of data source extensions

[BIND 10 Development]

#2853: Python wrapper of data source extensions
-------------------------------------+-------------------------------------
            Reporter:  jinmei        |                        Owner:  muks
                Type:  task          |                       Status:
            Priority:  medium        |  reviewing
           Component:  data source   |                    Milestone:
            Keywords:                |  Sprint-20130611
           Sensitive:  0             |                   Resolution:
         Sub-Project:  DNS           |                 CVSS Scoring:
Estimated Difficulty:  5             |              Defect Severity:  N/A
         Total Hours:  0             |  Feature Depending on Ticket:
                                     |  shared memory data source
                                     |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------

Comment (by jinmei):

 noticed while trying to use it for #2854: docstring for some
 `ConfigurableClientList` is not helpful:

 {{{
  |  get_status(...)
  |      get_status() -> list
  |
  |      Wrapper around C++ ConfigurableClientList::getStatus
  |
  |      This returns a list of tuples, each containing the status of a
 data source client.
  |
  |  reset_memory_segment(...)
  |      reset_memory_segment(datasrc_name, mode, config_params) -> None
  |
  |      Wrapper around C++ ConfigurableClientList::resetMemorySegment
  |
  |      This resets the zone table segment for a datasource with a new
  |      memory segment.
  |
  |      Parameters:
  |        datasrc_name      The name of the data source whose segment to
 reset.  mode              The open mode for the new memory segment.
 config_params     The configuration for the new memory segment, as a JSON
 encoded string.
 }}}

 This doesn't even explain the number of entries of the tuples.  For
 Python programmers using this API, we need an equivalent to the
 description of `DataSourceStatus`.

 Also, it's not really useful for Python programmers to know it's a
 wrapper for some C++ methods; all they need to know is how
 specifically they can use these methods in their Python programs (I
 wouldn't necessarily insist they be removed, if they are mentioned as
 information for someone extending the wrapper interface itself, but
 right now it looks very awkward in that it doesn't provide more
 important description while providing such bonus information).

 The description of reset_memory_segment is slightly better, but at
 least its format isn't pretty.

-- 
Ticket URL: <http://bind10.isc.org/ticket/2853#comment:18>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development