From dfa5ef23758b2370f0132241242366fe8282d475 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 17 Jan 2010 19:46:47 +0100 Subject: [PATCH] Rename doc_read_data to temp_data, which reflects better what it does. --- sphinx/directives/__init__.py | 6 +++--- sphinx/directives/other.py | 6 +++--- sphinx/domains/python.py | 26 +++++++++++++------------- sphinx/domains/std.py | 10 +++++----- sphinx/environment.py | 20 ++++++++++---------- sphinx/ext/autodoc.py | 20 ++++++++++---------- sphinx/ext/autosummary/__init__.py | 2 +- sphinx/ext/inheritance_diagram.py | 2 +- 8 files changed, 46 insertions(+), 46 deletions(-) diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 134aaf549..41b1357cd 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -132,12 +132,12 @@ class ObjectDescription(Directive): node.append(contentnode) if self.names: # needed for association of version{added,changed} directives - self.env.doc_read_data['object'] = self.names[0] + self.env.temp_data['object'] = self.names[0] self.before_content() self.state.nested_parse(self.content, self.content_offset, contentnode) #self.handle_doc_fields(contentnode) DocFieldTransformer(self).transform_all(contentnode) - self.env.doc_read_data['object'] = None + self.env.temp_data['object'] = None self.after_content() return [self.indexnode, node] @@ -159,7 +159,7 @@ class DefaultDomain(Directive): def run(self): env = self.state.document.settings.env domain_name = self.arguments[0] - env.doc_read_data['default_domain'] = env.domains.get(domain_name) + env.temp_data['default_domain'] = env.domains.get(domain_name) directives.register_directive('default-domain', DefaultDomain) diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index ef23a32d6..c71f9afe3 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -212,10 +212,10 @@ class VersionChange(Directive): ret = [node] env = self.state.document.settings.env env.versionchanges.setdefault(node['version'], []).append( - (node['type'], env.doc_read_data['docname'], self.lineno, + (node['type'], env.temp_data['docname'], self.lineno, # XXX: python domain specific - env.doc_read_data.get('py:module'), - env.doc_read_data.get('object'), + env.temp_data.get('py:module'), + env.temp_data.get('object'), node.astext())) return ret diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index b31a3f8c1..554b8f152 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -87,8 +87,8 @@ class PyObject(ObjectDescription): # determine module and class name (if applicable), as well as full name modname = self.options.get( - 'module', self.env.doc_read_data.get('py:module')) - classname = self.env.doc_read_data.get('py:class') + 'module', self.env.temp_data.get('py:module')) + classname = self.env.temp_data.get('py:class') if classname: add_module = False if name_prefix and name_prefix.startswith(classname): @@ -125,7 +125,7 @@ class PyObject(ObjectDescription): # 'exceptions' module. elif add_module and self.env.config.add_module_names: modname = self.options.get( - 'module', self.env.doc_read_data.get('py:module')) + 'module', self.env.temp_data.get('py:module')) if modname and modname != 'exceptions': nodetext = modname + '.' signode += addnodes.desc_addname(nodetext, nodetext) @@ -170,7 +170,7 @@ class PyObject(ObjectDescription): def add_target_and_index(self, name_cls, sig, signode): modname = self.options.get( - 'module', self.env.doc_read_data.get('py:module')) + 'module', self.env.temp_data.get('py:module')) fullname = (modname and modname + '.' or '') + name_cls[0] # note target if fullname not in self.state.document.ids: @@ -199,7 +199,7 @@ class PyObject(ObjectDescription): def after_content(self): if self.clsname_set: - self.env.doc_read_data['py:class'] = None + self.env.temp_data['py:class'] = None class PyModulelevel(PyObject): @@ -244,7 +244,7 @@ class PyClasslike(PyObject): def before_content(self): PyObject.before_content(self) if self.names: - self.env.doc_read_data['py:class'] = self.names[0][0] + self.env.temp_data['py:class'] = self.names[0][0] self.clsname_set = True @@ -322,8 +322,8 @@ class PyClassmember(PyObject): def before_content(self): PyObject.before_content(self) lastname = self.names and self.names[-1][1] - if lastname and not self.env.doc_read_data.get('py:class'): - self.env.doc_read_data['py:class'] = lastname.strip('.') + if lastname and not self.env.temp_data.get('py:class'): + self.env.temp_data['py:class'] = lastname.strip('.') self.clsname_set = True @@ -347,7 +347,7 @@ class PyModule(Directive): env = self.state.document.settings.env modname = self.arguments[0].strip() noindex = 'noindex' in self.options - env.doc_read_data['py:module'] = modname + env.temp_data['py:module'] = modname env.domaindata['py']['modules'][modname] = \ (env.docname, self.options.get('synopsis', ''), self.options.get('platform', ''), 'deprecated' in self.options) @@ -391,16 +391,16 @@ class PyCurrentModule(Directive): env = self.state.document.settings.env modname = self.arguments[0].strip() if modname == 'None': - env.doc_read_data['py:module'] = None + env.temp_data['py:module'] = None else: - env.doc_read_data['py:module'] = modname + env.temp_data['py:module'] = modname return [] class PyXRefRole(XRefRole): def process_link(self, env, refnode, has_explicit_title, title, target): - refnode['py:module'] = env.doc_read_data.get('py:module') - refnode['py:class'] = env.doc_read_data.get('py:class') + refnode['py:module'] = env.temp_data.get('py:module') + refnode['py:class'] = env.temp_data.get('py:class') if not has_explicit_title: title = title.lstrip('.') # only has a meaning for the target target = target.lstrip('~') # only has a meaning for the title diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index a6f437764..da28f956a 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -147,7 +147,7 @@ class Cmdoption(ObjectDescription): def add_target_and_index(self, name, sig, signode): targetname = name.replace('/', '-') - currprogram = self.env.doc_read_data.get('std:program') + currprogram = self.env.temp_data.get('std:program') if currprogram: targetname = '-' + currprogram + targetname targetname = 'cmdoption' + targetname @@ -176,9 +176,9 @@ class Program(Directive): env = self.state.document.settings.env program = ws_re.sub('-', self.arguments[0].strip()) if program == 'None': - env.doc_read_data['std:program'] = None + env.temp_data['std:program'] = None else: - env.doc_read_data['std:program'] = program + env.temp_data['std:program'] = program return [] @@ -186,7 +186,7 @@ class OptionXRefRole(XRefRole): innernodeclass = addnodes.literal_emphasis def process_link(self, env, refnode, has_explicit_title, title, target): - program = env.doc_read_data.get('std:program') + program = env.temp_data.get('std:program') if not has_explicit_title: if ' ' in title and not (title.startswith('/') or title.startswith('-')): @@ -217,7 +217,7 @@ class Glossary(Directive): def run(self): env = self.state.document.settings.env objects = env.domaindata['std']['objects'] - gloss_entries = env.doc_read_data.setdefault('gloss_entries', set()) + gloss_entries = env.temp_data.setdefault('gloss_entries', set()) node = addnodes.glossary() node.document = self.state.document self.state.nested_parse(self.content, self.content_offset, node) diff --git a/sphinx/environment.py b/sphinx/environment.py index 47ca3df00..9e5c91b5c 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -315,7 +315,7 @@ class BuildEnvironment: self.dlfiles = FilenameUniqDict() # temporary data storage while reading a document - self.doc_read_data = {} + self.temp_data = {} # Some magically present labels def add_magic_label(name, description): @@ -557,7 +557,7 @@ class BuildEnvironment: return element, [] # else look in the default domain else: - def_domain = self.doc_read_data.get('default_domain') + def_domain = self.temp_data.get('default_domain') if def_domain is not None: element = getattr(def_domain, type)(name) if element is not None: @@ -610,9 +610,9 @@ class BuildEnvironment: self.warn(docname, 'default role %s not found' % self.config.default_role) - self.doc_read_data['docname'] = docname + self.temp_data['docname'] = docname # defaults to the global default, but can be re-set in a document - self.doc_read_data['default_domain'] = \ + self.temp_data['default_domain'] = \ self.domains.get(self.config.default_domain) self.settings['input_encoding'] = self.config.source_encoding @@ -683,7 +683,7 @@ class BuildEnvironment: metanode.__class__ = addnodes.meta # cleanup - self.doc_read_data.clear() + self.temp_data.clear() if save_parsed: # save the parsed doctree @@ -705,23 +705,23 @@ class BuildEnvironment: @property def docname(self): """Backwards compatible alias.""" - return self.doc_read_data['docname'] + return self.temp_data['docname'] @property def currmodule(self): """Backwards compatible alias.""" - return self.doc_read_data.get('py:module') + return self.temp_data.get('py:module') @property def currclass(self): """Backwards compatible alias.""" - return self.doc_read_data.get('py:class') + return self.temp_data.get('py:class') def new_serialno(self, category=''): """Return a serial number, e.g. for index entry targets.""" key = category + 'serialno' - cur = self.doc_read_data.get(key, 0) - self.doc_read_data[key] = cur + 1 + cur = self.temp_data.get(key, 0) + self.temp_data[key] = cur + 1 return cur def note_dependency(self, filename): diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index c08007cde..ab5784d53 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -564,9 +564,9 @@ class Documenter(object): do all members, else those given by *self.options.members*. """ # set current namespace for finding members - self.env.doc_read_data['autodoc:module'] = self.modname + self.env.temp_data['autodoc:module'] = self.modname if self.objpath: - self.env.doc_read_data['autodoc:class'] = self.objpath[0] + self.env.temp_data['autodoc:class'] = self.objpath[0] want_all = all_members or self.options.inherited_members or \ self.options.members is ALL @@ -607,8 +607,8 @@ class Documenter(object): check_module=members_check_module) # reset current objects - self.env.doc_read_data['autodoc:module'] = None - self.env.doc_read_data['autodoc:class'] = None + self.env.temp_data['autodoc:module'] = None + self.env.temp_data['autodoc:class'] = None def generate(self, more_content=None, real_modname=None, check_module=False, all_members=False): @@ -766,10 +766,10 @@ class ModuleLevelDocumenter(Documenter): else: # if documenting a toplevel object without explicit module, # it can be contained in another auto directive ... - modname = self.env.doc_read_data.get('autodoc:module') + modname = self.env.temp_data.get('autodoc:module') # ... or in the scope of a module directive if not modname: - modname = self.env.doc_read_data.get('py:module') + modname = self.env.temp_data.get('py:module') # ... else, it stays None, which means invalid return modname, parents + [base] @@ -788,10 +788,10 @@ class ClassLevelDocumenter(Documenter): # if documenting a class-level object without path, # there must be a current class, either from a parent # auto directive ... - mod_cls = self.env.doc_read_data.get('autodoc:class') + mod_cls = self.env.temp_data.get('autodoc:class') # ... or from a class directive if mod_cls is None: - mod_cls = self.env.doc_read_data.get('py:class') + mod_cls = self.env.temp_data.get('py:class') # ... if still None, there's no way to know if mod_cls is None: return None, [] @@ -799,9 +799,9 @@ class ClassLevelDocumenter(Documenter): parents = [cls] # if the module name is still missing, get it like above if not modname: - modname = self.env.doc_read_data.get('autodoc:module') + modname = self.env.temp_data.get('autodoc:module') if not modname: - modname = self.env.doc_read_data.get('py:module') + modname = self.env.temp_data.get('py:module') # ... else, it stays None, which means invalid return modname, parents + [base] diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index a48295d1f..a4d46b1f0 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -225,7 +225,7 @@ class Autosummary(Directive): env = self.state.document.settings.env prefixes = [''] - currmodule = env.doc_read_data.get('py:module') + currmodule = env.temp_data.get('py:module') if currmodule: prefixes.insert(0, currmodule) diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index db4c56788..62a3e5600 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -284,7 +284,7 @@ class InheritanceDiagram(Directive): # Create a graph starting with the list of classes try: graph = InheritanceGraph(class_names, - env.doc_read_data.get('py:module')) + env.temp_data.get('py:module')) except InheritanceException, err: return [node.document.reporter.warning(err.args[0], line=self.lineno)]