sphinx / sphinx / ext / refcounting.py

The branch '#1056' does not exist.
# -*- coding: utf-8 -*-

    Supports reference count annotations for C API functions.  Based on
    refcount.py and anno-api.py in the old Python documentation tools.

    Usage: Set the `refcount_file` config value to the path to the reference
    count data file.

    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.

from os import path
from docutils import nodes

from sphinx import addnodes
from sphinx.locale import _

# refcount annotation
class refcount(nodes.emphasis): pass

class RCEntry:
    def __init__(self, name):
        self.name = name
        self.args = []
        self.result_type = ''
        self.result_refs = None

class Refcounts(dict):
    def fromfile(cls, filename):
        d = cls()
        fp = open(filename, 'r')
            for line in fp:
                line = line.strip()
                if line[:1] in ("", "#"):
                    # blank lines and comments
                parts = line.split(":", 4)
                if len(parts) != 5:
                    raise ValueError("Wrong field count in %r" % line)
                function, type, arg, refcount, comment = parts
                # Get the entry, creating it if needed:
                    entry = d[function]
                except KeyError:
                    entry = d[function] = RCEntry(function)
                if not refcount or refcount == "null":
                    refcount = None
                    refcount = int(refcount)
                # Update the entry with the new parameter or the result
                # information.
                if arg:
                    entry.args.append((arg, type, refcount))
                    entry.result_type = type
                    entry.result_refs = refcount
        return d

    def add_refcount_annotations(self, app, doctree):
        for node in doctree.traverse(addnodes.desc_content):
            par = node.parent
            if par['domain'] != 'c' or par['objtype'] != 'function':
            if not par[0].has_key('names') or not par[0]['names']:
            entry = self.get(par[0]['names'][0])
            if not entry:
            elif entry.result_type not in ("PyObject*", "PyVarObject*"):
            rc = _('Return value: ')
            if entry.result_refs is None:
                rc += _("Always NULL.")
                if entry.result_refs:
                    rc += _("New reference.")
                    rc += _("Borrowed reference.")
            node.insert(0, refcount(rc, rc))

def init_refcounts(app):
    if app.config.refcount_file:
        refcounts = Refcounts.fromfile(
            path.join(app.srcdir, app.config.refcount_file))
        app.connect('doctree-read', refcounts.add_refcount_annotations)

def setup(app):
    app.add_config_value('refcount_file', '', True)
    app.connect('builder-inited', init_refcounts)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.