diff options
| author | Sebastian Koslowski <koslowski@kit.edu> | 2015-09-23 16:41:39 +0200 |
|---|---|---|
| committer | Sebastian Koslowski <koslowski@kit.edu> | 2015-11-13 21:49:09 +0100 |
| commit | 7fb6e253fd1a815e40d3563e3f7f2ee41037c702 (patch) | |
| tree | e3f80ba48b3235ac595ffe34c1cce0506aacc38a /grc/python/extract_docs.py | |
| parent | 95287379e1ac7fa2f0bb92d7b17f754ad8bfe674 (diff) | |
grc: try to load block class from <import> and <make> to extract docstring
Diffstat (limited to 'grc/python/extract_docs.py')
| -rw-r--r-- | grc/python/extract_docs.py | 43 |
1 files changed, 41 insertions, 2 deletions
diff --git a/grc/python/extract_docs.py b/grc/python/extract_docs.py index 837d26ca6f..d8dc4f4e8f 100644 --- a/grc/python/extract_docs.py +++ b/grc/python/extract_docs.py @@ -77,6 +77,38 @@ def docstring_guess_from_key(key): return doc_strings +def docstring_from_make(key, imports, make): + """Extract the documentation from the python __doc__ strings + + By importing it and checking a truncated make + + Args: + key: the block key + imports: a list of import statements (string) to execute + make: block constructor template + + Returns: + a list of tuples (block_name, doc string) + """ + + try: + blk_cls = make.partition('(')[0].strip() + if '$' in blk_cls: + raise ValueError('Not an identifier') + + ns = dict() + for _import in imports: + exec(_import.strip(), ns) + blk = eval(blk_cls, ns) + + doc_strings = {key: blk.__doc__} + + except (ImportError, AttributeError, SyntaxError, ValueError): + doc_strings = docstring_guess_from_key(key) + + return doc_strings + + ############################################################################### # Manage docstring extraction in separate process ############################################################################### @@ -178,11 +210,14 @@ class SubprocessLoader(object): else: print >> sys.stderr, "Unknown response:", cmd, args - def query(self, key): + def query(self, key, imports=None, make=None): """request docstring extraction for a certain key""" if self._thread is None: self.start() - self._queue.put(('query', (key,))) + if imports and make: + self._queue.put(('query', (key, imports, make))) + else: + self._queue.put(('query_key_only', (key,))) def finish(self): """signal end of requests""" @@ -222,6 +257,9 @@ def worker_main(): code, cmd, args = json.loads(line, encoding='utf-8') try: if cmd == 'query': + key, imports, make = args + send('result', (key, docstring_from_make(key, imports, make))) + elif cmd == 'query_key_only': key, = args send('result', (key, docstring_guess_from_key(key))) elif cmd == 'exit': @@ -248,6 +286,7 @@ elif __name__ == '__main__': # r.query('uhd_source') r.query('expr_utils_graph') r.query('blocks_add_cc') + r.query('blocks_add_cc', ['import gnuradio.blocks'], 'gnuradio.blocks.add_cc(') # r.query('analog_feedforward_agc_cc') # r.query('uhd_source') # r.query('uhd_source') |