From 589a398c2a538f7f58775d1a841249540ac7134a Mon Sep 17 00:00:00 2001 From: Igor Stroh Date: Wed, 10 Jun 2015 22:13:54 +0200 Subject: handle conflicting project names gracefully, fixes: #1357 - Check for importable packages/modules with the same name as the package to be created - Added --force-conflicting-name option to enforce the use of a conflicting package - Added appropriate tests --- pyramid/scripts/pcreate.py | 103 +++++++++++++++++++++++------ pyramid/tests/test_scripts/test_pcreate.py | 46 ++++++++++++- 2 files changed, 129 insertions(+), 20 deletions(-) diff --git a/pyramid/scripts/pcreate.py b/pyramid/scripts/pcreate.py index f6376f575..5ef0ac2d5 100644 --- a/pyramid/scripts/pcreate.py +++ b/pyramid/scripts/pcreate.py @@ -13,7 +13,21 @@ _bad_chars_re = re.compile('[^a-zA-Z0-9_]') def main(argv=sys.argv, quiet=False): command = PCreateCommand(argv, quiet) - return command.run() + try: + return command.run() + except KeyboardInterrupt: # pragma: no cover + return 1 + + +class InvalidInputError(Exception): + """ This is raised in case a project name is + missing or a scaffold name was omitted. + """ + pass + +class ExistingProjectNameError(InvalidInputError): + pass + class PCreateCommand(object): verbosity = 1 # required @@ -52,6 +66,13 @@ class PCreateCommand(object): dest='interactive', action='store_true', help='When a file would be overwritten, interrogate') + parser.add_option('--force-conflicting-name', + dest='force_bad_name', + action='store_true', + default=False, + help='Do create a project even if the chosen name ' + 'is the name of an already existing / importable ' + 'package.') pyramid_dist = pkg_resources.get_distribution("pyramid") @@ -69,25 +90,21 @@ class PCreateCommand(object): self.out('') self.show_scaffolds() return 2 - if not self.options.scaffold_name: - self.out('You must provide at least one scaffold name: -s ') - self.out('') - self.show_scaffolds() - return 2 - if not self.args: - self.out('You must provide a project name') - return 2 - available = [x.name for x in self.scaffolds] - diff = set(self.options.scaffold_name).difference(available) - if diff: - self.out('Unavailable scaffolds: %s' % list(diff)) + + if not self.validate_input(): return 2 + return self.render_scaffolds() - def render_scaffolds(self): + @property + def output_path(self): + return os.path.abspath(os.path.normpath(self.args[0])) + + @property + def project_vars(self): options = self.options args = self.args - output_dir = os.path.abspath(os.path.normpath(args[0])) + output_dir = self.output_path project_name = os.path.basename(os.path.split(output_dir)[1]) pkg_name = _bad_chars_re.sub( '', project_name.lower().replace('-', '_')) @@ -111,17 +128,22 @@ class PCreateCommand(object): else: pyramid_docs_branch = 'latest' - vars = { + return { 'project': project_name, 'package': pkg_name, 'egg': egg_name, 'pyramid_version': pyramid_version, 'pyramid_docs_branch': pyramid_docs_branch, - } - for scaffold_name in options.scaffold_name: + } + + + def render_scaffolds(self): + props = self.project_vars + output_dir = self.output_path + for scaffold_name in self.options.scaffold_name: for scaffold in self.scaffolds: if scaffold.name == scaffold_name: - scaffold.run(self, output_dir, vars) + scaffold.run(self, output_dir, props) return 0 def show_scaffolds(self): @@ -154,5 +176,48 @@ class PCreateCommand(object): if not self.quiet: print(msg) + def validate_input(self): + if not self.options.scaffold_name: + self.out('You must provide at least one scaffold name: -s ') + self.out('') + self.show_scaffolds() + return False + if not self.args: + self.out('You must provide a project name') + return False + available = [x.name for x in self.scaffolds] + diff = set(self.options.scaffold_name).difference(available) + if diff: + self.out('Unavailable scaffolds: %s' % ", ".join(list(diff))) + return False + + pkg_name = self.project_vars['package'] + + if pkg_name == 'site' and not self.options.force_bad_name: + self.out('The package name "site" has a special meaning in ' + 'Python. Are you sure you want to use it as your ' + 'project\'s name?') + return self.confirm_bad_name('Really use "{}"?: '.format(pkg_name)) + + # check if pkg_name can be imported (i.e. already exists in current + # $PYTHON_PATH, if so - let the user confirm + pkg_exists = True + try: + __import__(pkg_name, globals(), locals(), [], 0) # use absolute imports + except ImportError as error: + pkg_exists = False + if not pkg_exists: + return True + + if self.options.force_bad_name: + return True + self.out('Package "{}" already exists, are you sure you want ' + 'to use it as your project\'s name?'.format(pkg_name)) + return self.confirm_bad_name('Really use "{}"?: '.format(pkg_name)) + + def confirm_bad_name(self, prompt): # pragma: no cover + answer = raw_input('{} [y|N]: '.format(prompt)) + return answer.strip().lower() == 'y' + if __name__ == '__main__': # pragma: no cover sys.exit(main() or 0) diff --git a/pyramid/tests/test_scripts/test_pcreate.py b/pyramid/tests/test_scripts/test_pcreate.py index 63e5e6368..8fc9c1267 100644 --- a/pyramid/tests/test_scripts/test_pcreate.py +++ b/pyramid/tests/test_scripts/test_pcreate.py @@ -1,5 +1,6 @@ import unittest + class TestPCreateCommand(unittest.TestCase): def setUp(self): from pyramid.compat import NativeIO @@ -15,7 +16,8 @@ class TestPCreateCommand(unittest.TestCase): def _makeOne(self, *args, **kw): effargs = ['pcreate'] effargs.extend(args) - cmd = self._getTargetClass()(effargs, **kw) + tgt_class = kw.pop('target_class', self._getTargetClass()) + cmd = tgt_class(effargs, **kw) cmd.out = self.out return cmd @@ -220,6 +222,48 @@ class TestPCreateCommand(unittest.TestCase): 'pyramid_version': '0.10.1dev', 'pyramid_docs_branch': 'master'}) + def test_confirm_override_conflicting_name(self): + from pyramid.scripts.pcreate import PCreateCommand + class YahInputPCreateCommand(PCreateCommand): + def confirm_bad_name(self, pkg_name): + return True + cmd = self._makeOne('-s', 'dummy', 'Unittest', target_class=YahInputPCreateCommand) + scaffold = DummyScaffold('dummy') + cmd.scaffolds = [scaffold] + cmd.pyramid_dist = DummyDist("0.10.1dev") + result = cmd.run() + self.assertEqual(result, 0) + self.assertEqual( + scaffold.vars, + {'project': 'Unittest', 'egg': 'Unittest', 'package': 'unittest', + 'pyramid_version': '0.10.1dev', + 'pyramid_docs_branch': 'master'}) + + def test_force_override_conflicting_name(self): + cmd = self._makeOne('-s', 'dummy', 'Unittest', '--force-conflicting-name') + scaffold = DummyScaffold('dummy') + cmd.scaffolds = [scaffold] + cmd.pyramid_dist = DummyDist("0.10.1dev") + result = cmd.run() + self.assertEqual(result, 0) + self.assertEqual( + scaffold.vars, + {'project': 'Unittest', 'egg': 'Unittest', 'package': 'unittest', + 'pyramid_version': '0.10.1dev', + 'pyramid_docs_branch': 'master'}) + + def test_force_override_site_name(self): + from pyramid.scripts.pcreate import PCreateCommand + class NayInputPCreateCommand(PCreateCommand): + def confirm_bad_name(self, pkg_name): + return False + cmd = self._makeOne('-s', 'dummy', 'Site', target_class=NayInputPCreateCommand) + scaffold = DummyScaffold('dummy') + cmd.scaffolds = [scaffold] + cmd.pyramid_dist = DummyDist("0.10.1dev") + result = cmd.run() + self.assertEqual(result, 2) + class Test_main(unittest.TestCase): def _callFUT(self, argv): -- cgit v1.2.3 From 08110f881e2fc29f48d1983c1f86a4e3b65ba8c3 Mon Sep 17 00:00:00 2001 From: Igor Stroh Date: Wed, 10 Jun 2015 22:18:14 +0200 Subject: removed unused exceptions --- pyramid/scripts/pcreate.py | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/pyramid/scripts/pcreate.py b/pyramid/scripts/pcreate.py index 5ef0ac2d5..b59c1d8b4 100644 --- a/pyramid/scripts/pcreate.py +++ b/pyramid/scripts/pcreate.py @@ -19,16 +19,6 @@ def main(argv=sys.argv, quiet=False): return 1 -class InvalidInputError(Exception): - """ This is raised in case a project name is - missing or a scaffold name was omitted. - """ - pass - -class ExistingProjectNameError(InvalidInputError): - pass - - class PCreateCommand(object): verbosity = 1 # required description = "Render Pyramid scaffolding to an output directory" -- cgit v1.2.3 From e7a731c1dc6d6e56acf978c44ad9e4f095695b8d Mon Sep 17 00:00:00 2001 From: Igor Stroh Date: Wed, 10 Jun 2015 22:37:57 +0200 Subject: make sure user input is py2.x/py3 compatible - Use input() in python3 and raw_input in python 2.x - Remoced unused local variables --- pyramid/scaffolds/__init__.py | 4 ---- pyramid/scripts/pcreate.py | 8 ++++---- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/pyramid/scaffolds/__init__.py b/pyramid/scaffolds/__init__.py index c993ce5f9..4e811a42b 100644 --- a/pyramid/scaffolds/__init__.py +++ b/pyramid/scaffolds/__init__.py @@ -18,10 +18,6 @@ class PyramidTemplate(Template): misnamings (such as naming a package "site" or naming a package logger "root". """ - if vars['package'] == 'site': - raise ValueError('Sorry, you may not name your package "site". ' - 'The package name "site" has a special meaning in ' - 'Python. Please name it anything except "site".') vars['random_string'] = native_(binascii.hexlify(os.urandom(20))) package_logger = vars['package'] if package_logger == 'root': diff --git a/pyramid/scripts/pcreate.py b/pyramid/scripts/pcreate.py index b59c1d8b4..2c05d87b2 100644 --- a/pyramid/scripts/pcreate.py +++ b/pyramid/scripts/pcreate.py @@ -9,6 +9,8 @@ import pkg_resources import re import sys +user_input = input if sys.version_info[0] == 3 else raw_input + _bad_chars_re = re.compile('[^a-zA-Z0-9_]') def main(argv=sys.argv, quiet=False): @@ -92,8 +94,6 @@ class PCreateCommand(object): @property def project_vars(self): - options = self.options - args = self.args output_dir = self.output_path project_name = os.path.basename(os.path.split(output_dir)[1]) pkg_name = _bad_chars_re.sub( @@ -202,11 +202,11 @@ class PCreateCommand(object): if self.options.force_bad_name: return True self.out('Package "{}" already exists, are you sure you want ' - 'to use it as your project\'s name?'.format(pkg_name)) + 'to use it as your project\'s name?'.format(pkg_name)) return self.confirm_bad_name('Really use "{}"?: '.format(pkg_name)) def confirm_bad_name(self, prompt): # pragma: no cover - answer = raw_input('{} [y|N]: '.format(prompt)) + answer = user_input('{} [y|N]: '.format(prompt)) return answer.strip().lower() == 'y' if __name__ == '__main__': # pragma: no cover -- cgit v1.2.3 From 7dc81f082adba97effc3ce3726e453ec71e841b7 Mon Sep 17 00:00:00 2001 From: Igor Stroh Date: Wed, 10 Jun 2015 23:11:42 +0200 Subject: added py2.6 compatibility, removed test for 'site' - Made sure str.format() calls are py2.6 compatible - Removed test_scaffolds/test_init.py#test_pre_site since the check is handled in pcreate script --- pyramid/scripts/pcreate.py | 13 ++++++++----- pyramid/tests/test_scaffolds/test_init.py | 5 ----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/pyramid/scripts/pcreate.py b/pyramid/scripts/pcreate.py index 2c05d87b2..881aacac3 100644 --- a/pyramid/scripts/pcreate.py +++ b/pyramid/scripts/pcreate.py @@ -9,7 +9,10 @@ import pkg_resources import re import sys -user_input = input if sys.version_info[0] == 3 else raw_input +if sys.version_info[0] == 3: + user_input = input # pragma: no cover +else: + user_input = raw_input # NOQA _bad_chars_re = re.compile('[^a-zA-Z0-9_]') @@ -187,7 +190,7 @@ class PCreateCommand(object): self.out('The package name "site" has a special meaning in ' 'Python. Are you sure you want to use it as your ' 'project\'s name?') - return self.confirm_bad_name('Really use "{}"?: '.format(pkg_name)) + return self.confirm_bad_name('Really use "{0}"?: '.format(pkg_name)) # check if pkg_name can be imported (i.e. already exists in current # $PYTHON_PATH, if so - let the user confirm @@ -201,12 +204,12 @@ class PCreateCommand(object): if self.options.force_bad_name: return True - self.out('Package "{}" already exists, are you sure you want ' + self.out('Package "{0}" already exists, are you sure you want ' 'to use it as your project\'s name?'.format(pkg_name)) - return self.confirm_bad_name('Really use "{}"?: '.format(pkg_name)) + return self.confirm_bad_name('Really use "{0}"?: '.format(pkg_name)) def confirm_bad_name(self, prompt): # pragma: no cover - answer = user_input('{} [y|N]: '.format(prompt)) + answer = user_input('{0} [y|N]: '.format(prompt)) return answer.strip().lower() == 'y' if __name__ == '__main__': # pragma: no cover diff --git a/pyramid/tests/test_scaffolds/test_init.py b/pyramid/tests/test_scaffolds/test_init.py index 4988e66ff..f4d1b287a 100644 --- a/pyramid/tests/test_scaffolds/test_init.py +++ b/pyramid/tests/test_scaffolds/test_init.py @@ -12,11 +12,6 @@ class TestPyramidTemplate(unittest.TestCase): self.assertTrue(vars['random_string']) self.assertEqual(vars['package_logger'], 'one') - def test_pre_site(self): - inst = self._makeOne() - vars = {'package':'site'} - self.assertRaises(ValueError, inst.pre, 'command', 'output dir', vars) - def test_pre_root(self): inst = self._makeOne() vars = {'package':'root'} -- cgit v1.2.3 From f09cc1b354f093bd2afd24085a7e747b0867be8b Mon Sep 17 00:00:00 2001 From: Igor Stroh Date: Thu, 11 Jun 2015 00:08:33 +0200 Subject: use input_ from p.compat, renamed option - Use pyramid.compat.input_ instead of manually checking for python version and chosing the appropriate input/raw_input function - Renamed--force-conflicting-name option to --ignore-conflicting-name - Display invalid scaffold names in a sorted manner --- pyramid/scripts/pcreate.py | 14 +++++--------- pyramid/tests/test_scripts/test_pcreate.py | 2 +- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/pyramid/scripts/pcreate.py b/pyramid/scripts/pcreate.py index 881aacac3..1e8074fc5 100644 --- a/pyramid/scripts/pcreate.py +++ b/pyramid/scripts/pcreate.py @@ -8,11 +8,7 @@ import os.path import pkg_resources import re import sys - -if sys.version_info[0] == 3: - user_input = input # pragma: no cover -else: - user_input = raw_input # NOQA +from pyramid.compat import input_ _bad_chars_re = re.compile('[^a-zA-Z0-9_]') @@ -61,7 +57,7 @@ class PCreateCommand(object): dest='interactive', action='store_true', help='When a file would be overwritten, interrogate') - parser.add_option('--force-conflicting-name', + parser.add_option('--ignore-conflicting-name', dest='force_bad_name', action='store_true', default=False, @@ -181,7 +177,7 @@ class PCreateCommand(object): available = [x.name for x in self.scaffolds] diff = set(self.options.scaffold_name).difference(available) if diff: - self.out('Unavailable scaffolds: %s' % ", ".join(list(diff))) + self.out('Unavailable scaffolds: %s' % ", ".join(sorted(diff))) return False pkg_name = self.project_vars['package'] @@ -204,12 +200,12 @@ class PCreateCommand(object): if self.options.force_bad_name: return True - self.out('Package "{0}" already exists, are you sure you want ' + self.out('A package named "{0}" already exists, are you sure you want ' 'to use it as your project\'s name?'.format(pkg_name)) return self.confirm_bad_name('Really use "{0}"?: '.format(pkg_name)) def confirm_bad_name(self, prompt): # pragma: no cover - answer = user_input('{0} [y|N]: '.format(prompt)) + answer = input_('{0} [y|N]: '.format(prompt)) return answer.strip().lower() == 'y' if __name__ == '__main__': # pragma: no cover diff --git a/pyramid/tests/test_scripts/test_pcreate.py b/pyramid/tests/test_scripts/test_pcreate.py index 8fc9c1267..eaa7c1464 100644 --- a/pyramid/tests/test_scripts/test_pcreate.py +++ b/pyramid/tests/test_scripts/test_pcreate.py @@ -240,7 +240,7 @@ class TestPCreateCommand(unittest.TestCase): 'pyramid_docs_branch': 'master'}) def test_force_override_conflicting_name(self): - cmd = self._makeOne('-s', 'dummy', 'Unittest', '--force-conflicting-name') + cmd = self._makeOne('-s', 'dummy', 'Unittest', '--ignore-conflicting-name') scaffold = DummyScaffold('dummy') cmd.scaffolds = [scaffold] cmd.pyramid_dist = DummyDist("0.10.1dev") -- cgit v1.2.3