git-project 0.0.27__tar.gz → 0.0.28__tar.gz

git_project-0.0.28/.#pyproject.toml

@@ -0,0 +1 @@
+dag@basie.2617:1746908671

git_project-0.0.28/.git

@@ -0,0 +1 @@
+gitdir: /home/dag/src/git-project/.git/worktrees/dev/

{git_project-0.0.27 → git_project-0.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-project
-Version: 0.0.27
+Version: 0.0.28
 Summary: The extensible stupid project manager
 Author-email: "David A. Greene" <dag@obbligato.org>
 License-Expression: AGPL-3.0-or-later

{git_project-0.0.27 → git_project-0.0.28}/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.27'
-__version_tuple__ = version_tuple = (0, 0, 27)
+__version__ = version = '0.0.28'
+__version_tuple__ = version_tuple = (0, 0, 28)

{git_project-0.0.27 → git_project-0.0.28}/src/git_project/substitutable.py

@@ -119,7 +119,17 @@ class SubstitutableConfigObject(ConfigObject):
                 value = scope.get_ident()
                 formats[key] = value
 
+        # Allow escaping braces by surrounding each brace with braces.  This is
+        # not valid f-string syntax and is unlikely to be used in ordinary
+        # config values.  Replace with an equally unlikely sequence, then
+        # substitute on that string.
+
+        escaped_braces = False
         while True:
+            escaped_braces = escaped_braces or '{{}' in string or '{}}' in string
+            if escaped_braces:
+                string = string.replace('{{}', '[[[')
+                string = string.replace('{}}', ']]]')
             try:
                 newstring = try_format(string, formats)
             except KeyError as exception:
@@ -140,6 +150,9 @@ class SubstitutableConfigObject(ConfigObject):
             changed = False if newstring == string else True
             string = newstring
             if not changed:
+                if escaped_braces:
+                    string = string.replace('[[[', '{')
+                    string = string.replace(']]]', '}')
                 break
 
         return string

git_project-0.0.28/test.out

@@ -0,0 +1,131 @@
+============================= test session starts ==============================
+platform linux -- Python 3.11.9, pytest-8.2.2, pluggy-1.5.0
+rootdir: /home/dag/src/git-project/dev
+configfile: pyproject.toml
+plugins: anyio-4.3.0, console-scripts-1.4.1
+collected 106 items
+
+tests/test_confobj.py ............                                       [ 11%]
+tests/test_git.py .......................FF............................  [ 61%]
+tests/test_gitproject.py ..                                              [ 63%]
+tests/test_main.py .                                                     [ 64%]
+tests/test_project.py ...........                                        [ 74%]
+tests/test_runnable.py ........                                          [ 82%]
+tests/test_scopedobj.py .....                                            [ 86%]
+tests/test_substitutable.py ..............                               [100%]
+
+=================================== FAILURES ===================================
+________________________________ test_git_clone ________________________________
+
+reset_directory = None
+remote_repository = pygit2.Repository('/tmp/pytest-of-dag/pytest-14/local_remote_test_git_clone.git0/')
+tmp_path_factory = TempPathFactory(_given_basetemp=None, _trace=<pluggy._tracing.TagTracerSub object at 0x7ff199ba1e50>, _basetemp=PosixPath('/tmp/pytest-of-dag/pytest-14'), _retention_count=3, _retention_policy='all')
+
+    def test_git_clone(reset_directory, remote_repository, tmp_path_factory):
+        path = tmp_path_factory.mktemp('clone-workdir')
+    
+        os.chdir(path)
+    
+        git = git_project.Git()
+    
+        remote_url = 'file://' + remote_repository.path
+    
+>       clone_path = git.clone(remote_url)
+
+/home/dag/src/git-project/dev/tests/test_git.py:441: 
+_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
+/home/dag/src/git-project/dev/src/git_project/git.py:744: in clone
+    self._repo = pygit2.clone_repository(url, target_path, bare, callbacks=callbacks)
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/__init__.py:217: in clone_repository
+    payload.check_error(err)
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/callbacks.py:93: in check_error
+    raise self._stored_exception
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/callbacks.py:424: in wrapper
+    return f(*args)
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/callbacks.py:552: in _transfer_progress_cb
+    transfer_progress(TransferProgress(stats_ptr))
+_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
+
+self = <git_project.git.Git.RemoteCallbacks object at 0x7ff199a06950>
+stats = <pygit2.remotes.TransferProgress object at 0x7ff199a9f790>
+
+    def transfer_progress(self, stats):
+        if not self.started_transfer:
+            self.started_transfer = True
+            print(f'Receiving objects ({stats.total_objects})...')
+>           self.progress.start(max_value=stats.total_objects)
+E           TypeError: ProgressBar.start() got an unexpected keyword argument 'max_value'
+
+/home/dag/src/git-project/dev/src/git_project/git.py:77: TypeError
+----------------------------- Captured stdout call -----------------------------
+Remote: Counting objects 1
+Remote: Counting objects 9
+Remote: Counting objects 14
+Remote: Counting objects 14
+
+Remote: Compressing objects: 0% (0/14)
+Remote: Compressing objects: 100% (14/14), done
+
+Receiving objects (14)...
+___________________________ test_git_clone_with_path ___________________________
+
+reset_directory = None
+remote_repository = pygit2.Repository('/tmp/pytest-of-dag/pytest-14/local_remote_test_git_clone_with_path.git0/')
+tmp_path_factory = TempPathFactory(_given_basetemp=None, _trace=<pluggy._tracing.TagTracerSub object at 0x7ff199ba1e50>, _basetemp=PosixPath('/tmp/pytest-of-dag/pytest-14'), _retention_count=3, _retention_policy='all')
+
+    def test_git_clone_with_path(reset_directory,
+                                 remote_repository,
+                                 tmp_path_factory):
+        path = tmp_path_factory.mktemp('clone-workdir')
+        os.chdir(path)
+    
+        git = git_project.Git()
+    
+        remote_url = 'file://' + remote_repository.path
+    
+        path = Path.cwd() / 'foo' / 'bar'
+    
+        os.makedirs(path)
+    
+        path = path / 'test-clone'
+    
+>       clone_path = git.clone(remote_url, path)
+
+/home/dag/src/git-project/dev/tests/test_git.py:482: 
+_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
+/home/dag/src/git-project/dev/src/git_project/git.py:744: in clone
+    self._repo = pygit2.clone_repository(url, target_path, bare, callbacks=callbacks)
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/__init__.py:217: in clone_repository
+    payload.check_error(err)
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/callbacks.py:93: in check_error
+    raise self._stored_exception
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/callbacks.py:424: in wrapper
+    return f(*args)
+/home/dag/.virtualenvs/dev/lib/python3.11/site-packages/pygit2/callbacks.py:552: in _transfer_progress_cb
+    transfer_progress(TransferProgress(stats_ptr))
+_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
+
+self = <git_project.git.Git.RemoteCallbacks object at 0x7ff198a8e350>
+stats = <pygit2.remotes.TransferProgress object at 0x7ff198a8eb10>
+
+    def transfer_progress(self, stats):
+        if not self.started_transfer:
+            self.started_transfer = True
+            print(f'Receiving objects ({stats.total_objects})...')
+>           self.progress.start(max_value=stats.total_objects)
+E           TypeError: ProgressBar.start() got an unexpected keyword argument 'max_value'
+
+/home/dag/src/git-project/dev/src/git_project/git.py:77: TypeError
+----------------------------- Captured stdout call -----------------------------
+Remote: Counting objects 1
+Remote: Counting objects 14
+Remote: Counting objects 14
+
+Remote: Compressing objects: 0% (0/14)
+Remote: Compressing objects: 100% (14/14), done
+
+Receiving objects (14)...
+=========================== short test summary info ============================
+FAILED tests/test_git.py::test_git_clone - TypeError: ProgressBar.start() got...
+FAILED tests/test_git.py::test_git_clone_with_path - TypeError: ProgressBar.s...
+======================== 2 failed, 104 passed in 2.74s =========================

{git_project-0.0.27 → git_project-0.0.28}/tests/test_substitutable.py

@@ -502,3 +502,43 @@ def test_substitutable_substitute_git_workdir(reset_directory, git):
                                              substitutable.command)
 
     assert command == f'cd {git.get_working_copy_root()}/path/to/build/{git.get_current_branch()} && make {project.target}'
+
+def test_substitutable_substitute_escaped_braces(reset_directory, git):
+    class MyProject(git_project.ScopedConfigObject):
+        def __init__(self):
+            super().__init__(git,
+                             'project',
+                             None,
+                             'myproject',
+                             builddir='{git_workdir}/{{}path{}}/to/build',
+                             target='debug')
+
+    substitutable = MySubstitutable.get(git, 'project', 'test')
+
+    project = MyProject()
+
+    command = substitutable.substitute_value(git,
+                                             project,
+                                             substitutable.command)
+
+    assert command == f'cd {git.get_working_copy_root()}/{{path}}/to/build/{git.get_current_branch()} && make {project.target}'
+
+def test_substitutable_substitute_preserve_escaped_braces(reset_directory, git):
+    class MyProject(git_project.ScopedConfigObject):
+        def __init__(self):
+            super().__init__(git,
+                             'project',
+                             None,
+                             'myproject',
+                             builddir='{git_workdir}/{{}{{}{}}path{{}{}}{}}/to/build',
+                             target='debug')
+
+    substitutable = MySubstitutable.get(git, 'project', 'test')
+
+    project = MyProject()
+
+    command = substitutable.substitute_value(git,
+                                             project,
+                                             substitutable.command)
+
+    assert command == f'cd {git.get_working_copy_root()}/{{{{}}path{{}}}}/to/build/{git.get_current_branch()} && make {project.target}'

git_project-0.0.27/.git

@@ -1 +0,0 @@
-gitdir: /Users/dag/projects/git-project/.git/worktrees/master/

git_project-0.0.27/build/lib/git_project/__init__.py

@@ -1,33 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright 2020 David A. Greene
-#
-# 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 3 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, see <https://www.gnu.org/licenses/>.
-#
-
-from .commandline import parse_arguments, add_top_level_command
-from .commandline import get_or_add_top_level_command
-from .configobj import ConfigObject
-from .exception import GitProjectException
-from .git import Git
-from .gitproject import GitProject
-from .main import main_impl
-from .parsermanager import ParserManager
-from .plugin import Plugin
-from .pluginmanager import PluginManager
-from .project import Project
-from .runnable import RunnableConfigObject
-from .scopedobj import ScopedConfigObject
-from .substitutable import SubstitutableConfigObject
-from .shell import run_command_with_shell, iter_command, capture_command

git_project-0.0.27/build/lib/git_project/commandline.py

@@ -1,164 +0,0 @@
-#!/usr/bin/env python3
-#
-# Copyright 2020 David A. Greene
-#
-# 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 3 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, see <https://www.gnu.org/licenses/>.
-#
-"""git-project: Manage project work.
-
-Summary:
-
-git project <command> [<options>]
-
-Commands are registered by plugins and show with 'git project --help.'  Each
-command also has a --help option to explore workings of th command.
-
-Users may link to git-project with a name appropriate to the project (for
-example, git-fizzbin to invoke as 'git fizzbin <command> [<options>]).
-git-project will then place all configuration in a section named after the link
-('fizzbin' in this case).  This way one may have multiple projects active in a
-single repository by invoking git-project via various links.
-
-"""
-
-import argparse
-import getpass
-import io
-import os
-from pathlib import Path
-import pygit2
-import re
-import shlex
-import subprocess
-import sys
-import urllib.parse
-
-try:
-    from importlib import metadata
-except ImportError:
-    # Running on pre-3.8 Python; use importlib-metadata package
-    import importlib_metadata as metadata
-
-from .parsermanager import ParserManager
-
-def get_version_string(package):
-    version = metadata.version(package)
-
-    return f'{package} version {version}'
-
-def add_version_argument(parser, package):
-    parser.add_argument('--version',
-                        action='version',
-                        version=get_version_string(package),
-                        help='Print version')
-
-def parse_arguments(git, gitproject, project, plugin_manager, args):
-    """Register plugin comand-line arguments.  Parse command-link arguments and
-    invoke command functions.
-
-    git: Git object to examine the repository.
-
-    gitproject: GitProject object to provide cross-project configuration.
-
-    project: Project object to provide project-specific configuration.
-
-    plugin_manager: A manager holding available plugins.
-
-    """
-    parser_manager = ParserManager(gitproject, project)
-
-    parser = parser_manager.find_parser('__main__')
-
-    # --version
-    add_version_argument(parser, 'git-project')
-
-    command_subparser = parser_manager.add_subparser(parser,
-                                                     'command',
-                                                     dest='command',
-                                                     help='commands')
-    command_subparser.required = True
-
-    for plugin in plugin_manager.iterplugins():
-        plugin.add_arguments(git,
-                             gitproject,
-                             project,
-                             parser_manager,
-                             plugin_manager)
-
-    # Once all plugins have added arguments, give them a chance to modify
-    # arguments other plugsin may have added.
-    for plugin in plugin_manager.iterplugins():
-        plugin.modify_arguments(git,
-                                gitproject,
-                                project,
-                                parser_manager,
-                                plugin_manager)
-
-    clargs = parser_manager.parse_args(args)
-
-    if not hasattr(clargs, 'func'):
-        parser_manager.error()
-        sys.exit(1)
-
-    return clargs
-
-def add_top_level_command(parser_manager,
-                          name,
-                          key,
-                          **kwargs):
-    """Create a top-level command.  Throw an exception if the command already
-    exists.
-
-    parser_manager - The active ParserManager.
-
-    name - The name of the command to be invoked.
-
-    key - A unique identifier for the created parser.
-
-    kwargs - Passthrough to argparse parser.
-
-    """
-
-    command_subparser = parser_manager.find_subparser('command')
-    assert command_subparser
-    parser = parser_manager.add_parser(command_subparser,
-                                       name,
-                                       key,
-                                       **kwargs)
-
-    return parser
-
-def get_or_add_top_level_command(parser_manager,
-                                 name,
-                                 key,
-                                 **kwargs):
-    """Retrieve a top-level command parser or create one if none exists.
-
-    parser_manager - The active ParserManager.
-
-    name - The name of the command to be invoked.
-
-    key - A unique identifier for the created parser.
-
-    kwargs - Passthrough to argparse parser.
-
-    """
-
-    parser = parser_manager.find_parser(key)
-    if not parser:
-        parser = add_top_level_command(parser_manager,
-                                       name,
-                                       key,
-                                       **kwargs)
-    return parser