Merge pull request #3464 from ericatkin/pserve_exclude_prefixes

Add ignore_files to pserve configuration section

CONTRIBUTORS.txt

@@ -334,3 +334,5 @@ Contributors
 - Colin Dunklau, 2018/09/19
 
 - Alexandre Yukio Harano, 2018/10/05
+
+- Eric Atkin, 2019/02/15

setup.py

@@ -26,7 +26,7 @@ def readfile(name):
 VERSION = '1.10.2'
 
 install_requires = [
-    'hupper',
+    'hupper >= 1.5',  # ignore_files support
     'plaster',
     'plaster_pastedeploy',
     'setuptools',

src/pyramid/scripts/pserve.py

@@ -27,8 +27,10 @@
 from pyramid.settings import aslist
 
 
-def main(argv=sys.argv, quiet=False):
-    command = PServeCommand(argv, quiet=quiet)
+def main(argv=sys.argv, quiet=False, original_ignore_files=None):
+    command = PServeCommand(
+        argv, quiet=quiet, original_ignore_files=original_ignore_files
+    )
     return command.run()
 
 
@@ -133,13 +135,15 @@ class PServeCommand(object):
 
     _scheme_re = re.compile(r'^[a-z][a-z]+:', re.I)
 
-    def __init__(self, argv, quiet=False):
+    def __init__(self, argv, quiet=False, original_ignore_files=None):
         self.args = self.parser.parse_args(argv[1:])
         if quiet:
             self.args.verbose = 0
         if self.args.reload:
             self.worker_kwargs = {'argv': argv, "quiet": quiet}
         self.watch_files = set()
+        self.ignore_files = set()
+        self.original_ignore_files = original_ignore_files
 
     def out(self, msg):  # pragma: no cover
         if self.args.verbose > 0:
@@ -153,6 +157,9 @@ def pserve_file_config(self, loader, global_conf=None):
         config_path = self.get_config_path(loader)
         here = os.path.dirname(config_path)
         watch_files = aslist(settings.get('watch_files', ''), flatten=False)
+        self.ignore_files = set(
+            aslist(settings.get('ignore_files', ''), flatten=False)
+        )
 
         # track file paths relative to the ini file
         resolver = AssetResolver(package=None)
@@ -234,11 +241,13 @@ def open_browser():
         if self.args.reload and not hupper.is_active():
             if self.args.verbose > 1:
                 self.out('Running reloading file monitor')
+            self.worker_kwargs['original_ignore_files'] = self.ignore_files
             hupper.start_reloader(
                 'pyramid.scripts.pserve.main',
                 reload_interval=int(self.args.reload_interval),
                 verbose=self.args.verbose,
                 worker_kwargs=self.worker_kwargs,
+                ignore_files=self.ignore_files,
             )
             return 0
 
@@ -252,6 +261,15 @@ def open_browser():
             reloader = hupper.get_reloader()
             reloader.watch_files(list(self.watch_files))
 
+        if (
+            self.original_ignore_files is not None
+            and self.original_ignore_files != self.ignore_files
+        ):
+            self.out(
+                'A change to "ignore_files" was detected but it will not take'
+                ' effect until pserve is restarted.'
+            )
+
         server = server_loader.get_wsgi_server(server_name, config_vars)
 
         app = loader.get_wsgi_app(app_name, config_vars)

tests/test_scripts/test_pserve.py

@@ -20,10 +20,10 @@ def _getTargetClass(self):
 
         return PServeCommand
 
-    def _makeOne(self, *args):
+    def _makeOne(self, *args, **kwargs):
         effargs = ['pserve']
         effargs.extend(args)
-        cmd = self._getTargetClass()(effargs)
+        cmd = self._getTargetClass()(effargs, **kwargs)
         cmd.out = self.out
         self.loader = dummy.DummyLoader()
         cmd._get_config_loader = self.loader
@@ -50,6 +50,32 @@ def get_app(name, global_conf):
         inst.run()
         self.assertEqual(app.global_conf, {'a': '1', 'b': '2'})
 
+    def test_original_ignore_files(self):
+        msg = 'A change to "ignore_files" was detected'
+
+        def get_app(name, global_conf):
+            app.name = name
+            app.global_conf = global_conf
+            return app
+
+        inst = self._makeOne('development.ini')
+        app = dummy.DummyApp()
+        self.loader.get_wsgi_app = get_app
+        self.loader.server = lambda x: x
+        self.loader.settings = {'pserve': {'ignore_files': '*.txt'}}
+        inst.run()
+        self.assertNotIn(msg, self.out_.getvalue())
+
+        inst = self._makeOne(
+            'development.ini', original_ignore_files={'*.txt'}
+        )
+        app = dummy.DummyApp()
+        self.loader.get_wsgi_app = get_app
+        self.loader.server = lambda x: x
+        self.loader.settings = {'pserve': {'ignore_files': 'foo/*.txt'}}
+        inst.run()
+        self.assertIn(msg, self.out_.getvalue())
+
     def test_parse_vars_bad(self):
         inst = self._makeOne('development.ini', 'a')
         self.assertRaises(ValueError, inst.run)
@@ -123,7 +149,9 @@ def dummy_start_reloader(*args, **kwargs):
                 'worker_kwargs': {
                     'argv': ['pserve', '--reload', 'development.ini'],
                     'quiet': False,
+                    'original_ignore_files': set(),
                 },
+                'ignore_files': set(),
             },
         )