mercurial_extension_utils-1.3.1/0000775000175000017500000000000013012045362020103 5ustar marcinkmarcink00000000000000mercurial_extension_utils-1.3.1/mercurial_extension_utils.py0000644000175000017500000011515513012045145025761 0ustar marcinkmarcink00000000000000# -*- coding: utf-8 -*- # # mercurial extension utils: library supporting mercurial extensions # writing # # Copyright (c) 2015 Marcin Kasperski # All rights reserved. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # 1. Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # 3. The name of the author may not be used to endorse or promote products # derived from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # # See README.txt for more details. """Utility functions useful during Mercurial extension writing Mostly related to configuration processing, path matching and similar activities. I extracted this module once I noticed a couple of my extensions need the same or similar functions. Note: file-related functions defined here use / as path separator, even on Windows. Backslashes in params should usually work too, but returned paths are always /-separated. Documentation examples in this module use Unix paths, see file mercurial_extension_utils_win.py for windows doctests. """ from mercurial.i18n import _ import re import os import sys from collections import deque # pylint: disable=line-too-long,invalid-name ########################################################################### # Directory matching in various shapes ########################################################################### def normalize_path(path): """ Converts given path to absolute, /-separated form. That means: - expanding ~ - converting to absolute - (on Windows) converting backslash to slash - dropping final slash (if any) >>> normalize_path("~/src") '/home/lordvader/src' >>> normalize_path("/some/where") '/some/where' >>> normalize_path("/some/where/") '/some/where' >>> normalize_path("../../../some/where") '/home/lordvader/some/where' """ reply = os.path.abspath(os.path.expanduser(path)) if os.name == 'nt': reply = reply.replace('\\', '/') return reply.rstrip('/') def belongs_to_tree(child, parent): """Checks whether child lies anywhere inside parent directory tree. Child should be absolute path, parent will be tlida expanded and converted to absolute path (this convention is caused by typical use case, where repo.root is compared against some user-specified directory). On match, matching parent is returned (it matters if it was sanitized). >>> belongs_to_tree("/tmp/sub/dir", "/tmp") '/tmp' >>> belongs_to_tree("/tmp", "/tmp") '/tmp' >>> belongs_to_tree("/tmp/sub", "/tmp/sub/dir/../..") '/tmp' On mismatch None is returned. >>> belongs_to_tree("/usr/sub", "/tmp") Tilda expressions are allowed in parent specification: >>> home_work_src = os.path.join(os.environ["HOME"], "work", "src") >>> belongs_to_tree(home_work_src, "~/work") '/home/lordvader/work' >>> belongs_to_tree("/home/lordvader/devel/webapps", "~lordvader/devel") '/home/lordvader/devel' Note: even on Windows, / is used as path separator (both on input, and on output). :param child: tested directory (preferably absolute path) :param parent: tested parent (will be tilda-expanded, so things like ~/work are OK) :return: expanded canonicalized parent on match, None on mismatch """ parent = normalize_path(parent) child = normalize_path(child) # os.path.commonprefix is case-sensitive, on Windows this makes things crazy # pfx = normalize_path(os.path.commonprefix([child, parent])) # return pfx == true_parent and true_parent or None if os.name != 'nt': matches = child == parent or child.startswith(parent + '/') else: lower_child = child.lower() lower_parent = parent.lower() matches = lower_child == lower_parent or lower_child.startswith(lower_parent + '/') return matches and parent or None def belongs_to_tree_group(child, parents): """ Similar to belongs_to_tree, but handles list of candidate parents. >>> belongs_to_tree_group("/tmp/sub/dir", ["/bin", "/tmp"]) '/tmp' >>> belongs_to_tree_group("/tmp", ["/tmp"]) '/tmp' >>> belongs_to_tree_group("/tmp/sub/dir", ["/bin", "~/src"]) Returns longest match if more than one parent matches. >>> belongs_to_tree_group("/tmp/sub/dir", ["/tmp", "/bin", "/tmp", "/tmp/sub"]) '/tmp/sub' where length is considered after expansion >>> belongs_to_tree_group("/home/lordvader/src/apps", ["~/src", "/home/lordvader"]) '/home/lordvader/src' Note: even on Windows, / is used as path separator (both on input, and on output). :param child: tested directory (preferably absolute path) :param parents: tested parents (list or tuple of directories to test, will be tilda-expanded) """ child = normalize_path(child) longest_parent = '' for parent in parents: canon_path = belongs_to_tree(child, parent) if canon_path: if len(canon_path) > len(longest_parent): longest_parent = canon_path return longest_parent and longest_parent or None class DirectoryPattern(object): """ Represents directory name pattern, like ``~/src/{suffix}``, or ``/opt/repos/(group)/{suffix}``, and let's match agains such pattern. Pattern mini-language: - tildas (``~`` and ``~user``) are expanded - ``(something)`` matches any part which does not contain directory separator - ``{something}`` greedily matches anything, including directory separators Constructed pattern can be used to match against, succesfull match extracts all marked fragments. On Windows comparison is case-insensitive, on Unix/Linux case matters. >>> pat = DirectoryPattern('~/src/{suffix}') >>> pat.is_valid() True >>> pat.search("/opt/repos/abcd") >>> pat.search("~/src/repos/in/tree") {'suffix': 'repos/in/tree'} >>> pat.search("/home/lordvader/src/repos/here" if os.system != 'nt' else "c:/users/lordvader/src/repos/here") {'suffix': 'repos/here'} >>> pat.search("/home/lordvader/src") >>> pat = DirectoryPattern('~lordvader/devel/(item)') >>> pat.search("/opt/repos/abcd") >>> pat.search("~/devel/libxuza") {'item': 'libxuza'} >>> pat.search("~/devel/libs/libxuza") >>> pat.search("/home/lordvader/devel/webapp") {'item': 'webapp'} >>> pat.search("/home/lordvader/devel") >>> from pprint import pprint # Help pass doctests below >>> pat = DirectoryPattern('/opt/repos/(group)/{suffix}') >>> pat.search("/opt/repos/abcd") >>> pprint(pat.search("/opt/repos/libs/abcd")) {'group': 'libs', 'suffix': 'abcd'} >>> pprint(pat.search("/opt/repos/apps/mini/webby")) {'group': 'apps', 'suffix': 'mini/webby'} >>> pat = DirectoryPattern('/opt/repos/(group/{suffix}') >>> pat.is_valid() False >>> pat.search('/opt/repos/some/where') Fixed strings can also be used and work reasonably: >>> pat = DirectoryPattern('~/dev/acme') >>> pat.is_valid() True >>> pat.search('/home/lordvader/dev/acme') {} >>> pat.search('/home/lordvader/dev/acme/') {} >>> pat.search('/home/lordvader/dev/acme/subdir') >>> pat.search('/home/lordvader/dev') """ # Regexps used during pattern parsing _re_pattern_lead = re.compile(r' ^ ([^{}()]*) ([({]) (.*) $', re.VERBOSE) _re_closure = {'{': re.compile(r'^ ([a-zA-Z_]+) [}] (.*) $', re.VERBOSE), '(': re.compile(r'^ ([a-zA-Z_]+) [)] (.*) $', re.VERBOSE)} # (text inside (braces) or {braces} is restricted as it is used within regexp # Regexp snippets used to match escaped parts _re_match_snippet = {'{': r'.+', '(': r'[^/\\]+'} def __init__(self, pattern_text, ui=None): """Parses given pattern. Doesn't raise, in case of invalid patterns creates object which does not match anything and warns. :param pattern_text: parsed pattern :param ui: (optional) mercurial ui object, if given, used for debugging """ self.pattern_text = text = normalize_path(pattern_text) self._pattern_re = None # Will stay such if we fail somewhere here # Convert pattern to regexp rgxp_text = '^' while text: match = self._re_pattern_lead.search(text) if match: prefix, open_char, text = match.group(1), match.group(2), match.group(3) match = self._re_closure[open_char].search(text) if not match: if ui: ui.warn(_("Invalid directory pattern: %s") % pattern_text) return group_name, text = match.group(1), match.group(2) rgxp_text += re.escape(prefix) rgxp_text += '(?P<' + group_name + '>' + self._re_match_snippet[open_char] + ')' else: rgxp_text += re.escape(text) text = '' rgxp_text += '$' if ui: ui.debug(_("Pattern %s translated into regexp %s\n") % (pattern_text, rgxp_text)) try: self._pattern_re = re.compile(rgxp_text, os.name == 'nt' and re.IGNORECASE or 0) except: # pylint:disable=bare-except if ui: ui.warn(_("Invalid directory pattern: %s") % pattern_text) def is_valid(self): """Can be used to check whether object was properly constructed""" return bool(self._pattern_re) def search(self, tested_path): """ Matches given directory against the pattern. On match, returns dictionary of all named elements. On mismatch, returns None :param tested_path: path to check, will be tilda-expanded and converted to abspath before comparison :return: Dictionary mapping all ``{brace}`` and ``(paren)`` parts to matched items """ if not self._pattern_re: return exp_tested_path = normalize_path(tested_path) match = self._pattern_re.search(exp_tested_path) if match: return match.groupdict() else: return None ########################################################################### # Text substitution ########################################################################### class TextFiller(object): r''' Handle filling patterns like 'some/{thing}/{else}' with values. Comparing to standard library ``.format`` offers a bit different syntax, related to actual extension-writing problems, and different ways of error handling. In simplest form, it just replaces any ``{name}`` with value of ``name``, as-is >>> tf = TextFiller('{some}/text/to/{fill}') >>> tf.fill(some='prefix', fill='suffix') 'prefix/text/to/suffix' >>> tf.fill(some='/ab/c/d', fill='x') '/ab/c/d/text/to/x' Values can be repeated and unnecessary keys are ignored: >>> tf = TextFiller('{some}/text/to/{some}') >>> tf.is_valid() True >>> tf.fill(some='val') 'val/text/to/val' >>> tf.fill(some='ab/c/d', fill='x') 'ab/c/d/text/to/ab/c/d' It is also possible to perform simple substitutions, for example ``{name:/=-} takes value of ``name``, replaces all slashes with minuses, and fills output with the resulting value >>> tf = TextFiller('{prefix:_=___}/goto/{suffix:/=-}') >>> tf.fill(prefix='some_prefix', suffix='some/long/suffix') 'some___prefix/goto/some-long-suffix' Substitution can be also used to replace multi-character sequences, and replacement can be empty: >>> tf = TextFiller('{prefix:/home/=}/docs/{suffix:.txt=.html}') >>> tf.fill(prefix='/home/joe', suffix='some/document.txt') 'joe/docs/some/document.html' and chained to replace more than one thing: >>> tf = TextFiller(r'/goto/{item:/=-:\=_}/') >>> tf.fill(item='this/is/slashy') '/goto/this-is-slashy/' >>> tf.fill(item=r'this\is\back') '/goto/this_is_back/' >>> tf.fill(item=r'this/is\mixed') '/goto/this-is_mixed/' The same parameter can be used in various substitutions: >>> tf = TextFiller(r'http://go.to/{item:/=-}, G:{item:/=\}, name: {item}') >>> print tf.fill(item='so/me/thing') http://go.to/so-me-thing, G:so\me\thing, name: so/me/thing Errors are handled by returning None (and warning if ui is given), both in case of missing key: >>> tf = TextFiller('{some}/text/to/{fill}') >>> tf.fill(some='prefix', badfill='suffix') and of bad pattern: >>> tf = TextFiller('{some/text/to/{fill}') >>> tf.is_valid() False >>> tf.fill(some='prefix', fill='suffix') >>> tf = TextFiller('{some}/text/to/{fill:}') >>> tf.is_valid() False >>> tf.fill(some='prefix', fill='suffix') ''' # Regexps used during parsing _re_pattern_lead = re.compile(r' ^ ([^{}]*) [{] (.*) $', re.VERBOSE) _re_pattern_cont = re.compile(r''' ^ ([a-zA-Z][a-zA-Z0-9_]*) # name (leading _ disallowed on purpose) ((?: : [^{}:=]+ = [^{}:=]* )*) # :sth=else substitutions [}] (.*) $ ''', re.VERBOSE) _re_sub = re.compile(r'^ : ([^{}:=]+) = ([^{}:=]*) (.*) $', re.VERBOSE) def __init__(self, fill_text, ui=None): def percent_escape(val): """Escape %-s in given text by doubling them.""" return val.replace('%', '%%') text = self.fill_text = fill_text # Replacement text. That's just percent 'some %(abc)s text' (we use % not '{}' to # leave chances of working on python 2.5). Empty value means I am broken self._replacement = None # List of substitutions, tuples: # result synthetic name, # base field name # [(from, to), (from, to), ...] list of substitutions to make self._substitutions = [] replacement = '' synth_idx = 0 while text: match = self._re_pattern_lead.search(text) if match: replacement += percent_escape(match.group(1)) text = match.group(2) match = self._re_pattern_cont.search(text) if not match: if ui: ui.warn(_("Bad replacement pattern: %s") % fill_text) return name, substs, text = match.group(1), match.group(2), match.group(3) if substs: fixups = [] while substs: match = self._re_sub.search(substs) if not match: if ui: ui.warn(_("Bad replacement pattern: %s") % fill_text) return src, dest, substs = match.group(1), match.group(2), match.group(3) fixups.append((src, dest)) synth_idx += 1 synth = "_" + str(synth_idx) self._substitutions.append((synth, name, fixups)) name = synth replacement += '%(' + name + ')s' else: replacement += percent_escape(text) text = '' # Final save if ui: ui.debug(_("Replacement %s turned into expression %s") % (fill_text, replacement)) self._replacement = replacement def is_valid(self): """Returns whether object is in correct state, or broken""" return bool(self._replacement) def fill(self, **kwargs): """Fills text with given arguments. If something is broken (missing key, broken pattern) returns None""" if not self._replacement: return None try: for made_field, src_field, fixups in self._substitutions: value = kwargs[src_field] for src, dest in fixups: value = value.replace(src, dest) kwargs[made_field] = value return self._replacement % kwargs except: # pylint:disable=bare-except return None ########################################################################### # Config support ########################################################################### def setconfig_dict(ui, section, items): """ Set's many configuration items with one call. Defined mostly to make some code (including doctests below) a bit more readable. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_dict(ui, "sect1", {'a': 7, 'bbb': 'xxx', 'c': '-'}) >>> setconfig_dict(ui, "sect2", {'v': 'vvv'}) >>> ui.config("sect1", 'a') 7 >>> ui.config("sect2", 'v') 'vvv' :param section: configuration section tofill :param items: dictionary of items to set """ for key, value in items.iteritems(): ui.setconfig(section, key, value) def setconfig_list(ui, section, items): """ Alternative form of setting many configuration items with one call. Here items are given as list of key,value pairs. Contrary to setconfig_dict, this guarantees ordering. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "sect1", ... [('a', 7), ('bbb', 'xxx'), ('c', '-'), ('a', 8)]) >>> setconfig_list(ui, "sect2", [('v', 'vvv')]) >>> ui.config("sect1", 'a') 8 >>> ui.config("sect2", 'v') 'vvv' :param section: configuration section tofill :param items: dictionary of items to set """ for key, value in items: ui.setconfig(section, key, value) def rgxp_config_items(ui, section, rgxp): r''' Yields items from given config section which match given regular expression. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "foo", [ ... ("pfx-some-sfx", "ala, ma kota"), ... ("some.nonitem", "bela nie"), ... ("x", "yes"), ... ("pfx-other-sfx", 4) ... ]) >>> setconfig_list(ui, "notfoo", [ ... ("pfx-some-sfx", "bad"), ... ("pfx-also-sfx", "too"), ... ]) >>> >>> for name, value in rgxp_config_items( ... ui, "foo", re.compile(r'^pfx-(\w+)-sfx$')): ... print name, value some ala, ma kota other 4 :param ui: mercurial ui, used to access config :param section: config section name :param rgxp: tested regexp, should contain single (group) :return: yields pairs (group-match, value) for all matching items ''' for key, value in ui.configitems(section): match = rgxp.search(key) if match: yield match.group(1), value def rgxp_configlist_items(ui, section, rgxp): r''' Similar to rgxp_config_items, but returned values are read using ui.configlist, so returned as lists. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "foo", [ ... ("pfx-some-sfx", "ala, ma kota"), ... ("some.nonitem", "bela nie"), ... ("x", "yes"), ... ("pfx-other-sfx", "sth"), ... ]) >>> setconfig_list(ui, "notfoo", [ ... ("pfx-some-sfx", "bad"), ... ("pfx-also-sfx", "too"), ... ]) >>> >>> for name, value in rgxp_configlist_items( ... ui, "foo", re.compile(r'^pfx-(\w+)-sfx$')): ... print name, value some ['ala', 'ma', 'kota'] other ['sth'] :param ui: mercurial ui, used to access config :param section: config section name :param rgxp: tested regexp, should contain single (group) :return: yields pairs (group-match, value-as-list) for all matching items ''' for key, _unneeded_value in ui.configitems(section): match = rgxp.search(key) if match: yield match.group(1), ui.configlist(section, key) def rgxp_configbool_items(ui, section, rgxp): r''' Similar to rgxp_config_items, but returned values are read using ui.configbool, so returned as booleans. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "foo", [ ... ("pfx-some-sfx", "true"), ... ("some.nonitem", "bela nie"), ... ("x", "yes"), ... ("pfx-other-sfx", "false"), ... ]) >>> setconfig_dict(ui, "notfoo", { ... "pfx-some-sfx": "1", ... "pfx-also-sfx": "0", ... }) >>> >>> for name, value in rgxp_configbool_items( ... ui, "foo", re.compile(r'^pfx-(\w+)-sfx$')): ... print name, value some True other False :param ui: mercurial ui, used to access config :param section: config section name :param rgxp: tested regexp, should contain single (group) :return: yields pairs (group-match, value-as-list) for all matching items ''' for key, _unneeded_value in ui.configitems(section): match = rgxp.search(key) if match: yield match.group(1), ui.configbool(section, key) def suffix_config_items(ui, section, suffix): """ Yields items from given config section which match pattern '«sth».suffix' >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "foo", [ ... ("some.item", "ala, ma kota"), ... ("some.nonitem", "bela nie"), ... ("x", "yes"), ... ("other.item", 4), ... ]) >>> setconfig_dict(ui, "notfoo", { ... "some.item": "bad", ... "also.item": "too", ... }) >>> >>> for name, value in suffix_config_items( ... ui, "foo", 'item'): ... print name, value some ala, ma kota other 4 :param ui: mercurial ui, used to access config :param section: config section name :param suffix: expected suffix (without a dot) :return: yields pairs (prefix, value) for all matching items, values are lists """ rgxp = re.compile(r'^(\w+)\.' + re.escape(suffix)) for key, value in rgxp_config_items(ui, section, rgxp): yield key, value def suffix_configlist_items(ui, section, suffix): """ Similar to suffix_config_items, but returned values are read using ui.configlist, so returned as lists. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "foo", [ ... ("some.item", "ala, ma kota"), ... ("some.nonitem", "bela nie"), ... ("x", "yes"), ... ("other.item", "kazimira"), ... ]) >>> setconfig_dict(ui, "notfoo", { ... "some.item": "bad", ... "also.item": "too", ... }) >>> >>> for name, value in suffix_configlist_items( ... ui, "foo", "item"): ... print name, value some ['ala', 'ma', 'kota'] other ['kazimira'] :param ui: mercurial ui, used to access config :param section: config section name :param suffix: expected suffix (without a dot) :return: yields pairs (group-match, value-as-list) for all matching items, values are boolean """ rgxp = re.compile(r'^(\w+)\.' + re.escape(suffix)) for key, value in rgxp_configlist_items(ui, section, rgxp): yield key, value def suffix_configbool_items(ui, section, suffix): """ Similar to suffix_config_items, but returned values are read using ui.configbool, so returned as booleans. >>> import mercurial.ui; ui = mercurial.ui.ui() >>> setconfig_list(ui, "foo", [ ... ("true.item", "true"), ... ("false.item", "false"), ... ("one.item", "1"), ... ("zero.item", "0"), ... ("yes.item", "yes"), ... ("no.item", "no"), ... ("some.nonitem", "1"), ... ("x", "yes"), ... ]) >>> setconfig_dict(ui, "notfoo", { ... "some.item": "0", ... "also.item": "too", ... }) >>> >>> for name, value in suffix_configbool_items( ... ui, "foo", "item"): ... print name, str(value) true True false False one True zero False yes True no False >>> >>> ui.setconfig("foo", "text.item", "something") >>> for name, value in suffix_configbool_items( ... ui, "foo", "item"): ... print name, str(value) Traceback (most recent call last): File "/usr/lib/python2.7/dist-packages/mercurial/ui.py", line 237, in configbool % (section, name, v)) ConfigError: foo.text.item is not a boolean ('something') :param ui: mercurial ui, used to access config :param section: config section name :param suffix: expected suffix (without a dot) :return: yields pairs (group-match, value) for all matching items """ rgxp = re.compile(r'^(\w+)\.' + re.escape(suffix)) for key, value in rgxp_configbool_items(ui, section, rgxp): yield key, value ########################################################################### # Monkeypatching ########################################################################### def monkeypatch_method(cls, fname=None): """ Monkey-patches some method, replacing it with another implementation. Original method is preserved on ``.orig`` attribute. >>> class SomeClass(object): ... def meth(self, arg): ... return "Original: " + arg >>> >>> @monkeypatch_method(SomeClass) ... def meth(self, arg): ... return "Patched: " + meth.orig(self, arg) >>> >>> obj = SomeClass() >>> print obj.meth("some param") Patched: Original: some param It is also possible to use different name >>> class SomeClass(object): ... def meth(self, arg): ... return "Original: " + arg >>> >>> @monkeypatch_method(SomeClass, "meth") ... def another_meth(self, arg): ... return "Patched: " + another_meth.orig(self, arg) >>> >>> obj = SomeClass() >>> print obj.meth("some param") Patched: Original: some param :param cls: Class being modified :param fname: Name of method being monkey-patched (if not given, name of decorated function is used) """ def decorator(func): local_fname = fname if local_fname is None: local_fname = func.__name__ setattr(func, "orig", getattr(cls, local_fname, None)) setattr(cls, local_fname, func) return func return decorator def monkeypatch_function(module, fname=None): """ Monkey-patches some function, replacing it with another implementation. Original function is preserved on ``.orig`` attribute. >>> import random >>> @monkeypatch_function(random) ... def seed(x=None): ... print "Forcing random to seed with 0 instead of", x ... return seed.orig(0) >>> >>> random.seed() Forcing random to seed with 0 instead of None >>> random.randint(0, 10) 9 >>> import random >>> @monkeypatch_function(random, 'choice') ... def choice_first(sequence): ... return sequence[0] >>> for x in range(0, 4): print random.choice("abcdefgh") a a a a :param module: Module being modified :param fname: Name of function being monkey-patched (if not given, name of decorated function is used) """ # In fact implementation is the same. But it is more readable # to use two names return monkeypatch_method(module, fname) ########################################################################### # Locating repositories ########################################################################### def find_repositories_below(path, check_inside=False): """Finds all Mercurial repositories in given directory tree. Works as generator, yielding full paths of all repositories found, ordered alphabetically. If initial path is itself some repository, it is included. By default function does not look for embedded repositories (if we scan from ~/src and both ~/src/somerepo and ~/src/somerepo/subrepo are repositories, only the former will be yielded). This can be changed by check_inside param :param path: Initial path :param check_inside: Shall we look for embedded repos? :return: generator of full repo paths (paths are absolute and even on Windows /-separated) """ # Impl. note: we do not use os.walk as it can be very costly # if some repo is big and deep. pending = deque([normalize_path(path)]) while pending: checked = pending.popleft() if os.path.isdir(checked + '/.hg'): yield checked if not check_inside: continue names = os.listdir(checked) paths = [checked + '/' + name for name in names if name != '.hg'] dir_paths = [item for item in paths if os.path.isdir(item)] pending.extendleft(sorted(dir_paths, reverse=True)) ########################################################################### # Compatibility layers ########################################################################### def command(cmdtable): """ Compatibility layer for mercurial.cmdtutil.command. For Mercurials >= 3.1 it's just synonym for cmdutil.command. For Mercurials <= 3.0 it returns upward compatible function (adding norepo, optionalrepo and inferrepo args which are missing there). Usage: just call ``meu.command(cmdtable)`` instead of ``cmdutil.command(cmdtable)``. For example: >>> cmdtable = {} >>> cmd = command(cmdtable) >>> >>> @cmd("somecmd", [], "somecmd") ... def mycmd(ui, repo, sth, **opts): ... pass >>> >>> @cmd("othercmd", [ ... ('l', 'list', None, 'List widgets'), ... ('p', 'pagesize', 10, 'Page size'), ... ], "othercmd [-l] [-p 20]", norepo=True) ... def othercmd(ui, sth, **opts): ... pass >>> >>> sorted(cmdtable.keys()) ['othercmd', 'somecmd'] >>> cmdtable['othercmd'] # doctest: +ELLIPSIS (, [('l', 'list', None, 'List widgets'), ('p', 'pagesize', 10, 'Page size')], 'othercmd [-l] [-p 20]') Below is uninteresting test that it really works in various mecurials: >>> from mercurial import commands >>> # Syntax changed in hg3.8, trying to accomodate >>> commands.norepo if hasattr(commands, 'norepo') else ' othercmd' # doctest: +ELLIPSIS '... othercmd' >>> othercmd.__dict__['norepo'] if othercmd.__dict__ else True True >>> mycmd.__dict__['norepo'] if mycmd.__dict__ else False False """ from mercurial import cmdutil, commands import inspect command = cmdutil.command(cmdtable) spec = inspect.getargspec(command) if 'norepo' in spec[0]: # Looks like modern mercurial with correct api, keeping # it's implementation return command # Old mecurial with only name, options, synopsis in data, # patching to get full signature. This is more or less copy # of current implementation, sans docs. def parsealiases(cmd): return cmd.lstrip("^").split("|") def fixed_cmd(name, options=(), synopsis=None, norepo=False, optionalrepo=False, inferrepo=False): def decorator(func): if synopsis: cmdtable[name] = func, list(options), synopsis else: cmdtable[name] = func, list(options) if norepo: commands.norepo += ' %s' % ' '.join(parsealiases(name)) if optionalrepo: commands.optionalrepo += ' %s' % ' '.join(parsealiases(name)) if inferrepo: commands.inferrepo += ' %s' % ' '.join(parsealiases(name)) return func return decorator return fixed_cmd ########################################################################### # Demandimport workarounds and other import-related functions ########################################################################### def direct_import(module_name, blocked_modules=None): """ Imports given module, working around Mercurial demandimport (so recursively imported modules are properly imported) >>> re = direct_import("re") >>> re.__name__ 're' >>> re.search("^(.)", "Ala").group(1) 'A' Allows to block some modules from demandimport machinery, so they are not accidentally misloaded: >>> k = direct_import("anydbm", ["dbhash", "gdbm", "dbm", "bsddb.db"]) >>> k.__name__ 'anydbm' :param module_name: name of imported module :param blocked_modules: names of modules to be blocked from demandimport (list) :return: imported module """ return direct_import_ext(module_name, blocked_modules)[0] def direct_import_ext(module_name, blocked_modules=None): """ Like direct_import, but returns info whether module was just imported, or already loaded. >>> m1, loaded = direct_import_ext("xml.sax.handler") >>> m1.__name__, loaded ('xml.sax.handler', True) >>> m2, loaded = direct_import_ext("xml.sax.handler") >>> m2.__name__, loaded ('xml.sax.handler', False) >>> m1 == m2 True :param module_name: name of imported module :param blocked_modules: names of modules to be blocked from demandimport (list) :return: (imported module, was-it-imported-now?) """ if module_name in sys.modules: return sys.modules[module_name], False from mercurial import demandimport if blocked_modules: for blocked_module in blocked_modules: if blocked_module not in demandimport.ignore: demandimport.ignore.append(blocked_module) # Various attempts to define is_demandimport_enabled try: # Since Mercurial 2.9.1 is_demandimport_enabled = demandimport.isenabled except AttributeError: def is_demandimport_enabled(): """Checks whether demandimport is enabled at the moment""" return __import__ == demandimport._demandimport # pylint: disable=protected-access # Temporarily disable demandimport to make the need of extending # the list above less likely. if is_demandimport_enabled(): demandimport.disable() __import__(module_name) demandimport.enable() else: __import__(module_name) return sys.modules[module_name], True def disable_logging(module_name): """ Shut up warning about initialized logging which happens if some imported module logs (mercurial does not setup logging machinery) >>> disable_logging("keyring") :param module_name: Name of logger to disable """ import logging if hasattr(logging, 'NullHandler'): null_handler = logging.NullHandler() else: class NullHandler(logging.Handler): """Emergency null handler""" def handle(self, record): pass def emit(self, record): pass def createLock(self): self.lock = None null_handler = NullHandler() logging.getLogger(module_name).addHandler(null_handler) ########################################################################### # Context detection ########################################################################### def inside_tortoisehg(): """Detects tortoisehg presence - returning True if the function is called by some code which has TortoiseHg in the caller stack. This may be needed in some cases to accomodate specific TortoiseHg main loop behaviours (see enable_hook below for example).""" import inspect for item in inspect.stack(): # item has 6 elems: the frame object, the filename, the line number of the current line, the function name, a list of lines of context from the source code, and the index of the current line within that list. module = inspect.getmodule(item[0]) if module.__name__.startswith("tortoisehg."): return True return False ########################################################################### # Hook support ########################################################################### def enable_hook(ui, hook_name, hook_function): """ Enables given (dynamic) hook. At the moment this is a simple wrapper for ui.setconfig, with the only exception: it checks whether the same function is already configured by name, and if so, doesn't do anything (so it may be used for *dynamically install hook unless it is already statically enabled* cases). :param hook_name: string like "pre-tag.my_function" (hook placement and symbolic name) :param hook_function: proper callable. To handle presence detection, it should be top-level module function (not method, not lambda, not local function embedded inside another function). """ # Detecting function name, and checking whether it seems publically # importable and callable from global module level if hook_function.__class__.__name__ == 'function' \ and not hook_function.__name__.startswith('<') \ and not hook_function.__module__.startswith('__'): hook_function_name = '{module}.{name}'.format( module=hook_function.__module__, name=hook_function.__name__) hook_activator = 'python:' + hook_function_name for key, value in ui.configitems("hooks"): if key == hook_name: if value == hook_activator: ui.debug(_("Hook already statically installed, skipping %s: %s\n") % ( hook_name, hook_function_name)) return if value == hook_function: ui.debug(_("Hook already dynamically installed, skipping %s: %s\n") % ( hook_name, hook_function_name)) return ui.debug(_("Enabling dynamic hook %s: %s.%s\n") % ( hook_name, hook_function.__module__, hook_function.__name__)) # Standard way of hook enabling ui.setconfig("hooks", hook_name, hook_function) mercurial_extension_utils-1.3.1/README.txt0000664000175000017500000001453112630110726021607 0ustar marcinkmarcink00000000000000.. -*- mode: rst -*- ==================================== Mercurial Extension Utils ==================================== This module contains group of reusable functions, which I found useful while writing Mercurial extensions. |drone-badge| .. contents:: :local: :depth: 2 .. sectnum:: For Mercurial users =========================== This module is of no direct use to you, but some extensions you may wish to use (for example `Dynamic Username`_ or `Path Pattern`_) need it to work. In normal cases it should be installed automatically with the actual extension, read below for more tricky cases (in particular, for information about installation on Windows). .. note:: This document uses `Dynamic Username`_ in examples, but the same method should work for any other extension which requires ``mercurial_extension_utils``. Installing on Linux/Unix ------------------------------------------------------- In typical case ``mercurial_extension_utils`` should be installed automatically, without requiring your attention, by commands like ``pip install mercurial_dynamic_username``. If for some reason it did not work, just install from PyPi with:: pip install --user mercurial_extension_utils or system-wide with:: sudo pip install mercurial_extension_utils If you don't have ``pip``, try:: sudo easy_install mercurial_extension_utils Upgrade to newer version using the same commands with ``--upgrade`` option added, for example:: pip install --user --upgrade mercurial_extension_utils If you miss both ``pip``, and ``easy_install``, follow recipe from `Installing for development`_ section. Installing on Windows ------------------------------------------------------- Windows Mercurial distributions (including most popular - and well deserving that - TortoiseHg_) are not using system Python (in fact, one may use Mercurial without installing Python at all), and installing into bundled Python path is uneasy. To remedy that, extensions utilizing this module handle additional methods of locating it. The following two methods of installation are available: 1. If you have some Python installed, you may still install both this module, and extension using it, from PyPi. For example:: pip install mercurial_extension_utils pip install mercurial_dynamic_username This will not (yet) make the module visible to your Mercurial, but you will get all the necessary files installed on your computer. Then activate the actual extension in charge by specifying it's path, for example by writing in your ``Mercurial.ini``:: [extensions] mercurial_dynamic_username = C:/Python27/Lib/site-packages/mercurial_dynamic_username.py .. note:: This works because ``mercurial_dynamic_username.py`` checks for ``mercurial_extension_utils.py`` saved in the same directory (and ``pip`` installs both modules in the same place). You can get the same effect by manually downloading all files into the same directory (using ``pip`` is more handy as it tracks dependencies and supports upgrades). Upgrade with ``pip`` by adding ``--upgrade`` to it's options. 2. If you don't have any Python, clone both the extension(s) repository and ``mercurial_extension_utils``` and put them in the same place, for example:: cd c:\MercurialPlugins hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/ Update repositories to newest tagged versions (untagged versions may be unstable or not working). Activate the actual extension by specifying it's path, for example by writing in ``Mercurial.ini``:: [extensions] mercurial_dynamic_username = C:/MercurialPlugins/mercurial-dynamic_username/mercurial_dynamic_username.py .. note:: Directory names matter. This works because ``mercurial_dynamic_username.py`` checks for ``mercurial_extension_utils.py`` in ``../mercurial_extension_utils`` and ``../extension_utils`` (relative to it's own location). To upgrade to new version, simply pull and update to newer tag. Installing for development ------------------------------------------------------- On Windows use second variant from the previous chapter (clone and activate by path). On Linux/Unix do the same. Clone all the necessary repositories, for example:: cd ~/sources/ hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/ then either make it visible to Python by repeating in every repo:: pip install --user -e . or activate the extension(s) by full path, by writing in ``~/.hgrc`` something like:: [extensions] mercurial_dynamic_username = ~/sources/mercurial-dynamic_username/mercurial_dynamic_username.py For Mercurial extensions developers ==================================== Contained functions are mostly tiny utilities related to configuration processing or location matching. They either extend Mercurial APIs a bit (like function to iterate config items which match regexp), or support tasks which aren't strictly Mercurial related, but happen repeatably during extension writing (like matching repository root against set of paths defined in configuration). See docstrings for details. History ================================================== See `HISTORY.txt`_ Development, bug reports, enhancement suggestions =================================================== Development is tracked on BitBucket, see http://bitbucket.org/Mekk/mercurial-extension_utils/ Use BitBucket issue tracker for bug reports and enhancement suggestions. Additional notes ==================================================== Check also `Mercurial extensions I wrote`_. .. _Mercurial extensions I wrote: http://mekk.bitbucket.org/mercurial.html .. _Mercurial: http://mercurial.selenic.com .. _Dynamic Username: http://bitbucket.org/Mekk/mercurial-dynamic_username/ .. _Path Pattern: http://bitbucket.org/Mekk/mercurial-path_pattern/ .. _HISTORY.txt: http://bitbucket.org/Mekk/mercurial-extension_utils/src/tip/HISTORY.txt .. _TortoiseHg: http://tortoisehg.bitbucket.org/ .. |drone-badge| image:: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/status.png :target: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/latest :align: middle mercurial_extension_utils-1.3.1/setup.py0000664000175000017500000000240013012045346021613 0ustar marcinkmarcink00000000000000# pylint:disable=missing-docstring from setuptools import setup, find_packages VERSION = '1.3.1' LONG_DESCRIPTION = open("README.txt").read() INSTALL_REQUIRES = [] setup( name="mercurial_extension_utils", version=VERSION, author='Marcin Kasperski', author_email='Marcin.Kasperski@mekk.waw.pl', url='http://bitbucket.org/Mekk/mercurial-extension_utils', description='Mercurial Extension Utils', long_description=LONG_DESCRIPTION, license='BSD', py_modules=['mercurial_extension_utils'], keywords="mercurial hg extension", install_requires=INSTALL_REQUIRES, # Giving up on python setup.py test, discovery too problematic # tests_require=TEST_REQUIRES, # test_suite='tests', classifiers=[ 'Development Status :: 4 - Beta', 'Environment :: Console', 'Intended Audience :: Developers', 'License :: DFSG approved', 'License :: OSI Approved :: BSD License', 'Programming Language :: Python :: 2', 'Operating System :: OS Independent', 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Version Control', # 'Topic :: Software Development :: Version Control :: Mercurial', ], zip_safe=True) mercurial_extension_utils-1.3.1/PKG-INFO0000664000175000017500000002111113012045362021174 0ustar marcinkmarcink00000000000000Metadata-Version: 1.1 Name: mercurial_extension_utils Version: 1.3.1 Summary: Mercurial Extension Utils Home-page: http://bitbucket.org/Mekk/mercurial-extension_utils Author: Marcin Kasperski Author-email: Marcin.Kasperski@mekk.waw.pl License: BSD Description: .. -*- mode: rst -*- ==================================== Mercurial Extension Utils ==================================== This module contains group of reusable functions, which I found useful while writing Mercurial extensions. |drone-badge| .. contents:: :local: :depth: 2 .. sectnum:: For Mercurial users =========================== This module is of no direct use to you, but some extensions you may wish to use (for example `Dynamic Username`_ or `Path Pattern`_) need it to work. In normal cases it should be installed automatically with the actual extension, read below for more tricky cases (in particular, for information about installation on Windows). .. note:: This document uses `Dynamic Username`_ in examples, but the same method should work for any other extension which requires ``mercurial_extension_utils``. Installing on Linux/Unix ------------------------------------------------------- In typical case ``mercurial_extension_utils`` should be installed automatically, without requiring your attention, by commands like ``pip install mercurial_dynamic_username``. If for some reason it did not work, just install from PyPi with:: pip install --user mercurial_extension_utils or system-wide with:: sudo pip install mercurial_extension_utils If you don't have ``pip``, try:: sudo easy_install mercurial_extension_utils Upgrade to newer version using the same commands with ``--upgrade`` option added, for example:: pip install --user --upgrade mercurial_extension_utils If you miss both ``pip``, and ``easy_install``, follow recipe from `Installing for development`_ section. Installing on Windows ------------------------------------------------------- Windows Mercurial distributions (including most popular - and well deserving that - TortoiseHg_) are not using system Python (in fact, one may use Mercurial without installing Python at all), and installing into bundled Python path is uneasy. To remedy that, extensions utilizing this module handle additional methods of locating it. The following two methods of installation are available: 1. If you have some Python installed, you may still install both this module, and extension using it, from PyPi. For example:: pip install mercurial_extension_utils pip install mercurial_dynamic_username This will not (yet) make the module visible to your Mercurial, but you will get all the necessary files installed on your computer. Then activate the actual extension in charge by specifying it's path, for example by writing in your ``Mercurial.ini``:: [extensions] mercurial_dynamic_username = C:/Python27/Lib/site-packages/mercurial_dynamic_username.py .. note:: This works because ``mercurial_dynamic_username.py`` checks for ``mercurial_extension_utils.py`` saved in the same directory (and ``pip`` installs both modules in the same place). You can get the same effect by manually downloading all files into the same directory (using ``pip`` is more handy as it tracks dependencies and supports upgrades). Upgrade with ``pip`` by adding ``--upgrade`` to it's options. 2. If you don't have any Python, clone both the extension(s) repository and ``mercurial_extension_utils``` and put them in the same place, for example:: cd c:\MercurialPlugins hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/ Update repositories to newest tagged versions (untagged versions may be unstable or not working). Activate the actual extension by specifying it's path, for example by writing in ``Mercurial.ini``:: [extensions] mercurial_dynamic_username = C:/MercurialPlugins/mercurial-dynamic_username/mercurial_dynamic_username.py .. note:: Directory names matter. This works because ``mercurial_dynamic_username.py`` checks for ``mercurial_extension_utils.py`` in ``../mercurial_extension_utils`` and ``../extension_utils`` (relative to it's own location). To upgrade to new version, simply pull and update to newer tag. Installing for development ------------------------------------------------------- On Windows use second variant from the previous chapter (clone and activate by path). On Linux/Unix do the same. Clone all the necessary repositories, for example:: cd ~/sources/ hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/ then either make it visible to Python by repeating in every repo:: pip install --user -e . or activate the extension(s) by full path, by writing in ``~/.hgrc`` something like:: [extensions] mercurial_dynamic_username = ~/sources/mercurial-dynamic_username/mercurial_dynamic_username.py For Mercurial extensions developers ==================================== Contained functions are mostly tiny utilities related to configuration processing or location matching. They either extend Mercurial APIs a bit (like function to iterate config items which match regexp), or support tasks which aren't strictly Mercurial related, but happen repeatably during extension writing (like matching repository root against set of paths defined in configuration). See docstrings for details. History ================================================== See `HISTORY.txt`_ Development, bug reports, enhancement suggestions =================================================== Development is tracked on BitBucket, see http://bitbucket.org/Mekk/mercurial-extension_utils/ Use BitBucket issue tracker for bug reports and enhancement suggestions. Additional notes ==================================================== Check also `Mercurial extensions I wrote`_. .. _Mercurial extensions I wrote: http://mekk.bitbucket.org/mercurial.html .. _Mercurial: http://mercurial.selenic.com .. _Dynamic Username: http://bitbucket.org/Mekk/mercurial-dynamic_username/ .. _Path Pattern: http://bitbucket.org/Mekk/mercurial-path_pattern/ .. _HISTORY.txt: http://bitbucket.org/Mekk/mercurial-extension_utils/src/tip/HISTORY.txt .. _TortoiseHg: http://tortoisehg.bitbucket.org/ .. |drone-badge| image:: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/status.png :target: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/latest :align: middle Keywords: mercurial hg extension Platform: UNKNOWN Classifier: Development Status :: 4 - Beta Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: License :: DFSG approved Classifier: License :: OSI Approved :: BSD License Classifier: Programming Language :: Python :: 2 Classifier: Operating System :: OS Independent Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: Topic :: Software Development :: Version Control mercurial_extension_utils-1.3.1/setup.cfg0000664000175000017500000000007313012045362021724 0ustar marcinkmarcink00000000000000[egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 mercurial_extension_utils-1.3.1/mercurial_extension_utils.egg-info/0000775000175000017500000000000013012045362027074 5ustar marcinkmarcink00000000000000mercurial_extension_utils-1.3.1/mercurial_extension_utils.egg-info/SOURCES.txt0000664000175000017500000000044013012045361030755 0ustar marcinkmarcink00000000000000README.txt mercurial_extension_utils.py setup.py mercurial_extension_utils.egg-info/PKG-INFO mercurial_extension_utils.egg-info/SOURCES.txt mercurial_extension_utils.egg-info/dependency_links.txt mercurial_extension_utils.egg-info/top_level.txt mercurial_extension_utils.egg-info/zip-safemercurial_extension_utils-1.3.1/mercurial_extension_utils.egg-info/top_level.txt0000664000175000017500000000003213012045361031620 0ustar marcinkmarcink00000000000000mercurial_extension_utils mercurial_extension_utils-1.3.1/mercurial_extension_utils.egg-info/PKG-INFO0000664000175000017500000002111113012045361030164 0ustar marcinkmarcink00000000000000Metadata-Version: 1.1 Name: mercurial-extension-utils Version: 1.3.1 Summary: Mercurial Extension Utils Home-page: http://bitbucket.org/Mekk/mercurial-extension_utils Author: Marcin Kasperski Author-email: Marcin.Kasperski@mekk.waw.pl License: BSD Description: .. -*- mode: rst -*- ==================================== Mercurial Extension Utils ==================================== This module contains group of reusable functions, which I found useful while writing Mercurial extensions. |drone-badge| .. contents:: :local: :depth: 2 .. sectnum:: For Mercurial users =========================== This module is of no direct use to you, but some extensions you may wish to use (for example `Dynamic Username`_ or `Path Pattern`_) need it to work. In normal cases it should be installed automatically with the actual extension, read below for more tricky cases (in particular, for information about installation on Windows). .. note:: This document uses `Dynamic Username`_ in examples, but the same method should work for any other extension which requires ``mercurial_extension_utils``. Installing on Linux/Unix ------------------------------------------------------- In typical case ``mercurial_extension_utils`` should be installed automatically, without requiring your attention, by commands like ``pip install mercurial_dynamic_username``. If for some reason it did not work, just install from PyPi with:: pip install --user mercurial_extension_utils or system-wide with:: sudo pip install mercurial_extension_utils If you don't have ``pip``, try:: sudo easy_install mercurial_extension_utils Upgrade to newer version using the same commands with ``--upgrade`` option added, for example:: pip install --user --upgrade mercurial_extension_utils If you miss both ``pip``, and ``easy_install``, follow recipe from `Installing for development`_ section. Installing on Windows ------------------------------------------------------- Windows Mercurial distributions (including most popular - and well deserving that - TortoiseHg_) are not using system Python (in fact, one may use Mercurial without installing Python at all), and installing into bundled Python path is uneasy. To remedy that, extensions utilizing this module handle additional methods of locating it. The following two methods of installation are available: 1. If you have some Python installed, you may still install both this module, and extension using it, from PyPi. For example:: pip install mercurial_extension_utils pip install mercurial_dynamic_username This will not (yet) make the module visible to your Mercurial, but you will get all the necessary files installed on your computer. Then activate the actual extension in charge by specifying it's path, for example by writing in your ``Mercurial.ini``:: [extensions] mercurial_dynamic_username = C:/Python27/Lib/site-packages/mercurial_dynamic_username.py .. note:: This works because ``mercurial_dynamic_username.py`` checks for ``mercurial_extension_utils.py`` saved in the same directory (and ``pip`` installs both modules in the same place). You can get the same effect by manually downloading all files into the same directory (using ``pip`` is more handy as it tracks dependencies and supports upgrades). Upgrade with ``pip`` by adding ``--upgrade`` to it's options. 2. If you don't have any Python, clone both the extension(s) repository and ``mercurial_extension_utils``` and put them in the same place, for example:: cd c:\MercurialPlugins hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/ Update repositories to newest tagged versions (untagged versions may be unstable or not working). Activate the actual extension by specifying it's path, for example by writing in ``Mercurial.ini``:: [extensions] mercurial_dynamic_username = C:/MercurialPlugins/mercurial-dynamic_username/mercurial_dynamic_username.py .. note:: Directory names matter. This works because ``mercurial_dynamic_username.py`` checks for ``mercurial_extension_utils.py`` in ``../mercurial_extension_utils`` and ``../extension_utils`` (relative to it's own location). To upgrade to new version, simply pull and update to newer tag. Installing for development ------------------------------------------------------- On Windows use second variant from the previous chapter (clone and activate by path). On Linux/Unix do the same. Clone all the necessary repositories, for example:: cd ~/sources/ hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/ then either make it visible to Python by repeating in every repo:: pip install --user -e . or activate the extension(s) by full path, by writing in ``~/.hgrc`` something like:: [extensions] mercurial_dynamic_username = ~/sources/mercurial-dynamic_username/mercurial_dynamic_username.py For Mercurial extensions developers ==================================== Contained functions are mostly tiny utilities related to configuration processing or location matching. They either extend Mercurial APIs a bit (like function to iterate config items which match regexp), or support tasks which aren't strictly Mercurial related, but happen repeatably during extension writing (like matching repository root against set of paths defined in configuration). See docstrings for details. History ================================================== See `HISTORY.txt`_ Development, bug reports, enhancement suggestions =================================================== Development is tracked on BitBucket, see http://bitbucket.org/Mekk/mercurial-extension_utils/ Use BitBucket issue tracker for bug reports and enhancement suggestions. Additional notes ==================================================== Check also `Mercurial extensions I wrote`_. .. _Mercurial extensions I wrote: http://mekk.bitbucket.org/mercurial.html .. _Mercurial: http://mercurial.selenic.com .. _Dynamic Username: http://bitbucket.org/Mekk/mercurial-dynamic_username/ .. _Path Pattern: http://bitbucket.org/Mekk/mercurial-path_pattern/ .. _HISTORY.txt: http://bitbucket.org/Mekk/mercurial-extension_utils/src/tip/HISTORY.txt .. _TortoiseHg: http://tortoisehg.bitbucket.org/ .. |drone-badge| image:: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/status.png :target: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/latest :align: middle Keywords: mercurial hg extension Platform: UNKNOWN Classifier: Development Status :: 4 - Beta Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: License :: DFSG approved Classifier: License :: OSI Approved :: BSD License Classifier: Programming Language :: Python :: 2 Classifier: Operating System :: OS Independent Classifier: Topic :: Software Development :: Libraries :: Python Modules Classifier: Topic :: Software Development :: Version Control mercurial_extension_utils-1.3.1/mercurial_extension_utils.egg-info/zip-safe0000664000175000017500000000000112630510346030530 0ustar marcinkmarcink00000000000000 mercurial_extension_utils-1.3.1/mercurial_extension_utils.egg-info/dependency_links.txt0000664000175000017500000000000113012045361033141 0ustar marcinkmarcink00000000000000