← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Vincent Ladeuil
  • Date: 2007-07-18 09:43:41 UTC
  • mto: (2778.5.1 vila)
  • mto: This revision was merged to the branch mainline in revision 2789.
  • Revision ID: v.ladeuil+lp@free.fr-20070718094341-edmgsog3el06yqow
Add performance analysis of missing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
# TODO: Some way to get a list of external commands (defined by shell
18
18
# scripts) so that they can be included in the help listing as well.
40
40
        outfile = sys.stdout
41
41
 
42
42
    indices = HelpIndices()
43
 
 
44
 
    alias = _mod_commands.get_alias(topic)
45
 
    try:
46
 
        topics = indices.search(topic)
47
 
        shadowed_terms = []
48
 
        for index, topic in topics[1:]:
49
 
            shadowed_terms.append('%s%s' % (index.prefix,
50
 
                topic.get_help_topic()))
51
 
        source = topics[0][1]
52
 
        outfile.write(source.get_help_text(shadowed_terms))
53
 
    except errors.NoHelpTopic:
54
 
        if alias is None:
55
 
            raise
56
 
 
57
 
    if alias is not None:
58
 
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
59
 
            " ".join(alias)))
 
43
    topics = indices.search(topic)
 
44
    shadowed_terms = []
 
45
    for index, topic in topics[1:]:
 
46
        shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
 
47
    outfile.write(topics[0][1].get_help_text(shadowed_terms))
60
48
 
61
49
 
62
50
def help_commands(outfile=None):
66
54
    outfile.write(_help_commands_to_text('commands'))
67
55
 
68
56
 
 
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
58
def command_usage(cmd):
 
59
    return cmd._usage()
 
60
 
 
61
 
69
62
def _help_commands_to_text(topic):
70
63
    """Generate the help text for the list of commands"""
71
64
    out = []
73
66
        hidden = True
74
67
    else:
75
68
        hidden = False
76
 
    names = list(_mod_commands.all_command_names())
 
69
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
70
    names.update(_mod_commands.plugin_command_names())
77
71
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
78
72
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
79
73
    max_name = max(len(n) for n, o in shown_commands)
102
96
 
103
97
help_topics.topic_registry.register("commands",
104
98
                                    _help_commands_to_text,
105
 
                                    "Basic help for all commands",
106
 
                                    help_topics.SECT_HIDDEN)
 
99
                                    "Basic help for all commands")
107
100
help_topics.topic_registry.register("hidden-commands",
108
101
                                    _help_commands_to_text,
109
 
                                    "All hidden commands",
110
 
                                    help_topics.SECT_HIDDEN)
 
102
                                    "All hidden commands")
111
103
 
112
104
 
113
105
class HelpIndices(object):
114
106
    """Maintainer of help topics across multiple indices.
115
 
 
 
107
    
116
108
    It is currently separate to the HelpTopicRegistry because of its ordered
117
109
    nature, but possibly we should instead structure it as a search within the
118
110
    registry and add ordering and searching facilities to the registry. The
143
135
 
144
136
    def search(self, topic):
145
137
        """Search for topic across the help search path.
146
 
 
 
138
        
147
139
        :param topic: A string naming the help topic to search for.
148
140
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
149
141
        :return: A list of HelpTopics which matched 'topic'.