test_pages.py 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. import asyncio
  2. from time import time
  3. from typing import Generator
  4. from uuid import uuid4
  5. import justpy.htmlcomponents
  6. import pytest
  7. from nicegui import task_logger, ui
  8. from nicegui.events import PageEvent
  9. from starlette.requests import Request
  10. from .screen import Screen
  11. def test_page(screen: Screen):
  12. @ui.page('/')
  13. def page():
  14. ui.label('Hello, world!')
  15. screen.open('/')
  16. screen.should_contain('NiceGUI')
  17. screen.should_contain('Hello, world!')
  18. def test_shared_page(screen: Screen):
  19. @ui.page('/', shared=True)
  20. def page():
  21. ui.label('Hello, world!')
  22. screen.open('/')
  23. screen.should_contain('NiceGUI')
  24. screen.should_contain('Hello, world!')
  25. def test_auto_index_page(screen: Screen):
  26. ui.label('Hello, world!')
  27. screen.open('/')
  28. screen.should_contain('NiceGUI')
  29. screen.should_contain('Hello, world!')
  30. def test_custom_title(screen: Screen):
  31. @ui.page('/', title='My Custom Title')
  32. def page():
  33. ui.label('Hello, world!')
  34. screen.open('/')
  35. screen.should_contain('My Custom Title')
  36. screen.should_contain('Hello, world!')
  37. def test_route_with_custom_path(screen: Screen):
  38. @ui.page('/test_route')
  39. def page():
  40. ui.label('page with custom path')
  41. screen.open('/test_route')
  42. screen.should_contain('page with custom path')
  43. def test_auto_index_page_with_link_to_subpage(screen: Screen):
  44. ui.link('link to subpage', '/subpage')
  45. @ui.page('/subpage')
  46. def page():
  47. ui.label('the subpage')
  48. screen.open('/')
  49. screen.click('link to subpage')
  50. screen.should_contain('the subpage')
  51. def test_link_to_page_by_passing_function(screen: Screen):
  52. @ui.page('/subpage')
  53. def page():
  54. ui.label('the subpage')
  55. ui.link('link to subpage', page)
  56. screen.open('/')
  57. screen.click('link to subpage')
  58. screen.should_contain('the subpage')
  59. def test_creating_new_page_after_startup(screen: Screen):
  60. screen.start_server()
  61. @ui.page('/late_page')
  62. def page():
  63. ui.label('page created after startup')
  64. screen.open('/late_page')
  65. screen.should_contain('page created after startup')
  66. def test_shared_and_individual_pages(screen: Screen):
  67. @ui.page('/individual_page')
  68. def individual_page():
  69. ui.label(f'individual page with uuid {uuid4()}')
  70. @ui.page('/shared_page', shared=True)
  71. def shared_page():
  72. ui.label(f'shared page with uuid {uuid4()}')
  73. screen.open('/shared_page')
  74. uuid1 = screen.find('shared page').text.split()[-1]
  75. screen.open('/shared_page')
  76. uuid2 = screen.find('shared page').text.split()[-1]
  77. assert uuid1 == uuid2
  78. screen.open('/individual_page')
  79. uuid1 = screen.find('individual page').text.split()[-1]
  80. screen.open('/individual_page')
  81. uuid2 = screen.find('individual page').text.split()[-1]
  82. assert uuid1 != uuid2
  83. def test_on_page_ready_event(screen: Screen):
  84. '''This feature was introduced to fix #50; see https://github.com/zauberzeug/nicegui/issues/50#issuecomment-1210962617.'''
  85. async def load() -> None:
  86. label.text = 'loading...'
  87. # NOTE we can not use asyncio.create_task() here because we are on a different thread than the nicegui event loop
  88. task_logger.create_task(takes_a_while())
  89. async def takes_a_while() -> None:
  90. await asyncio.sleep(0.1)
  91. label.text = 'delayed data has been loaded'
  92. @ui.page('/', on_page_ready=load)
  93. def page():
  94. global label
  95. label = ui.label()
  96. screen.open('/')
  97. screen.should_contain('delayed data has been loaded')
  98. def test_customized_page(screen: Screen):
  99. trace = []
  100. class custom_page(ui.page):
  101. def __init__(self, route: str, **kwargs):
  102. super().__init__(route, title='My Customized Page', **kwargs)
  103. trace.append('init')
  104. async def connected(self, request: Request) -> None:
  105. await super().connected(request)
  106. assert isinstance(request, Request)
  107. trace.append('connected')
  108. async def before_content(self) -> None:
  109. assert isinstance(self.page.view, justpy.htmlcomponents.Div), \
  110. 'we should be able to access the underlying JustPy view'
  111. await super().before_content()
  112. trace.append('before_content')
  113. async def after_content(self) -> None:
  114. await super().after_content()
  115. trace.append('after_content')
  116. @custom_page('/', dark=True)
  117. def mainpage():
  118. trace.append('content')
  119. ui.label('Hello, world!')
  120. screen.open('/')
  121. screen.should_contain('Hello, world!')
  122. screen.should_contain('My Customized Page')
  123. assert 'body--dark' in screen.get_tags('body')[0].get_attribute('class')
  124. assert trace == ['init', 'connected', 'before_content', 'content', 'after_content']
  125. def test_shared_page_with_request_parameter_raises_exception(screen: Screen):
  126. @ui.page('/', shared=True)
  127. def page(request: Request):
  128. ui.label('Hello, world!')
  129. screen.open('/')
  130. screen.should_contain('500')
  131. screen.should_contain('Server error')
  132. screen.assert_py_logger('ERROR', 'Cannot use `request` argument in shared page')
  133. def test_adding_elements_in_on_page_ready_event(screen: Screen):
  134. @ui.page('/', on_page_ready=lambda: ui.markdown('Hello, world!'))
  135. def page():
  136. pass
  137. screen.open('/')
  138. screen.should_contain('Hello, world!')
  139. def test_pageready_after_yield_on_async_page(screen: Screen):
  140. @ui.page('/')
  141. async def page() -> Generator[None, PageEvent, None]:
  142. ui.label('before')
  143. page_ready = yield
  144. await asyncio.sleep(1)
  145. ui.label('after')
  146. ui.label(page_ready.socket.base_url)
  147. screen.open('/')
  148. screen.should_contain('before')
  149. screen.should_not_contain('after')
  150. screen.wait(1)
  151. screen.should_contain('after')
  152. screen.should_contain('ws://localhost:3392/')
  153. def test_pageready_after_yield_on_non_async_page(screen: Screen):
  154. @ui.page('/')
  155. def page() -> Generator[None, PageEvent, None]:
  156. t = time()
  157. page_ready = yield
  158. ui.label(f'loading page took {time() - t:.2f} seconds')
  159. ui.label(page_ready.socket.base_url)
  160. screen.open('/')
  161. timing = screen.find('loading page took')
  162. assert 0 < float(timing.text.split()[-2]) < 3
  163. screen.should_contain('ws://localhost:3392/')
  164. def test_pageready_after_yield_on_shared_page_raises_exception(screen: Screen):
  165. @ui.page('/', shared=True)
  166. def page():
  167. yield
  168. screen.open('/')
  169. screen.should_contain('500')
  170. screen.should_contain('Server error')
  171. screen.assert_py_logger('ERROR', 'Yielding for page_ready is not supported on shared pages')
  172. def test_exception_before_yield_on_async_page(screen: Screen):
  173. @ui.page('/')
  174. async def page() -> Generator[None, PageEvent, None]:
  175. raise Exception('some exception')
  176. screen.open('/')
  177. screen.should_contain('500')
  178. screen.should_contain('Server error')
  179. screen.assert_py_logger('ERROR', 'some exception')
  180. def test_exception_after_yield_on_async_page(screen: Screen):
  181. @ui.page('/')
  182. async def page() -> Generator[None, PageEvent, None]:
  183. yield
  184. ui.label('this is shown')
  185. raise Exception('some exception')
  186. screen.open('/')
  187. screen.should_contain('this is shown')
  188. screen.assert_py_logger('ERROR', 'Failed to execute page-ready')