Merge pull request #35 from purduesigbots/BetterProjects

Closes #19 : Better Project Creation

Author: edjubuh

proscli/conductor.py

@@ -326,9 +326,11 @@ def download(cfg, name, version, depot, no_check):
 @click.argument('location')
 @click.argument('kernel', default='latest')
 @click.argument('depot', default='auto')
-@click.option('--verify-only', is_flag=True, default=False)
+@click.option('--force', 'mode', flag_value='force')
+@click.option('--safe', 'mode', flag_value='safe')
+@click.option('--default', 'mode', flag_value='default', default=True)
 @default_cfg
-def new(cfg, kernel, location, depot, verify_only):
+def new(cfg, kernel, location, depot, mode):
     first_run(cfg)
     templates = local.get_local_templates(pros_cfg=cfg.pros_cfg,
                                           template_types=[TemplateTypes.kernel])  # type: Set[Identifier]
@@ -362,7 +364,8 @@ def new(cfg, kernel, location, depot, verify_only):
     if not os.path.isabs(location):
         location = os.path.abspath(location)
     click.echo('Creating new project from {} on {} at {}'.format(template.version, template.depot, location))
-    local.create_project(identifier=template, dest=location, pros_cli=cfg.pros_cfg)
+    local.create_project(identifier=template, dest=location, pros_cli=cfg.pros_cfg,
+                         require_empty=(mode == 'safe'), overwrite=(mode == 'force'))
 
 
 @conduct.command('upgrade', aliases=['update'], help='Upgrades a PROS project')

prosconductor/providers/local.py

@@ -11,7 +11,7 @@
 import sys
 # from typing import Set, List
 
-def copytree(src, dst, symlinks=False, ignore=None, copy_function=shutil.copy2,
+def copytree(src, dst, symlinks=False, ignore=None, overwrite=False, copy_function=shutil.copy2,
              ignore_dangling_symlinks=False):
     """Modified shutil.copytree, but with exist_ok=True
     """
@@ -43,15 +43,30 @@ def copytree(src, dst, symlinks=False, ignore=None, copy_function=shutil.copy2,
                         continue
                     # otherwise let the copy occurs. copy2 will raise an error
                     if os.path.isdir(srcname):
-                        copytree(srcname, dstname, symlinks, ignore,
-                                 copy_function)
+                        copytree(srcname, dstname, symlinks, ignore, overwrite=overwrite,
+                                 copy_function=copy_function)
                     else:
-                        copy_function(srcname, dstname)
+                        if os.path.exists(dstname):
+                            if overwrite:
+                                click.echo('Overwriting {}'.format(dstname))
+                                copy_function(srcname, dstname)
+                            else:
+                                click.echo('Skipping {} because it already exists'.format(dstname))
+                        else:
+                            copy_function(srcname, dstname)
             elif os.path.isdir(srcname):
-                copytree(srcname, dstname, symlinks, ignore, copy_function)
+                copytree(srcname, dstname, symlinks, ignore, overwrite=overwrite,
+                         copy_function=copy_function)
             else:
                 # Will raise a SpecialFileError for unsupported file types
-                copy_function(srcname, dstname)
+                if os.path.exists(dstname):
+                    if overwrite:
+                        click.echo('Overwriting {}'.format(dstname))
+                        copy_function(srcname, dstname)
+                    else:
+                        click.echo('Skipping {} because it already exists'.format(dstname))
+                else:
+                    copy_function(srcname, dstname)
         # catch the Error from the recursive copytree so that we can
         # continue with other files
         except shutil.Error as err:
@@ -99,7 +114,7 @@ def create_template(identifier, location=None, pros_cli=None):
     return config
 
 
-def create_project(identifier, dest, pros_cli=None):
+def create_project(identifier, dest, pros_cli=None, require_empty=False, overwrite=False):
     if pros_cli is None or not pros_cli:
         pros_cli = CliConfig()
     filename = os.path.join(pros_cli.directory, identifier.depot,
@@ -109,12 +124,13 @@ def create_project(identifier, dest, pros_cli=None):
         click.echo('Error: template.pros not found for {}-{}'.format(identifier.name, identifier.version))
         click.get_current_context().abort()
         sys.exit()
-    if os.path.isfile(dest) or (os.path.isdir(dest) and len(os.listdir(dest)) > 0):
-        click.echo('Error! Destination is a file or a nonempty directory! Delete the file(s) and try again.')
-        click.get_current_context().abort()
-        sys.exit()
+    if require_empty:
+        if os.path.isfile(dest) or (os.path.isdir(dest) and len(os.listdir(dest)) > 0):
+            click.echo('Error! Destination is a file or a nonempty directory! Delete the file(s) and try again.')
+            click.get_current_context().abort()
+            sys.exit()
     config = TemplateConfig(file=filename)
-    copytree(config.directory, dest)
+    copytree(config.directory, dest, overwrite=overwrite)
     for root, dirs, files in os.walk(dest):
         for d in dirs:
             d = os.path.relpath(os.path.join(root, d), dest)
@@ -171,7 +187,7 @@ def upgrade_project(identifier, dest, pros_cli=None):
     proj_config.save()
 
 
-def install_lib(identifier, dest, pros_cli):
+def install_lib(identifier, dest, pros_cli, overwrite=False):
     if pros_cli is None or not pros_cli:
         pros_cli = CliConfig()
     filename = os.path.join(pros_cli.directory, identifier.depot,
@@ -183,7 +199,7 @@ def install_lib(identifier, dest, pros_cli):
         sys.exit()
     proj_config = prosconfig.ProjectConfig(dest)
     config = TemplateConfig(file=filename)
-    copytree(config.directory, dest)
+    copytree(config.directory, dest, overwrite=overwrite)
     for root, dirs, files in os.walk(dest):
         for d in dirs:
             if any([fnmatch.fnmatch(d, p) for p in config.template_ignore]):