Merge pull request #473 from lona-web-org/fscherf/live-reload

setup live reload
lona-web-org · Aug 31, 2023 · 982df35 · 982df35
2 parents 2b1fadf + 4c6d63e
commit 982df35
Show file tree

Hide file tree

Showing 52 changed files with 209 additions and 170 deletions.
diff --git a/README.rst b/README.rst
@@ -71,7 +71,8 @@ pythonic API to write self contained views.
  return html
 
 
- app.run(port=8080)
+ if __name__ == '__main__':
+ app.run(port=8080, live_reload=True)
 
 **More information:**
 `Getting Started <http://lona-web.org/tutorial/01-getting-started/index.html>`_

diff --git a/bin/lona b/bin/lona
@@ -5,4 +5,5 @@ import sys
 
 from lona.command_line.handle_command_line import handle_command_line
 
-handle_command_line(sys.argv)
+if __name__ == '__main__':
+ handle_command_line(sys.argv)
diff --git a/doc/content/api-reference/frontends.rst b/doc/content/api-reference/frontends.rst
@@ -34,36 +34,7 @@ The default frontend template includes ``lona/style.css`` which can be
 overridden.
 
 .. code-block:: html
-
- <!-- templates/lona/frontend.html -->
- <html>
- <head>
- <meta charset="utf-8" />
- {{ Lona.load_stylesheets() }}
- <link href="{{ Lona.load_static_file('lona/style.css') }}" rel="stylesheet">
- </head>
- <body>
- {% include "lona/header.html" %}
- <div id="lona"></div>
- {% include "lona/footer.html" %}
- {{ Lona.load_scripts() }}
- <script>
- var lona_context = new Lona.LonaContext({
- target: '#lona',
- title: 'Lona',
- update_address_bar: true,
- update_title: true,
- follow_redirects: true,
- follow_http_redirects: true,
- });
-
- {% include "lona/frontend.js" %}
-
- lona_context.setup();
- </script>
- </body>
- </html>
-
+ :include: ../../../lona/templates/lona/frontend.html
 
 
 Loading static files

diff --git a/doc/content/api-reference/getting-started.rst b/doc/content/api-reference/getting-started.rst
@@ -44,7 +44,8 @@ python script.
  self.sleep(1)
 
 
- app.run(port=8080)
+ if __name__ == '__main__':
+ app.run(port=8080)
 
 **More information:**
 {{ link('api-reference/lona-scripts.rst', 'Lona Scripts') }}

diff --git a/doc/content/api-reference/lona-scripts.rst b/doc/content/api-reference/lona-scripts.rst
@@ -39,7 +39,8 @@ python script.
  self.sleep(1)
 
 
- app.run()
+ if __name__ == '__main__':
+ app.run()
 
 
 Command Line Arguments
@@ -125,7 +126,8 @@ Views can be added by using the ``LonaApp.route()`` decorator or by setting
  return H1('Hello World')
 
 
- app.run()
+ if __name__ == '__main__':
+ app.run()
 
 
 Setting The Frontend View
@@ -269,4 +271,5 @@ Custom error views can be set using the decorators ``LonaApp.error_403_view``,
  return '500: Internal Error'
 
 
- app.run()
+ if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/api-reference/settings.rst b/doc/content/api-reference/settings.rst
@@ -134,6 +134,19 @@ Client
  :name: CLIENT_DEBUG
  :path: lona.default_settings.CLIENT_DEBUG
 
+.. setting::
+ :name: CLIENT_AUTO_RECONNECT
+ :path: lona.default_settings.CLIENT_AUTO_RECONNECT
+
+ When set to ``True`` the client will try to reconnect to the server
+ periodically when the websocket connection closes
+
+.. setting::
+ :name: CLIENT_AUTO_RECONNECT_TIMEOUT
+ :path: lona.default_settings.CLIENT_AUTO_RECONNECT_TIMEOUT
+
+ Auto reconnect timeout in ms
+
 .. setting::
  :name: CLIENT_VIEW_START_TIMEOUT
  :path: lona.default_settings.CLIENT_VIEW_START_TIMEOUT
@@ -344,4 +357,4 @@ Feature Flags
  When ``settings.USE_FUTURE_NODE_CLASSES`` is set to ``True``:
 
 
- 1. ``lona.html.Select2`` gets used instead of ``lona.html.Select``
+ 1. ``lona.html.Select2`` gets used instead of ``lona.html.Select``
diff --git a/doc/content/contrib/chartjs/index.rst b/doc/content/contrib/chartjs/index.rst
@@ -93,4 +93,5 @@ your view.
  self.show(html)
 
 
- app.run()
+ if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/cookbook/auto-reconnect.rst b/doc/content/cookbook/auto-reconnect.rst
diff --git a/doc/content/demos/bootstrap-5-confirmation-popup/bootstrap-5-confirmation-popup.py b/doc/content/demos/bootstrap-5-confirmation-popup/bootstrap-5-confirmation-popup.py
@@ -134,4 +134,5 @@ def handle_request(self, request):
  return self.html
 
 
-app.run(port=8080)
+if __name__ == '__main__':
+ app.run(port=8080)
diff --git a/doc/content/demos/channels/demo.py b/doc/content/demos/channels/demo.py
@@ -93,4 +93,5 @@ def on_cleanup(self):
  Channel('clock.leave').send()
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/demos/counter/counter.py b/doc/content/demos/counter/counter.py
@@ -42,4 +42,5 @@ def handle_request(self, request):
  )
 
 
-app.run(port=8080)
+if __name__ == '__main__':
+ app.run(port=8080)
diff --git a/doc/content/demos/daemonized-view/daemonized-view.py b/doc/content/demos/daemonized-view/daemonized-view.py
@@ -61,4 +61,5 @@ def handle_request(self, request):
  points.pop(0)
 
 
-app.run(port=8080)
+if __name__ == '__main__':
+ app.run(port=8080)
diff --git a/doc/content/demos/function-plotter/function-plotter.py b/doc/content/demos/function-plotter/function-plotter.py
@@ -171,4 +171,5 @@ def handle_text_input_change(self, input_event):
  self.chart.data = CHART_DATA
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/demos/game-of-life/game-of-life.py b/doc/content/demos/game-of-life/game-of-life.py
@@ -276,4 +276,5 @@ def handle_request(self, request):
  self.enable_controls()
 
 
-app.run(port=8080)
+if __name__ == '__main__':
+ app.run(port=8080)
diff --git a/doc/content/demos/multi-user-chat/demo.py b/doc/content/demos/multi-user-chat/demo.py
@@ -329,4 +329,5 @@ def handle_request(self, request):
  return self.html
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/demos/styled-qr-code-generator/example_make_qr.py b/doc/content/demos/styled-qr-code-generator/example_make_qr.py
@@ -116,4 +116,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/deployment/deploying-on-linux.rst b/doc/content/deployment/deploying-on-linux.rst
@@ -72,7 +72,8 @@ Lona
  return html
 
 
- app.run(port=8080)
+ if __name__ == '__main__':
+ app.run(port=8080)
 
 
 Apache2

diff --git a/doc/content/deployment/hello-world.py b/doc/content/deployment/hello-world.py
@@ -22,4 +22,5 @@ def handle_request(self, request):
  )
 
 
-app.run(host='0.0.0.0', port=8080)
+if __name__ == '__main__':
+ app.run(host='0.0.0.0', port=8080)
diff --git a/doc/content/faq.rst b/doc/content/faq.rst
@@ -72,23 +72,3 @@ he had to add ~20 lines of extra Python code.
 Web is a very powerful tool for visualization and interaction. Python is a
 powerful tool for an unlimited range of tasks. Lona tries to bridge this gap
 and is designed to be very accessible and good for rapid prototyping.
-
-
-Why has Lona no live-reload feature like aiohttp-devtools?
-----------------------------------------------------------
-
-**fscherf:** Early versions of Lona had such a feature, but it got removed due
-bad user experience: Reloading your view helps when the view is fully self
-contained, but when it uses widgets or helper functions from another module,
-things become inconsistent.
-
-To make that a reliable feature you would have to maintain a list of all loaded
-files and directories and track changes, file removes and addition of new
-files. And you would have to maintain this list between restarts, to not miss
-events, if files get changed fast after each other, like in a git rebase.
-
-Also people use different editors that save files at different times and
-sometimes multiple times and/or periodically.
-
-It's hard to get this right, therefore I focused on making the server fast to
-restart and easier to maintain.
diff --git a/doc/content/index.rst b/doc/content/index.rst
@@ -48,7 +48,8 @@ pythonic API to write self contained views.
  return html
 
 
- app.run(port=8080)
+ if __name__ == '__main__':
+ app.run(port=8080)
 
 **More information:**
 {{ link('/tutorial/01-getting-started/index.rst', 'Getting Started') }}

diff --git a/doc/content/tutorial/01-getting-started/example-1.py b/doc/content/tutorial/01-getting-started/example-1.py
@@ -6,4 +6,6 @@
 
 install_picocss(app, debug=True)
 
-app.run()
+
+if __name__ == '__main__':
+ app.run(port=8080, live_reload=True)
diff --git a/doc/content/tutorial/01-getting-started/example-2.py b/doc/content/tutorial/01-getting-started/example-2.py
@@ -17,4 +17,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
+if __name__ == '__main__':
+ app.run(port=8080, live_reload=True)
diff --git a/doc/content/tutorial/01-getting-started/example-3.py b/doc/content/tutorial/01-getting-started/example-3.py
@@ -25,5 +25,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
-
+if __name__ == '__main__':
+ app.run(port=8080, live_reload=True)
diff --git a/doc/content/tutorial/01-getting-started/index.rst b/doc/content/tutorial/01-getting-started/index.rst
@@ -91,8 +91,7 @@ app, like template paths, static directories or routes, will be relative to
 this directory.
 
 The last line of the script (``app.run()``), will run the application server,
-and block until ``CTRL-C`` was hit.
-
+and block until ``CTRL-C`` was hit. 
 Run the script using:
 
 .. code-block::
@@ -105,6 +104,9 @@ If port 8080 is taken by another application, you can set environment
 variable ``LONA_DEFAULT_PORT`` to some other port, affecting all examples that 
 do not set the port explicitly.
 
+When ``live_reload`` is set to ``True`` Lona will watch the scripts project
+root and restart the server when a file in it gets written.
+
 The script should print that it opened a webserver on
 ``http://localhost:8080``. If you navigate your browser there, you should see
 this:

diff --git a/doc/content/tutorial/02-html/example-1.py b/doc/content/tutorial/02-html/example-1.py
@@ -24,4 +24,5 @@ def handle_request(self, request):
  return html
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/02-html/example-2.py b/doc/content/tutorial/02-html/example-2.py
@@ -35,4 +35,5 @@ def handle_request(self, request):
  self.sleep(1)
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/02-html/example-3.py b/doc/content/tutorial/02-html/example-3.py
@@ -72,4 +72,5 @@ def handle_request(self, request):
  current_color += 1
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/03-events/example-1.py b/doc/content/tutorial/03-events/example-1.py
@@ -28,4 +28,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/03-events/example-2.py b/doc/content/tutorial/03-events/example-2.py
@@ -54,4 +54,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/03-events/example-3.py b/doc/content/tutorial/03-events/example-3.py
@@ -45,4 +45,6 @@ def handle_request(self, request):
  P(f'{first_number} + {second_number} = {first_number+second_number}')
  )
 
-app.run()
+
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/04-user-input/example-1.py b/doc/content/tutorial/04-user-input/example-1.py
@@ -33,4 +33,5 @@ def handle_request(self, request):
  self.show(self.html)
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/05-routing/example-1.py b/doc/content/tutorial/05-routing/example-1.py
@@ -45,4 +45,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()
diff --git a/doc/content/tutorial/05-routing/example-2.py b/doc/content/tutorial/05-routing/example-2.py
@@ -41,4 +41,5 @@ def handle_request(self, request):
  )
 
 
-app.run()
+if __name__ == '__main__':
+ app.run()