diff options
author | Armin Ronacher <armin.ronacher@active-4.com> | 2014-05-06 23:54:53 +0200 |
---|---|---|
committer | Armin Ronacher <armin.ronacher@active-4.com> | 2014-05-06 23:54:53 +0200 |
commit | ca1dff925e3a3d3aac0b5725ee5e8b5b022d70ff (patch) | |
tree | 297c1f48e88cef49bc725a351631c350e3265566 /examples/repo | |
parent | dad85018d095f7d40eff09ab0ed55ec69837f44f (diff) | |
download | click-ca1dff925e3a3d3aac0b5725ee5e8b5b022d70ff.tar.gz |
Updated repo script a bit
Diffstat (limited to 'examples/repo')
-rw-r--r-- | examples/repo/repo.py | 101 |
1 files changed, 77 insertions, 24 deletions
diff --git a/examples/repo/repo.py b/examples/repo/repo.py index 33b4400..e5687d8 100644 --- a/examples/repo/repo.py +++ b/examples/repo/repo.py @@ -1,4 +1,7 @@ import os +import sys +import posixpath + import click @@ -6,6 +9,13 @@ class Repo(object): def __init__(self, home): self.home = home + self.config = {} + self.verbose = False + + def set_config(self, key, value): + self.config[key] = value + if self.verbose: + click.echo(' config[%s] = %s' % (key, value), file=sys.stderr) def __repr__(self): return '<Repo %r>' % self.home @@ -15,14 +25,28 @@ pass_repo = click.make_pass_decorator(Repo) @click.group() -@click.option('--repo-home', envvar='REPO_HOME', default='.repo') +@click.option('--repo-home', envvar='REPO_HOME', default='.repo', + metavar='PATH', help='Changes the repository folder location.') +@click.option('--config', nargs=2, multiple=True, + metavar='KEY VALUE', help='Overrides a config key/value pair.') +@click.option('--verbose', '-v', is_flag=True, + help='Enables verbose mode.') +@click.version_option('1.0') @click.pass_context -def cli(ctx, repo_home): +def cli(ctx, repo_home, config, verbose): """Repo is a command line tool that showcases how to build complex command line interfaces with Click. + + This tool is supposed to look like a distributed version control + system to show how something like this can be structured. """ - # Create a repo object and remember it as as the context object. + # Create a repo object and remember it as as the context object. From + # this point onwards other commands can refer to it by using the + # @pass_repo decorator. ctx.obj = Repo(os.path.abspath(repo_home)) + ctx.obj.verbose = verbose + for key, value in config: + ctx.obj.set_config(key, value) @cli.command() @@ -30,20 +54,23 @@ def cli(ctx, repo_home): @click.argument('dest', required=False) @click.option('--shallow/--deep', default=False, help='Makes a checkout shallow or deep. Deep by default.') -@click.option('--with-readline/--without-readline', default=False, - help='Makes a checkout shallow or deep. Deep by default.') +@click.option('--rev', '-r', default='HEAD', + help='Clone a specific revision instead of HEAD.') @pass_repo -def clone(repo, src, dest, shallow): +def clone(repo, src, dest, shallow, rev): """Clones a repository. This will clone the repository at SRC into the folder DEST. If DEST is not provided this will automatically use the last path component of SRC and create that folder. """ - print('Repo: %s' % repo) - print('Source: %s' % src) - print('Destination: %s' % dest) - print('Shallow: %s' % shallow) + if dest is None: + dest = posixpath.split(src)[-1] or '.' + click.echo('Cloning repo %s to %s' % (src, os.path.abspath(dest))) + repo.home = dest + if shallow: + click.echo('Making shallow checkout') + click.echo('Checking out revision %s' % rev) @cli.command() @@ -54,30 +81,56 @@ def delete(repo): This will throw away the current repository. """ - print('Repo: %s' % repo) - print('Deleted') + click.echo('Destroying repo %s' % repo.home) + click.echo('Deleted!') @cli.command() -@click.option('--username', prompt=True, required=True) -@click.option('--email', prompt='E-Mail', required=True) -@click.password_option() +@click.option('--username', prompt=True, + help='The developer\'s shown username.') +@click.option('--email', prompt='E-Mail', + help='The developer\'s email address') +@click.password_option(help='The login password.') @pass_repo def setuser(repo, username, email, password): """Sets the user credentials. This will override the current user config. """ - print('Repo: %s' % repo) - print('Username: %s' % username) - print('E-Mail: %s' % email) - print('Password: %s' % ('*' * len(password))) + repo.set_config('username', username) + repo.set_config('email', email) + repo.set_config('password', '*' * len(password)) + click.echo('Changed credentials.') @cli.command() -@click.option('--message', '-m', required=True, multiple=True) +@click.option('--message', '-m', required=True, multiple=True, + help='The commit message. If provided multiple times each ' + 'argument gets converted into a new line.') +@click.argument('files', nargs=-1) @pass_repo -def commit(repo, message): - """Commits outstanding changes.""" - print('Repo: %s' % repo) - print('\n'.join(message)) +def commit(repo, files, message): + """Commits outstanding changes. + + Commit changes to the given files into the repository. You will need to + "repo push" to push up your changes to other repositories. + + If a list of files is omitted, all changes reported by "repo status" + will be committed. + """ + click.echo('Files to be committed: %s' % (files,)) + click.echo('Commit message:\n' + '\n'.join(message)) + + +@cli.command(short_help='Copies files.') +@click.option('--force', is_flag=True, + help='forcibly copy over an existing managed file') +@click.argument('src', nargs=-1) +@click.argument('dst') +@pass_repo +def copy(repo, src, dst): + """Copies one or multiple files to a new location. This copies all + files from SRC to DST. + """ + for fn in src: + click.echo('Copy from %s -> %s' % (src, dst)) |