hg-prompt / prompt.py

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
#!/usr/bin/env python

from __future__ import with_statement

'''get repository information for use in a shell prompt

Take a string, parse any special variables inside, and output the result.

Useful mostly for putting information about the current repository into
a shell prompt.
'''

import re
import os
import subprocess
from datetime import datetime, timedelta
from os import path
from mercurial import extensions, commands, cmdutil, help
from mercurial.node import hex, short

CACHE_PATH = ".hg/prompt/cache"
CACHE_TIMEOUT = timedelta(minutes=15)

FILTER_ARG = re.compile(r'\|.+\((.*)\)')

def _cache_remote(repo, kind):
    cache = path.join(repo.root, CACHE_PATH, kind)
    c_tmp = cache + '.temp'

    # This is kind of a hack and I feel a little bit dirty for doing it.
    IGNORE = open('NUL:','w') if subprocess.mswindows else open('/dev/null','w')

    subprocess.call(['hg', kind, '--quiet'], stdout=file(c_tmp, 'w'), stderr=IGNORE)
    os.rename(c_tmp, cache)
    return

def _with_groups(groups, out):
    out_groups = [groups[0]] + [groups[-1]]

    if any(out_groups) and not all(out_groups):
        print 'Error parsing prompt string.  Mismatched braces?'

    out = out.replace('%', '%%')
    return ("%s" + out + "%s") % (out_groups[0][:-1] if out_groups[0] else '',
                                  out_groups[1][1:] if out_groups[1] else '')

def _get_filter(name, g):
    '''Return the filter with the given name, or None if it was not used.'''
    matching_filters = filter(lambda s: s and s.startswith('|%s' % name), g)
    if not matching_filters:
        return None

    # Later filters will override earlier ones, for now.
    f = matching_filters[-1]

    return f

def _get_filter_arg(f):
    if not f:
        return None

    args = FILTER_ARG.match(f).groups()
    if args:
        return args[0]
    else:
        return None

def prompt(ui, repo, fs='', **opts):
    '''get repository information for use in a shell prompt

    Take a string and output it for use in a shell prompt. You can use
    keywords in curly braces::

        $ hg prompt "currently on {branch}"
        currently on default

    You can also use an extended form of any keyword::

        {optional text here{keyword}more optional text}

    This will expand the inner {keyword} and output it along with the extra
    text only if the {keyword} expands successfully.  This is useful if you
    have a keyword that may not always apply to the current state and you
    have some text that you would like to see only if it is appropriate::

        $ hg prompt "currently at {bookmark}"
        currently at
        $ hg prompt "{currently at {bookmark}}"
        $ hg bookmark my-bookmark
        $ hg prompt "{currently at {bookmark}}"
        currently at my-bookmark

    See 'hg help prompt-keywords' for a list of available keywords.
    '''

    def _basename(m):
        return _with_groups(m.groups(), path.basename(repo.root)) if repo.root else ''

    def _bookmark(m):
        try:
            book = extensions.find('bookmarks').current(repo)
        except AttributeError:
            book = getattr(repo, '_bookmarkcurrent', None)
        except KeyError:
            book = getattr(repo, '_bookmarkcurrent', None)
        return _with_groups(m.groups(), book) if book else ''

    def _branch(m):
        g = m.groups()

        branch = repo.dirstate.branch()
        quiet = _get_filter('quiet', g)

        out = branch if (not quiet) or (branch != 'default') else ''

        return _with_groups(g, out) if out else ''

    def _closed(m):
        g = m.groups()

        quiet = _get_filter('quiet', g)

        p = repo[None].parents()[0]
        pn = p.node()
        branch = repo.dirstate.branch()
        closed = (p.extra().get('close')
                  and pn in repo.branchheads(branch, closed=True))
        out = 'X' if (not quiet) and closed else ''

        return _with_groups(g, out) if out else ''

    def _count(m):
        g = m.groups()
        query = [g[1][1:]] if g[1] else ['all()']
        return _with_groups(g, str(len(cmdutil.revrange(repo, query))))

    def _node(m):
        g = m.groups()

        parents = repo[None].parents()
        p = 0 if '|merge' not in g else 1
        p = p if len(parents) > p else None

        format = short if '|short' in g else hex

        node = format(parents[p].node()) if p is not None else None
        return _with_groups(g, str(node)) if node else ''

    def _patch(m):
        g = m.groups()

        try:
            extensions.find('mq')
        except KeyError:
            return ''

        q = repo.mq

        if _get_filter('quiet', g) and not len(q.series):
            return ''

        if _get_filter('topindex', g):
            if len(q.applied):
                out = str(len(q.applied) - 1)
            else:
                out = ''
        elif _get_filter('applied', g):
            out = str(len(q.applied))
        elif _get_filter('unapplied', g):
            out = str(len(q.unapplied(repo)))
        elif _get_filter('count', g):
            out = str(len(q.series))
        else:
            out = q.applied[-1].name if q.applied else ''

        return _with_groups(g, out) if out else ''

    def _patches(m):
        g = m.groups()

        try:
            extensions.find('mq')
        except KeyError:
            return ''

        join_filter = _get_filter('join', g)
        join_filter_arg = _get_filter_arg(join_filter)
        sep = join_filter_arg if join_filter else ' -> '

        patches = repo.mq.series
        applied = [p.name for p in repo.mq.applied]
        unapplied = filter(lambda p: p not in applied, patches)

        if _get_filter('hide_applied', g):
            patches = filter(lambda p: p not in applied, patches)
        if _get_filter('hide_unapplied', g):
            patches = filter(lambda p: p not in unapplied, patches)

        if _get_filter('reverse', g):
            patches = reversed(patches)

        pre_applied_filter = _get_filter('pre_applied', g)
        pre_applied_filter_arg = _get_filter_arg(pre_applied_filter)
        post_applied_filter = _get_filter('post_applied', g)
        post_applied_filter_arg = _get_filter_arg(post_applied_filter)

        pre_unapplied_filter = _get_filter('pre_unapplied', g)
        pre_unapplied_filter_arg = _get_filter_arg(pre_unapplied_filter)
        post_unapplied_filter = _get_filter('post_unapplied', g)
        post_unapplied_filter_arg = _get_filter_arg(post_unapplied_filter)

        for n, patch in enumerate(patches):
            if patch in applied:
                if pre_applied_filter:
                    patches[n] = pre_applied_filter_arg + patches[n]
                if post_applied_filter:
                    patches[n] = patches[n] + post_applied_filter_arg
            elif patch in unapplied:
                if pre_unapplied_filter:
                    patches[n] = pre_unapplied_filter_arg + patches[n]
                if post_unapplied_filter:
                    patches[n] = patches[n] + post_unapplied_filter_arg

        return _with_groups(g, sep.join(patches)) if patches else ''

    def _queue(m):
        g = m.groups()

        try:
            extensions.find('mq')
        except KeyError:
            return ''

        q = repo.mq

        out = os.path.basename(q.path)
        if out == 'patches' and not os.path.isdir(q.path):
            out = ''
        elif out.startswith('patches-'):
            out = out[8:]

        return _with_groups(g, out) if out else ''

    def _remote(kind):
        def _r(m):
            g = m.groups()

            cache_dir = path.join(repo.root, CACHE_PATH)
            cache = path.join(cache_dir, kind)
            if not path.isdir(cache_dir):
                os.makedirs(cache_dir)

            cache_exists = path.isfile(cache)

            cache_time = (datetime.fromtimestamp(os.stat(cache).st_mtime)
                          if cache_exists else None)
            if not cache_exists or cache_time < datetime.now() - CACHE_TIMEOUT:
                if not cache_exists:
                    open(cache, 'w').close()
                subprocess.Popen(['hg', 'prompt', '--cache-%s' % kind])

            if cache_exists:
                with open(cache) as c:
                    count = len(c.readlines())
                    if g[1]:
                        return _with_groups(g, str(count)) if count else ''
                    else:
                        return _with_groups(g, '') if count else ''
            else:
                return ''
        return _r

    def _rev(m):
        g = m.groups()

        parents = repo[None].parents()
        parent = 0 if '|merge' not in g else 1
        parent = parent if len(parents) > parent else None

        rev = parents[parent].rev() if parent is not None else -1
        return _with_groups(g, str(rev)) if rev >= 0 else ''

    def _root(m):
        return _with_groups(m.groups(), repo.root) if repo.root else ''

    def _status(m):
        g = m.groups()

        st = repo.status(unknown=True)[:5]
        modified = any(st[:4])
        unknown = len(st[-1]) > 0

        flag = ''
        if '|modified' not in g and '|unknown' not in g:
            flag = '!' if modified else '?' if unknown else ''
        else:
            if '|modified' in g:
                flag += '!' if modified else ''
            if '|unknown' in g:
                flag += '?' if unknown else ''

        return _with_groups(g, flag) if flag else ''

    def _tags(m):
        g = m.groups()

        sep = g[1][1:] if g[1] else ' '
        tags = repo[None].tags()

        return _with_groups(g, sep.join(tags)) if tags else ''

    def _task(m):
        try:
            task = extensions.find('tasks').current(repo)
            return _with_groups(m.groups(), task) if task else ''
        except KeyError:
            return ''

    def _tip(m):
        g = m.groups()

        format = short if '|short' in g else hex

        tip = repo[len(repo) - 1]
        rev = tip.rev()
        tip = format(tip.node()) if '|node' in g else tip.rev()

        return _with_groups(g, str(tip)) if rev >= 0 else ''

    def _update(m):
        if not repo.branchtags():
            # We are in an empty repository.
            return ''

        current_rev = repo[None].parents()[0]
        to = repo[repo.branchtags()[current_rev.branch()]]
        return _with_groups(m.groups(), '^') if current_rev != to else ''


    if opts.get("angle_brackets"):
        tag_start = r'\<([^><]*?\<)?'
        tag_end = r'(\>[^><]*?)?>'
        brackets = '<>'
    else:
        tag_start = r'\{([^{}]*?\{)?'
        tag_end = r'(\}[^{}]*?)?\}'
        brackets = '{}'

    patterns = {
        'bookmark': _bookmark,
        'branch(\|quiet)?': _branch,
        'closed(\|quiet)?': _closed,
        'count(\|[^%s]*?)?' % brackets[-1]: _count,
        'node(?:'
            '(\|short)'
            '|(\|merge)'
            ')*': _node,
        'patch(?:'
            '(\|topindex)'
            '|(\|applied)'
            '|(\|unapplied)'
            '|(\|count)'
            '|(\|quiet)'
            ')*': _patch,
        'patches(?:' +
            '(\|join\([^%s]*?\))' % brackets[-1] +
            '|(\|reverse)' +
            '|(\|hide_applied)' +
            '|(\|hide_unapplied)' +
            '|(\|pre_applied\([^%s]*?\))' % brackets[-1] +
            '|(\|post_applied\([^%s]*?\))' % brackets[-1] +
            '|(\|pre_unapplied\([^%s]*?\))' % brackets[-1] +
            '|(\|post_unapplied\([^%s]*?\))' % brackets[-1] +
            ')*': _patches,
        'queue': _queue,
        'rev(\|merge)?': _rev,
        'root': _root,
        'root\|basename': _basename,
        'status(?:'
            '(\|modified)'
            '|(\|unknown)'
            ')*': _status,
        'tags(\|[^%s]*?)?' % brackets[-1]: _tags,
        'task': _task,
        'tip(?:'
            '(\|node)'
            '|(\|short)'
            ')*': _tip,
        'update': _update,

        'incoming(\|count)?': _remote('incoming'),
        'outgoing(\|count)?': _remote('outgoing'),
    }

    if opts.get("cache_incoming"):
        _cache_remote(repo, 'incoming')

    if opts.get("cache_outgoing"):
        _cache_remote(repo, 'outgoing')

    for tag, repl in patterns.items():
        fs = re.sub(tag_start + tag + tag_end, repl, fs)

    # Allow ANSI escape sequences through
    fs = re.sub( '\\\\(?:033|e)\\[((?:[0-9]+;)*[0-9]+)m', '[\\1m', fs )

    ui.status(fs)

def _pull_with_cache(orig, ui, repo, *args, **opts):
    """Wrap the pull command to delete the incoming cache as well."""
    res = orig(ui, repo, *args, **opts)
    cache = path.join(repo.root, CACHE_PATH, 'incoming')
    if path.isfile(cache):
        os.remove(cache)
    return res

def _push_with_cache(orig, ui, repo, *args, **opts):
    """Wrap the push command to delete the outgoing cache as well."""
    res = orig(ui, repo, *args, **opts)
    cache = path.join(repo.root, CACHE_PATH, 'outgoing')
    if path.isfile(cache):
        os.remove(cache)
    return res

def uisetup(ui):
    extensions.wrapcommand(commands.table, 'pull', _pull_with_cache)
    extensions.wrapcommand(commands.table, 'push', _push_with_cache)
    try:
        extensions.wrapcommand(extensions.find("fetch").cmdtable, 'fetch', _pull_with_cache)
    except KeyError:
        pass

cmdtable = {
    "prompt":
    (prompt, [
        ('', 'angle-brackets', None, 'use angle brackets (<>) for keywords'),
        ('', 'cache-incoming', None, 'used internally by hg-prompt'),
        ('', 'cache-outgoing', None, 'used internally by hg-prompt'),
    ],
    'hg prompt STRING')
}
help.helptable += (
    (['prompt-keywords', 'prompt-keywords'], ('Keywords supported by hg-prompt'),
     (r'''hg-prompt currently supports a number of keywords.

Some keywords support filters.  Filters can be chained when it makes
sense to do so.  When in doubt, try it!

bookmark
     Display the current bookmark (requires the bookmarks extension).

branch
     Display the current branch.

     |quiet
         Display the current branch only if it is not the default branch.

closed
     Display `X` if working on a closed branch (i.e. committing now would reopen
     the branch).

count
     Display the number of revisions in the given revset (the revset `all()`
     will be used if none is given).

     See `hg help revsets` for more information.

     |REVSET
         The revset to count.

incoming
     Display nothing, but if the default path contains incoming changesets the
     extra text will be expanded.

     For example: `{incoming changes{incoming}}` will expand to
     `incoming changes` if there are changes, otherwise nothing.

     Checking for incoming changesets is an expensive operation, so `hg-prompt`
     will cache the results in `.hg/prompt/cache/` and refresh them every 15
     minutes.

     |count
         Display the number of incoming changesets (if greater than 0).

node
     Display the (full) changeset hash of the current parent.

     |short
         Display the hash as the short, 12-character form.

     |merge
         Display the hash of the changeset you're merging with.

outgoing
     Display nothing, but if the current repository contains outgoing
     changesets (to default) the extra text will be expanded.

     For example: `{outgoing changes{outgoing}}` will expand to
     `outgoing changes` if there are changes, otherwise nothing.

     Checking for outgoing changesets is an expensive operation, so `hg-prompt`
     will cache the results in `.hg/prompt/cache/` and refresh them every 15
     minutes.

     |count
         Display the number of outgoing changesets (if greater than 0).

patch
     Display the topmost currently-applied patch (requires the mq
     extension).

     |count
         Display the number of patches in the queue.

     |topindex
         Display (zero-based) index of the topmost applied patch in the series
         list (as displayed by :hg:`qtop -v`), or the empty string if no patch
         is applied.

     |applied
         Display the number of currently applied patches in the queue.

     |unapplied
         Display the number of currently unapplied patches in the queue.

     |quiet
         Display a number only if there are any patches in the queue.

patches
     Display a list of the current patches in the queue.  It will look like
     this:

         :::console
         $ hg prompt '{patches}'
         bottom-patch -> middle-patch -> top-patch

     |reverse
         Display the patches in reverse order (i.e. topmost first).

     |hide_applied
         Do not display applied patches.

     |hide_unapplied
         Do not display unapplied patches.

     |join(SEP)
         Display SEP between each patch, instead of the default ` -> `.

     |pre_applied(STRING)
         Display STRING immediately before each applied patch.  Useful for
         adding color codes.

     |post_applied(STRING)
         Display STRING immediately after each applied patch.  Useful for
         resetting color codes.

     |pre_unapplied(STRING)
         Display STRING immediately before each unapplied patch.  Useful for
         adding color codes.

     |post_unapplied(STRING)
         Display STRING immediately after each unapplied patch.  Useful for
         resetting color codes.

queue
     Display the name of the current MQ queue.

rev
     Display the repository-local changeset number of the current parent.

     |merge
         Display the repository-local changeset number of the changeset you're
         merging with.

root
     Display the full path to the root of the current repository, without a
     trailing slash.

     |basename
         Display the directory name of the root of the current repository. For
         example, if the repository is in `/home/u/myrepo` then this keyword
         would expand to `myrepo`.

status
     Display `!` if the repository has any changed/added/removed files,
     otherwise `?` if it has any untracked (but not ignored) files, otherwise
     nothing.

     |modified
         Display `!` if the current repository contains files that have been
         modified, added, removed, or deleted, otherwise nothing.

     |unknown
         Display `?` if the current repository contains untracked files,
         otherwise nothing.

tags
     Display the tags of the current parent, separated by a space.

     |SEP
         Display the tags of the current parent, separated by `SEP`.

task
     Display the current task (requires the tasks extension).

tip
     Display the repository-local changeset number of the current tip.

     |node
         Display the (full) changeset hash of the current tip.

     |short
         Display a short form of the changeset hash of the current tip (must be
         used with the **|node** filter)

update
     Display `^` if the current parent is not the tip of the current branch,
     otherwise nothing.  In effect, this lets you see if running `hg update`
     would do something.
''')),
)
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.