def orphan_methods(helper: AppCheckHelper, **kwargs):
'''i saw several people making this mistake in the workshop'''
pages_module = common_internal.get_pages_module(helper.app_config.name)
for method_name in ['vars_for_template', 'is_displayed', 'after_all_players_arrive']:
if hasattr(pages_module, method_name):
helper.add_error(
'pages.py has a function {} that is not inside a class.'.format(method_name),
numeric_id=70
)
return
def orphan_methods(helper: AppCheckHelper, **kwargs):
'''i saw several people making this mistake in the workshop'''
pages_module = common_internal.get_pages_module(helper.app_config.name)
for method_name in ['vars_for_template', 'is_displayed',
'after_all_players_arrive']:
if hasattr(pages_module, method_name):
helper.add_error(
'pages.py has a function {} that is not inside a class.'.format(
method_name),
numeric_id=70
)
return
def get_urlpatterns():
from django.contrib.auth.views import login, logout
urlpatterns = [
urls.url(r'^$', RedirectView.as_view(url='/demo', permanent=True)),
urls.url(
r'^accounts/login/$',
login,
{'template_name': 'otree/login.html'},
name='login_url',
),
urls.url(
r'^accounts/logout/$',
logout,
{'next_page': 'DemoIndex'},
name='logout',
),
]
urlpatterns += staticfiles_urlpatterns()
used_names_in_url = set()
for app_name in settings.INSTALLED_OTREE_APPS:
models_module = common_internal.get_models_module(app_name)
name_in_url = models_module.Constants.name_in_url
if name_in_url in used_names_in_url:
msg = ("App {} has name_in_url='{}', "
"which is already used by another app").format(
app_name, name_in_url)
raise ValueError(msg)
used_names_in_url.add(name_in_url)
views_module = common_internal.get_pages_module(app_name)
urlpatterns += url_patterns_from_game_module(views_module.__name__,
name_in_url)
urlpatterns += url_patterns_from_module('otree.views.participant')
urlpatterns += url_patterns_from_module('otree.views.demo')
urlpatterns += url_patterns_from_module('otree.views.admin')
urlpatterns += url_patterns_from_module('otree.views.room')
urlpatterns += url_patterns_from_module('otree.views.mturk')
urlpatterns += url_patterns_from_module('otree.views.export')
urlpatterns += extensions_urlpatterns()
urlpatterns += extensions_export_urlpatterns()
return urlpatterns
def get_urlpatterns():
from django.contrib.auth.views import login, logout
urlpatterns = [
urls.url(r'^$', RedirectView.as_view(url='/demo', permanent=True)),
urls.url(
r'^accounts/login/$',
login,
{'template_name': 'otree/login.html'},
name='login_url',
),
urls.url(
r'^accounts/logout/$',
logout,
{'next_page': 'DemoIndex'},
name='logout',
),
]
urlpatterns += staticfiles_urlpatterns()
used_names_in_url = set()
for app_name in settings.INSTALLED_OTREE_APPS:
models_module = common_internal.get_models_module(app_name)
name_in_url = models_module.Constants.name_in_url
if name_in_url in used_names_in_url:
msg = ("App {} has Constants.name_in_url='{}', "
"which is already used by another app").format(
app_name, name_in_url)
raise ValueError(msg)
used_names_in_url.add(name_in_url)
views_module = common_internal.get_pages_module(app_name)
urlpatterns += url_patterns_from_game_module(views_module.__name__,
name_in_url)
urlpatterns += url_patterns_from_module('otree.views.participant')
urlpatterns += url_patterns_from_module('otree.views.demo')
urlpatterns += url_patterns_from_module('otree.views.admin')
urlpatterns += url_patterns_from_module('otree.views.room')
urlpatterns += url_patterns_from_module('otree.views.mturk')
urlpatterns += url_patterns_from_module('otree.views.export')
urlpatterns += extensions_urlpatterns()
urlpatterns += extensions_export_urlpatterns()
# serve an empty favicon?
# otherwise, the logs will contain:
# [WARNING] django.request > Not Found: /favicon.ico
# Not Found: /favicon.ico
# don't want to add a <link> in base template because even if it exists,
# browsers will still request /favicon.ico.
# plus it makes the HTML noisier
# can't use the static() function here because maybe collectstatic
# has not been run yet
# and it seems an empty HttpResponse or even a 204 response makes the browser
# just keep requesting the file with every page load
# hmmm...now it seems that chrome is not re-requesting with every page load
# but firefox does. but if i remove the favicon, there's 1 404 then FF doesn't
# ask for it again.
# import os
# dir_path = os.path.dirname(os.path.realpath(__file__))
# with open(os.path.join(dir_path, 'favicon_invisible.ico'), 'rb') as f:
# #with open('favicon.ico', 'rb') as f:
# favicon_content = f.read()
#
#
# urlpatterns.append(
# urls.url(
# r'^favicon\.ico$',
# lambda request: HttpResponse(favicon_content, content_type="image/x-icon")
# )
# )
return urlpatterns
def create_session(
session_config_name, *, label='', num_participants=None,
pre_create_id=None,
room_name=None, for_mturk=False,
is_demo=False,
edited_session_config_fields=None) -> Session:
num_subsessions = 0
edited_session_config_fields = edited_session_config_fields or {}
try:
session_config = SESSION_CONFIGS_DICT[session_config_name]
except KeyError:
msg = 'Session config "{}" not found in settings.SESSION_CONFIGS.'
raise KeyError(msg.format(session_config_name)) from None
else:
# copy so that we don't mutate the original
# .copy() returns a dict, so need to convert back to SessionConfig
session_config = SessionConfig(session_config.copy())
session_config.update(edited_session_config_fields)
# check validity and converts serialized decimal & currency values
# back to their original data type (because they were serialized
# when passed through channels
session_config.clean()
with transaction.atomic():
# 2014-5-2: i could implement this by overriding the __init__ on the
# Session model, but I don't really know how that works, and it seems
# to be a bit discouraged: http://goo.gl/dEXZpv
# 2014-9-22: preassign to groups for demo mode.
if for_mturk:
mturk_num_participants = (
num_participants /
settings.MTURK_NUM_PARTICIPANTS_MULTIPLE)
else:
mturk_num_participants = -1
session = Session.objects.create(
config=session_config,
label=label,
_pre_create_id=pre_create_id,
is_demo=is_demo,
num_participants=num_participants,
mturk_num_participants=mturk_num_participants
) # type: Session
# check that it divides evenly
session_lcm = session_config.get_lcm()
if num_participants % session_lcm:
msg = (
'Session Config {}: Number of participants ({}) is not a multiple '
'of group size ({})'
).format(session_config['name'], num_participants, session_lcm)
raise ValueError(msg)
Participant.objects.bulk_create(
[
Participant(id_in_session=id_in_session, session=session)
for id_in_session in list(range(1, num_participants+1))
]
)
participant_values = session.participant_set.order_by('id').values('code', 'id')
ParticipantLockModel.objects.bulk_create([
ParticipantLockModel(participant_code=participant['code'])
for participant in participant_values])
participant_to_player_lookups = []
page_index = 0
for app_name in session_config['app_sequence']:
views_module = common_internal.get_pages_module(app_name)
models_module = get_models_module(app_name)
Constants = models_module.Constants
num_subsessions += Constants.num_rounds
round_numbers = list(range(1, Constants.num_rounds + 1))
Subsession = models_module.Subsession
Group = models_module.Group
Player = models_module.Player
Subsession.objects.bulk_create(
[
Subsession(round_number=round_number, session=session)
for round_number in round_numbers
]
)
subsessions = Subsession.objects.filter(
session=session).order_by('round_number').values(
'id', 'round_number')
ppg = Constants.players_per_group
if ppg is None or Subsession._has_group_by_arrival_time():
ppg = num_participants
num_groups_per_round = int(num_participants/ppg)
groups_to_create = []
for subsession in subsessions:
for id_in_subsession in range(1, num_groups_per_round+1):
groups_to_create.append(
Group(
session=session,
subsession_id=subsession['id'],
round_number=subsession['round_number'],
id_in_subsession=id_in_subsession,
)
)
Group.objects.bulk_create(groups_to_create)
groups = Group.objects.filter(session=session).values(
'id_in_subsession', 'subsession_id', 'id'
).order_by('id_in_subsession')
groups_lookup = defaultdict(list)
for group in groups:
subsession_id = group['subsession_id']
groups_lookup[subsession_id].append(group['id'])
players_to_create = []
for subsession in subsessions:
subsession_id=subsession['id']
round_number=subsession['round_number']
participant_index = 0
for group_id in groups_lookup[subsession_id]:
for id_in_group in range(1, ppg+1):
participant = participant_values[participant_index]
players_to_create.append(
Player(
session=session,
subsession_id=subsession_id,
round_number=round_number,
participant_id=participant['id'],
group_id=group_id,
id_in_group=id_in_group
)
)
participant_index += 1
# Create players
Player.objects.bulk_create(players_to_create)
players_flat = Player.objects.filter(session=session).values(
'id', 'participant__code', 'participant__id', 'subsession__id',
'round_number'
)
players_by_round = [[] for _ in range(Constants.num_rounds)]
for p in players_flat:
players_by_round[p['round_number']-1].append(p)
for round_number, round_players in enumerate(players_by_round, start=1):
for View in views_module.page_sequence:
page_index += 1
for p in round_players:
participant_code = p['participant__code']
url = View.get_url(
participant_code=participant_code,
name_in_url=Constants.name_in_url,
page_index=page_index
)
participant_to_player_lookups.append(
ParticipantToPlayerLookup(
participant_id=p['participant__id'],
participant_code=participant_code,
page_index=page_index,
app_name=app_name,
player_pk=p['id'],
subsession_pk=p['subsession__id'],
session_pk=session.pk,
url=url))
ParticipantToPlayerLookup.objects.bulk_create(
participant_to_player_lookups
)
session.participant_set.update(_max_page_index=page_index)
with otree.db.idmap.use_cache():
# possible optimization: check if
# Subsession.creating_session == BaseSubsession.creating_session
# if so, skip it.
# but this will only help people who didn't override creating_session
# in that case, the session usually creates quickly, anyway.
for subsession in session.get_subsessions():
subsession.before_session_starts()
subsession.creating_session()
otree.db.idmap.save_objects()
# 2017-09-27: moving this inside the transaction
session._set_admin_report_app_names()
session.save()
# we don't need to mark it ready=True here...because it's in a
# transaction
# this should happen after session.ready = True
if room_name is not None:
from otree.room import ROOM_DICT
room = ROOM_DICT[room_name]
room.set_session(session)
return session
def pages_function(helper: AppCheckHelper, **kwargs):
pages_module = common_internal.get_pages_module(helper.app_config.name)
views_or_pages = pages_module.__name__.split('.')[-1]
try:
page_list = pages_module.page_sequence
except:
helper.add_error(
'{}.py is missing the variable page_sequence.'.format(
views_or_pages),
numeric_id=21
)
return
else:
for i, ViewCls in enumerate(page_list):
# there is no good reason to include Page in page_sequence.
# As for WaitPage: even though it works fine currently
# and can save the effort of subclassing,
# we should restrict it, because:
# - one user had "class WaitPage(Page):".
# - if someone makes "class WaitPage(WaitPage):", they might
# not realize why it's inheriting the extra behavior.
# overall, I think the small inconvenience of having to subclass
# once per app
# is outweighed by the unexpected behavior if someone subclasses
# it without understanding inheritance.
# BUT: built-in Trust game had a wait page called WaitPage.
# that was fixed on Aug 24, 2017, need to wait a while...
# see below in ensure_no_misspelled_attributes,
# we can get rid of a check there also
if ViewCls.__name__ == 'Page':
msg = (
"page_sequence cannot contain "
"a class called 'Page'."
)
helper.add_error(msg, numeric_id=22)
if ViewCls.__name__ == 'WaitPage':
msg = (
"page_sequence cannot contain "
"a class called 'WaitPage'."
)
helper.add_warning(msg, numeric_id=221)
if issubclass(ViewCls, WaitPage):
if ViewCls.group_by_arrival_time:
if i > 0:
helper.add_error(
'"{}" has group_by_arrival_time=True, so '
'it must be placed first in page_sequence.'.format(
ViewCls.__name__), numeric_id=23)
if ViewCls.wait_for_all_groups:
helper.add_error(
'Page "{}" has group_by_arrival_time=True, so '
'it cannot have wait_for_all_groups=True also.'.format(
ViewCls.__name__), numeric_id=24)
# alternative technique is to not define the method on WaitPage
# and then use hasattr, but I want to keep all complexity
# out of views.abstract
elif (
ViewCls.get_players_for_group != WaitPage.get_players_for_group):
helper.add_error(
'Page "{}" defines get_players_for_group, '
'but in order to use this method, you must set '
'group_by_arrival_time=True'.format(
ViewCls.__name__), numeric_id=25)
elif issubclass(ViewCls, Page):
pass # ok
else:
msg = '"{}" is not a valid page'.format(ViewCls)
helper.add_error(msg, numeric_id=26)
ensure_no_misspelled_attributes(ViewCls, helper)
def get_urlpatterns():
from django.contrib.auth.views import login, logout
urlpatterns = [
urls.url(r'^$', RedirectView.as_view(url='/demo', permanent=True)),
urls.url(
r'^accounts/login/$',
login,
{'template_name': 'otree/login.html'},
name='login_url',
),
urls.url(
r'^accounts/logout/$',
logout,
{'next_page': 'DemoIndex'},
name='logout',
),
]
urlpatterns += staticfiles_urlpatterns()
used_names_in_url = set()
for app_name in settings.INSTALLED_OTREE_APPS:
models_module = common_internal.get_models_module(app_name)
name_in_url = models_module.Constants.name_in_url
if name_in_url in used_names_in_url:
msg = (
"App {} has Constants.name_in_url='{}', "
"which is already used by another app"
).format(app_name, name_in_url)
raise ValueError(msg)
used_names_in_url.add(name_in_url)
views_module = common_internal.get_pages_module(app_name)
urlpatterns += url_patterns_from_game_module(
views_module.__name__, name_in_url)
urlpatterns += url_patterns_from_module('otree.views.participant')
urlpatterns += url_patterns_from_module('otree.views.demo')
urlpatterns += url_patterns_from_module('otree.views.admin')
urlpatterns += url_patterns_from_module('otree.views.room')
urlpatterns += url_patterns_from_module('otree.views.mturk')
urlpatterns += url_patterns_from_module('otree.views.export')
urlpatterns += extensions_urlpatterns()
urlpatterns += extensions_export_urlpatterns()
# serve an empty favicon?
# otherwise, the logs will contain:
# [WARNING] django.request > Not Found: /favicon.ico
# Not Found: /favicon.ico
# don't want to add a <link> in base template because even if it exists,
# browsers will still request /favicon.ico.
# plus it makes the HTML noisier
# can't use the static() function here because maybe collectstatic
# has not been run yet
# and it seems an empty HttpResponse or even a 204 response makes the browser
# just keep requesting the file with every page load
# hmmm...now it seems that chrome is not re-requesting with every page load
# but firefox does. but if i remove the favicon, there's 1 404 then FF doesn't
# ask for it again.
# import os
# dir_path = os.path.dirname(os.path.realpath(__file__))
# with open(os.path.join(dir_path, 'favicon_invisible.ico'), 'rb') as f:
# #with open('favicon.ico', 'rb') as f:
# favicon_content = f.read()
#
#
# urlpatterns.append(
# urls.url(
# r'^favicon\.ico$',
# lambda request: HttpResponse(favicon_content, content_type="image/x-icon")
# )
# )
return urlpatterns
