Merge lp:~a1s/bzr-externals/breezy into lp:bzr-externals

[Aleksandr Smyshliaev]

Update for Breezy and Python3

- Change imports from bzrlib to breezy
- Use Python3 text file operations to read and write bzrmeta files
- Fix reading externals configuration from an InventoryTree
- Use command "brz ignore" instead of writing to IGNORE_FILENAME (Breezy doesn't export IGNORE_FILENAME)

Unmerged revisions

59. By Aleksandr Smyshliaev on 2023-01-11

Fix adding external working tree to the ignore list

58. By Aleksandr Smyshliaev on 2023-01-11

Fix reading externals config from a revision tree: the argument for get_file_text() must be a path, not file id

57. By Aleksandr Smyshliaev on 2023-01-11

Normalize line endings

56. By Aleksandr Smyshliaev on 2023-01-11

fix import paths in the commands module

55. By Aleksandr Smyshliaev on 2023-01-11

use Python3 text mode for file operations

54. By Aleksandr Smyshliaev on 2023-01-11

Change imports from bzrlib to breezy

=== modified file '__init__.py'
--- __init__.py	2012-03-15 02:32:58 +0000
+++ __init__.py	2023-01-11 14:30:26 +0000
@@ -56,15 +56,15 @@
   url directory [revisionspec]
 """
 
-from bzrlib.lazy_import import lazy_import
+from breezy.lazy_import import lazy_import
 lazy_import(globals(), """
-from bzrlib.plugins.externals import externals as lazy_externals
-from bzrlib.plugins.externals import commands as lazy_commands
+from breezy.plugins.externals import externals as lazy_externals
+from breezy.plugins.externals import commands as lazy_commands
 """)
 
-from bzrlib.branch import Branch
-from bzrlib.mutabletree import MutableTree
-from bzrlib.commands import Command, plugin_cmds
+from breezy.branch import Branch
+from breezy.mutabletree import MutableTree
+from breezy.commands import Command, plugin_cmds
 
 plugin_name = 'externals'
 version_info = (1, 3, 4, 'dev', 2)
@@ -115,7 +115,7 @@
 install_hooks()
 
 def register_commands():
-    module = 'bzrlib.plugins.externals.commands'
+    module = 'breezy.plugins.externals.commands'
     plugin_cmds.register_lazy('cmd_externals_add',
         ['eadd'], module)
     plugin_cmds.register_lazy('cmd_externals_command',
@@ -135,9 +135,9 @@
 def new_finished(self):
     old_finished(self)
     # clear line
-    from bzrlib.ui import ui_factory
+    from breezy.ui import ui_factory
     ui_factory.clear_term()
 
-from bzrlib.progress import ProgressTask
+from breezy.progress import ProgressTask
 old_finished = ProgressTask.finished
 ProgressTask.finished = new_finished

=== modified file 'commands.py'
--- commands.py	2012-03-15 02:32:58 +0000
+++ commands.py	2023-01-11 14:30:26 +0000
@@ -16,14 +16,14 @@
 
 import os.path
 
-from bzrlib.osutils import getcwd, get_user_encoding, isdir, isfile, pathjoin, relpath
-from bzrlib.commands import Command, run_bzr_catch_user_errors
-from bzrlib.option import Option
-from bzrlib.trace import is_quiet, note
-from bzrlib.bzrdir import BzrDir
-from bzrlib.workingtree import WorkingTree
+from breezy.osutils import getcwd, get_user_encoding, isdir, isfile, pathjoin, relpath
+from breezy.commands import Command, run_bzr_catch_user_errors
+from breezy.option import Option
+from breezy.trace import is_quiet, note
+from breezy.bzr.bzrdir import BzrDir
+from breezy.workingtree import WorkingTree
 
-import externals
+from . import externals
 
 _main_cwd = getcwd()
 _main_base = None
@@ -92,12 +92,10 @@
         self._add_to_file(root, externals.SNAPSHOT_PATH, line)
 
         # add ignore mask
-        from bzrlib import IGNORE_FILENAME
-        self._add_to_file(root, IGNORE_FILENAME, './' + to_location)
+        run_bzr_catch_user_errors(['ignore', './' + to_location])
 
         # add config files to repository
         cmd = ['add',
-            '.bzrignore',
             '.bzrmeta/externals',
             '.bzrmeta/externals-snapshot']
         run_bzr_catch_user_errors(cmd)
@@ -112,7 +110,7 @@
         content = ''
         path = pathjoin(root, file_name)
         if isfile(path):
-            f = open(path, 'rU')
+            f = open(path, 'rt', encoding='utf-8')
             try:
                 content = f.read()
             finally:
@@ -121,8 +119,8 @@
                 # add at end of file the char '\n' if needed
                 content += '\n'
 
-        content += line.encode('utf-8') + '\n'
-        f = open(path, 'w')
+        content += line + '\n'
+        f = open(path, 'wt', encoding='utf-8')
         try:
             f.write(content)
         finally:
@@ -210,10 +208,10 @@
     def _substitute_in_commandlist(self, command_list, rel_path):
         return [x.replace('{relpath}', rel_path) for x in command_list]
 
-import bzrlib.builtins
+import breezy.builtins
 
-class cmd_branch(bzrlib.builtins.cmd_branch):
-    __doc__ = bzrlib.builtins.cmd_branch.__doc__
+class cmd_branch(breezy.builtins.cmd_branch):
+    __doc__ = breezy.builtins.cmd_branch.__doc__
 
     def plugin_name(self):
         return None
@@ -222,8 +220,8 @@
         externals.command_kwargs = kwargs
         super(cmd_branch, self).run(**kwargs)
 
-class cmd_checkout(bzrlib.builtins.cmd_checkout):
-    __doc__ = bzrlib.builtins.cmd_checkout.__doc__
+class cmd_checkout(breezy.builtins.cmd_checkout):
+    __doc__ = breezy.builtins.cmd_checkout.__doc__
 
     def plugin_name(self):
         return None

=== modified file 'externals.py'
--- externals.py	2012-01-20 00:19:27 +0000
+++ externals.py	2023-01-11 14:30:26 +0000
@@ -1,249 +1,254 @@
-# Copyright (C) 2009 Eugene Tarasenko, Alexander Belchenko
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
-import os
-
-from bzrlib.urlutils import join, local_path_from_url
-from bzrlib.osutils import check_legal_path, getcwd, get_user_encoding, isdir, isfile, pathjoin, relpath
-from bzrlib.commands import run_bzr_catch_user_errors
-from bzrlib.cmdline import split
-from bzrlib.trace import is_quiet, is_verbose, note, warning
-
-CONFIG_PATH = '.bzrmeta/externals'
-SNAPSHOT_PATH = '.bzrmeta/externals-snapshot'
-
-disable_hooks = False # for prevent double running external command
-command_kwargs = None # each new command changed value
-
-class Externals:
-    
-    def __init__(self, branch, revid, root=None):
-        self.branch = branch
-        self.revid = revid
-        if root is not None:
-            self.root = root
-        else:
-            self.root = local_path_from_url(branch.base)
-        self.cwd = getcwd()
-        self.config = []
-        self.bound = True
-        self.use_snapshot = command_kwargs and 'revision' in command_kwargs
-
-    def _set_config(self, text):
-        lines = text.splitlines()
-        for line in lines:
-            if len(line.strip()) > 0 and not line.startswith('#'):
-                # function cmdline.split does not support windows path separator '\'
-                line = line.decode('utf-8').replace('\\', '/')
-                arg = split(line)
-                if arg not in self.config:
-                    self.config.append(arg)
-
-    def read_config(self):
-        path = pathjoin(self.root, CONFIG_PATH)
-        if self.use_snapshot or not isfile(path):
-            # config file not exist in directory
-            return False
-        f = open(path, 'rU')
-        try:
-            self._set_config(f.read())
-        finally:
-            f.close()
-        return len(self.config) > 0
-    
-    def read_config_from_repository(self):
-        rev_tree = self.branch.repository.revision_tree(self.revid)
-        if self.use_snapshot:
-            file_id = rev_tree.path2id(SNAPSHOT_PATH)
-            if not file_id:
-                file_id = rev_tree.path2id(CONFIG_PATH)
-                if file_id:
-                    warning('warning: for this revision there is no snapshot of external branches!')
-        else:
-            file_id = rev_tree.path2id(CONFIG_PATH)
-        if not file_id:
-            # there is no config or snapshot files in repository
-            return False
-        rev_tree.lock_read()
-        try:
-            text = rev_tree.get_file_text(file_id)
-            self._set_config(text)
-        finally:
-            rev_tree.unlock()
-        return len(self.config) > 0
-
-    def _relpath(self, path):
-        try:
-            return relpath(self.cwd, path)
-        except:
-            pass
-        return path
-
-    @staticmethod
-    def _relurljoin(base, relative):
-        if relative.startswith('//'):
-            # urlutils.join not supports relative urls start with '//'
-            scheme = base.partition('://')
-            return scheme[0] + ':' + relative
-        else:
-            return join(base, relative)
-
-    @staticmethod
-    def _report(cmd):
-        if not is_quiet():
-            note('External ' + ' '.join(cmd))
-
-    @staticmethod
-    def adjust_verbosity(cmd):
-        if is_quiet():
-            cmd += ['-q']
-        if is_verbose():
-            cmd += ['-v']
-
-    def branch_iterator(self, target_root=None):
-        if len(self.config) == 0:
-            # branch not have externals configuration
-            return
-
-        self.bound = True
-        if not target_root:
-            target_root = self.branch.get_bound_location()
-            if not target_root:
-                self.bound = False
-                target_root = self.branch.get_parent()
-                if not target_root:
-                    # support new braches with no parent yet
-                    target_root = self.branch.base
-
-        for arg in self.config: # url directory [revisionspec]
-            location = self._relurljoin(target_root, arg[0])
-            if target_root.startswith('file:///'):
-                # try to pull externals from the parent for the feature branch
-                path = pathjoin(local_path_from_url(target_root), arg[1])
-                if isdir(path):
-                    location = self._relpath(path)
-                else:
-                    # parent is local master branch
-                    if location.startswith('file:///'):
-                        location = self._relpath(local_path_from_url(location))
-
-            check_legal_path(arg[1])
-            rel_path = self._relpath(pathjoin(self.root, arg[1]))
-            
-            revision = None
-            if len(arg) > 2:
-                revision = arg[2]
-            yield location, rel_path, revision
-
-    def pull(self):
-        if disable_hooks:
-            return
-
-        # need use merged config from repository and working tree
-        # because new added external branch from repository or working tree
-        # need pull/update for correct snapshot
-        self.read_config()
-        self.read_config_from_repository()
-        if len(self.config) == 0:
-            return
-        
-        for location, path, revision in self.branch_iterator():
-            if location == path:
-                # not create feature branch for directory above the root
-                continue
-
-            # select what do it
-            if isdir(pathjoin(path, '.bzr')) or isdir(pathjoin(path, '.svn')):
-                if self.bound:
-                    cmd = ['update', path]
-                else:
-                    cmd = ['pull', location, '--directory', path]
-            else:
-                if self.bound:
-                    cmd = ['checkout', location, path]
-                else:
-                    cmd = ['branch', location, path]
-
-                # command branch don't create recursive directory
-                dirs = path.rpartition('/')
-                if dirs[0] != '' and not isdir(dirs[0]):
-                    os.makedirs(dirs[0].encode(get_user_encoding()))
-
-            # if use revision options but not for 'update'
-            if revision is not None and cmd[0] != 'update':
-                cmd += ['--revision', revision]
-
-            self.adjust_verbosity(cmd)
-            self._report(cmd)
-            run_bzr_catch_user_errors(cmd)
-
-    def push(self, target):
-        if disable_hooks or not self.read_config():
-            return
-
-        for location, path, revision in self.branch_iterator(target):
-            if location == path:
-                # don't push into itself
-                continue
-
-            # XXX: maybe he should rather decorate the push command
-            # so that we can get the commandline args
-            # alternatively the plugin infrastructure must provide it to us?!
-            cmd = ['push', location, '--directory', path, '--no-strict']
-
-            if revision is not None:
-                # not push if use revision 
-                continue
-
-            self.adjust_verbosity(cmd)
-            self._report(cmd)
-            run_bzr_catch_user_errors(cmd)
-
-    @staticmethod
-    def _quoted_if_need(text):
-        if text.find(' ') != -1:
-            text = '"' + text + '"'
-        return text
-       
-    def commit(self, mutable_tree):
-        # BUG: not run recursively if in above branch not have changes  
-        if disable_hooks or not self.read_config():
-            return
-
-        from bzrlib.workingtree import WorkingTree
-        snapshot = []
-        for arg in self.config: # url directory [revisionspec]
-            wt = WorkingTree.open(pathjoin(self.root, arg[1]))
-            if wt.has_changes(wt.basis_tree()):
-                cmd = ['ci']
-                os.chdir(wt.basedir)
-                try:
-                    run_bzr_catch_user_errors(cmd)
-                finally:
-                    os.chdir(self.cwd)
-                    
-            if len(arg) < 3:
-                arg.append('')                
-            arg[2] = 'revid:' + wt.last_revision()
-            arg[1] = self._quoted_if_need(arg[1])
-            snapshot.append(' '.join(arg).encode('utf-8'))
-
-        path = pathjoin(self.root, SNAPSHOT_PATH)
-        f = open(path, 'w')
-        try:
-            f.write('\n'.join(snapshot))
-        finally:
-            f.close()
+# Copyright (C) 2009 Eugene Tarasenko, Alexander Belchenko
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+import os
+
+from breezy.urlutils import join, local_path_from_url
+from breezy.osutils import check_legal_path, getcwd, get_user_encoding, isdir, isfile, pathjoin, relpath
+from breezy.commands import run_bzr_catch_user_errors
+from breezy.cmdline import split
+from breezy.trace import is_quiet, is_verbose, note, warning
+
+CONFIG_PATH = '.bzrmeta/externals'
+SNAPSHOT_PATH = '.bzrmeta/externals-snapshot'
+
+disable_hooks = False # for prevent double running external command
+command_kwargs = None # each new command changed value
+
+class Externals:
+
+    def __init__(self, branch, revid, root=None):
+        self.branch = branch
+        self.revid = revid
+        if root is not None:
+            self.root = root
+        else:
+            self.root = local_path_from_url(branch.base)
+        self.cwd = getcwd()
+        self.config = []
+        self.bound = True
+        self.use_snapshot = command_kwargs and 'revision' in command_kwargs
+
+    def _set_config(self, text):
+        lines = text.splitlines()
+        for line in lines:
+            if len(line.strip()) > 0 and not line.startswith('#'):
+                # function cmdline.split does not support windows path separator '\'
+                line = line.replace('\\', '/')
+                arg = split(line)
+                if arg not in self.config:
+                    self.config.append(arg)
+
+    def read_config(self):
+        path = pathjoin(self.root, CONFIG_PATH)
+        if self.use_snapshot or not isfile(path):
+            # config file not exist in directory
+            return False
+        f = open(path, 'rt', encoding='utf-8')
+        try:
+            self._set_config(f.read())
+        finally:
+            f.close()
+        return len(self.config) > 0
+
+    def read_config_from_repository(self):
+        rev_tree = self.branch.repository.revision_tree(self.revid)
+        if self.use_snapshot:
+            if rev_tree.is_versioned(SNAPSHOT_PATH):
+                cfg_path = SHAPSHOT_PATH
+            else:
+                cfg_path = CONFIG_PATH
+                if rev_tree.is_versioned(cfg_path):
+                    warning('warning: for this revision there is no snapshot of external branches!')
+                else:
+                    cfg_path = None
+        else:
+            cfg_path = CONFIG_PATH
+            if not rev_tree.is_versioned(cfg_path):
+                cfg_path = None
+        if not cfg_path:
+            # there is no config or snapshot files in repository
+            return False
+        rev_tree.lock_read()
+        try:
+            text = rev_tree.get_file_text(cfg_path)
+            self._set_config(text.decode('utf-8'))
+        finally:
+            rev_tree.unlock()
+        return len(self.config) > 0
+
+    def _relpath(self, path):
+        try:
+            return relpath(self.cwd, path)
+        except:
+            pass
+        return path
+
+    @staticmethod
+    def _relurljoin(base, relative):
+        if relative.startswith('//'):
+            # urlutils.join not supports relative urls start with '//'
+            scheme = base.partition('://')
+            return scheme[0] + ':' + relative
+        else:
+            return join(base, relative)
+
+    @staticmethod
+    def _report(cmd):
+        if not is_quiet():
+            note('External ' + ' '.join(cmd))
+
+    @staticmethod
+    def adjust_verbosity(cmd):
+        if is_quiet():
+            cmd += ['-q']
+        if is_verbose():
+            cmd += ['-v']
+
+    def branch_iterator(self, target_root=None):
+        if len(self.config) == 0:
+            # branch not have externals configuration
+            return
+
+        self.bound = True
+        if not target_root:
+            target_root = self.branch.get_bound_location()
+            if not target_root:
+                self.bound = False
+                target_root = self.branch.get_parent()
+                if not target_root:
+                    # support new braches with no parent yet
+                    target_root = self.branch.base
+
+        for arg in self.config: # url directory [revisionspec]
+            location = self._relurljoin(target_root, arg[0])
+            if target_root.startswith('file:///'):
+                # try to pull externals from the parent for the feature branch
+                path = pathjoin(local_path_from_url(target_root), arg[1])
+                if isdir(path):
+                    location = self._relpath(path)
+                else:
+                    # parent is local master branch
+                    if location.startswith('file:///'):
+                        location = self._relpath(local_path_from_url(location))
+
+            check_legal_path(arg[1])
+            rel_path = self._relpath(pathjoin(self.root, arg[1]))
+
+            revision = None
+            if len(arg) > 2:
+                revision = arg[2]
+            yield location, rel_path, revision
+
+    def pull(self):
+        if disable_hooks:
+            return
+
+        # need use merged config from repository and working tree
+        # because new added external branch from repository or working tree
+        # need pull/update for correct snapshot
+        self.read_config()
+        self.read_config_from_repository()
+        if len(self.config) == 0:
+            return
+
+        for location, path, revision in self.branch_iterator():
+            if location == path:
+                # not create feature branch for directory above the root
+                continue
+
+            # select what do it
+            if isdir(pathjoin(path, '.bzr')) or isdir(pathjoin(path, '.svn')):
+                if self.bound:
+                    cmd = ['update', path]
+                else:
+                    cmd = ['pull', location, '--directory', path]
+            else:
+                if self.bound:
+                    cmd = ['checkout', location, path]
+                else:
+                    cmd = ['branch', location, path]
+
+                # command branch don't create recursive directory
+                dirs = path.rpartition('/')
+                if dirs[0] != '' and not isdir(dirs[0]):
+                    os.makedirs(dirs[0].encode(get_user_encoding()))
+
+            # if use revision options but not for 'update'
+            if revision is not None and cmd[0] != 'update':
+                cmd += ['--revision', revision]
+
+            self.adjust_verbosity(cmd)
+            self._report(cmd)
+            run_bzr_catch_user_errors(cmd)
+
+    def push(self, target):
+        if disable_hooks or not self.read_config():
+            return
+
+        for location, path, revision in self.branch_iterator(target):
+            if location == path:
+                # don't push into itself
+                continue
+
+            # XXX: maybe he should rather decorate the push command
+            # so that we can get the commandline args
+            # alternatively the plugin infrastructure must provide it to us?!
+            cmd = ['push', location, '--directory', path, '--no-strict']
+
+            if revision is not None:
+                # not push if use revision
+                continue
+
+            self.adjust_verbosity(cmd)
+            self._report(cmd)
+            run_bzr_catch_user_errors(cmd)
+
+    @staticmethod
+    def _quoted_if_need(text):
+        if text.find(' ') != -1:
+            text = '"' + text + '"'
+        return text
+
+    def commit(self, mutable_tree):
+        # BUG: not run recursively if in above branch not have changes
+        if disable_hooks or not self.read_config():
+            return
+
+        from breezy.workingtree import WorkingTree
+        snapshot = []
+        for arg in self.config: # url directory [revisionspec]
+            wt = WorkingTree.open(pathjoin(self.root, arg[1]))
+            if wt.has_changes(wt.basis_tree()):
+                cmd = ['ci']
+                os.chdir(wt.basedir)
+                try:
+                    run_bzr_catch_user_errors(cmd)
+                finally:
+                    os.chdir(self.cwd)
+
+            if len(arg) < 3:
+                arg.append('')
+            arg[2] = 'revid:' + wt.last_revision()
+            arg[1] = self._quoted_if_need(arg[1])
+            snapshot.append(' '.join(arg))
+
+        path = pathjoin(self.root, SNAPSHOT_PATH)
+        f = open(path, 'wt', encoding='utf-8')
+        try:
+            f.write('\n'.join(snapshot))
+        finally:
+            f.close()

=== modified file 'setup.py'
--- setup.py	2010-03-18 12:25:55 +0000
+++ setup.py	2023-01-11 14:30:26 +0000
@@ -22,7 +22,7 @@
 bzr_plugin_name = __init__.plugin_name
 bzr_commands = ['externals-add', 'externals-command']
 bzr_plugin_version = __init__.version_info
-bzr_minimum_version = (1, 4, 0)
+bzr_minimum_version = (3, 0, 0)
 bzr_maximum_version = None
 
 if __name__ == '__main__':
@@ -34,5 +34,5 @@
           author_email="[e-mail]",
           license="GNU GPL v2",
           url="https://launchpad.net/bzr-externals",
-          packages=['bzrlib.plugins.externals', ],
-          package_dir={'bzrlib.plugins.externals': '.'})
+          packages=['breezy.plugins.externals', ],
+          package_dir={'breezy.plugins.externals': '.'})