-
+
'
- inner_html = '{choice_value}{sub_widgets} '
+ outer_html = '{content}'
+ inner_html = '{content}'
inner_html = '
(%s=lowest, %s=highest)" % (adj_min_score, adj_max_score)) self.fields['score'] = forms.FloatField(min_value=adj_min_score, max_value=adj_max_score, label=score_label) - for question in self.tournament.adj_feedback_questions.filter(**self.question_filter): + for question in self._tournament.adj_feedback_questions.filter(**self.question_filter): self.fields[question.reference] = self._make_question_field(question) # Tournament password field, if applicable - if self._use_tournament_password and self.tournament.pref('public_use_password'): - self.fields['password'] = TournamentPasswordField(tournament=self.tournament) + if self._use_tournament_password and self._tournament.pref('public_use_password'): + self.fields['password'] = TournamentPasswordField(tournament=self._tournament) def save_adjudicatorfeedback(self, **kwargs): """Saves the question fields and returns the AdjudicatorFeedback. @@ -152,17 +185,17 @@ def save_adjudicatorfeedback(self, **kwargs): if self._confirm_on_submit: self.discard_all_existing(adjudicator=kwargs['adjudicator'], - source_adjudicator=kwargs['source_adjudicator'], - source_team=kwargs['source_team']) + source_adjudicator=kwargs['source_adjudicator'], + source_team=kwargs['source_team']) af.confirmed = True af.score = self.cleaned_data['score'] af.save() - for question in self.tournament.adj_feedback_questions.filter(**self.question_filter): + for question in self._tournament.adj_feedback_questions.filter(**self.question_filter): if self.cleaned_data[question.reference] is not None: - answer = question.answer_type_class(feedback=af, question=question, - answer=self.cleaned_data[question.reference]) + answer = question.answer_type_class( + feedback=af, question=question, answer=self.cleaned_data[question.reference]) answer.save() return af @@ -172,7 +205,8 @@ def discard_all_existing(self, **kwargs): fb.discarded = True fb.save() -def make_feedback_form_class(source, *args, **kwargs): + +def make_feedback_form_class(source, tournament, *args, **kwargs): """Constructs a FeedbackForm class specific to the given source. 'source' is the Adjudicator or Team who is giving feedback. 'submission_fields' is a dict of fields that is passed directly as keyword @@ -180,111 +214,109 @@ def make_feedback_form_class(source, *args, **kwargs): 'confirm_on_submit' is a bool, and indicates that this feedback should be as confirmed and all others discarded.""" if isinstance(source, Adjudicator): - return make_feedback_form_class_for_adj(source, *args, **kwargs) + return make_feedback_form_class_for_adj(source, tournament, *args, **kwargs) elif isinstance(source, Team): - return make_feedback_form_class_for_team(source, *args, **kwargs) + return make_feedback_form_class_for_team(source, tournament, *args, **kwargs) else: raise TypeError('source must be Adjudicator or Team: %r' % source) -def make_feedback_form_class_for_adj(source, submission_fields, confirm_on_submit=False, - enforce_required=True, include_unreleased_draws=False): + +def make_feedback_form_class_for_adj(source, tournament, submission_fields, confirm_on_submit=False, + enforce_required=True, include_unreleased_draws=False): """Constructs a FeedbackForm class specific to the given source adjudicator. Parameters are as for make_feedback_form_class.""" - def adj_choice(da): - return (da.id, '%s (%s, %s)' % (da.adjudicator.name, - da.debate.round.name, da.get_type_display())) - def coerce_da(value): - return DebateAdjudicator.objects.get(id=int(value)) + def adj_choice(adj, debate, pos): + value = '%d-%d' % (debate.id, adj.id) + display = '%s (%s, %s)' % (adj.name, debate.round.name, ADJUDICATOR_POSITION_NAMES[pos]) + return (value, display) + + debateadjs = DebateAdjudicator.objects.filter( + debate__round__tournament=tournament, adjudicator=source, + debate__round__seq__lte=tournament.current_round.seq, + debate__round__stage=Round.STAGE_PRELIMINARY + ).order_by('-debate__round__seq').prefetch_related( + 'debate__debateadjudicator_set__adjudicator' + ) - debate_filter = {'debateadjudicator__adjudicator': source} - if not source.tournament.pref('panellist_feedback_enabled'): - debate_filter['debateadjudicator__type'] = DebateAdjudicator.TYPE_CHAIR # include only debates for which this adj was the chair if include_unreleased_draws: - debate_filter['round__draw_status__in'] = [Round.STATUS_CONFIRMED, Round.STATUS_RELEASED] + debateadjs = debateadjs.filter(debate__round__draw_status__in=[Round.STATUS_CONFIRMED, Round.STATUS_RELEASED]) else: - debate_filter['round__draw_status'] = Round.STATUS_RELEASED - debates = Debate.objects.filter(**debate_filter) + debateadjs = debateadjs.filter(debate__round__draw_status=Round.STATUS_RELEASED) choices = [(None, '-- Adjudicators --')] - # for an adjudicator, find every adjudicator on their panel except them - choices.extend(adj_choice(da) for da in DebateAdjudicator.objects.filter( - debate__in=debates).exclude( - adjudicator=source).select_related( - 'debate').order_by( - '-debate__round__seq')) + for debateadj in debateadjs: + targets = expected_feedback_targets(debateadj, tournament.pref('feedback_paths')) + for target, pos in targets: + choices.append(adj_choice(target, debateadj.debate, pos)) class FeedbackForm(BaseFeedbackForm): - tournament = source.tournament # BaseFeedbackForm setting - _use_tournament_password = True # BaseFeedbackForm setting + _tournament = tournament # BaseFeedbackForm setting + _use_tournament_password = True # BaseFeedbackForm setting _confirm_on_submit = confirm_on_submit _enforce_required = enforce_required - question_filter = dict(chair_on_panellist=True) + question_filter = dict(from_adj=True) - debate_adjudicator = RequiredTypedChoiceField(choices=choices, coerce=coerce_da) + target = RequiredTypedChoiceField(choices=choices, coerce=BaseFeedbackForm.coerce_target, label='Adjudicator this feedback is about') def save(self): """Saves the form and returns the AdjudicatorFeedback object.""" - da = self.cleaned_data['debate_adjudicator'] - sa = DebateAdjudicator.objects.get(adjudicator=source, debate=da.debate) - kwargs = dict(adjudicator=da.adjudicator, source_adjudicator=sa, source_team=None) + debate, target = self.cleaned_data['target'] + sa = DebateAdjudicator.objects.get(adjudicator=source, debate=debate) + kwargs = dict(adjudicator=target, source_adjudicator=sa, source_team=None) kwargs.update(submission_fields) return self.save_adjudicatorfeedback(**kwargs) return FeedbackForm -def make_feedback_form_class_for_team(source, submission_fields, confirm_on_submit=False, - enforce_required=True, include_unreleased_draws=False): + +def make_feedback_form_class_for_team(source, tournament, submission_fields, confirm_on_submit=False, + enforce_required=True, include_unreleased_draws=False): """Constructs a FeedbackForm class specific to the given source team. Parameters are as for make_feedback_form_class.""" + def adj_choice(adj, debate, pos): + value = '%d-%d' % (debate.id, adj.id) + if pos == AdjudicatorAllocation.POSITION_CHAIR: + pos_text = '—chair gave oral' + elif pos == AdjudicatorAllocation.POSITION_PANELLIST: + pos_text = '—chair rolled, this panellist gave oral' + elif pos == AdjudicatorAllocation.POSITION_ONLY: + pos_text = '' + display = '{name} ({r}{pos})'.format(name=adj.name, r=debate.round.name, pos=pos_text) + return (value, display) + # Only include non-silent rounds for teams. - debate_filter = { - 'debateteam__team': source, - 'round__silent': False, - } + debates = Debate.objects.filter( + debateteam__team=source, round__silent=False, + round__seq__lte=tournament.current_round.seq, + round__stage=Round.STAGE_PRELIMINARY + ).order_by('-round__seq').prefetch_related('debateadjudicator_set__adjudicator') if include_unreleased_draws: - debate_filter['round__draw_status__in'] = [Round.STATUS_CONFIRMED, Round.STATUS_RELEASED] + debates = debates.filter(round__draw_status__in=[Round.STATUS_CONFIRMED, Round.STATUS_RELEASED]) else: - debate_filter['round__draw_status'] = Round.STATUS_RELEASED - debates = Debate.objects.filter(**debate_filter).order_by('-round__seq') + debates = debates.filter(round__draw_status=Round.STATUS_RELEASED) choices = [(None, '-- Adjudicators --')] for debate in debates: - try: - chair = DebateAdjudicator.objects.get(debate=debate, type=DebateAdjudicator.TYPE_CHAIR) - except DebateAdjudicator.DoesNotExist: - continue - panel = DebateAdjudicator.objects.filter(debate=debate, type=DebateAdjudicator.TYPE_PANEL) - if panel.exists(): - choices.append((chair.id, '{name} ({r} - chair gave oral)'.format( - name=chair.adjudicator.name, r=debate.round.name))) - for da in panel: - choices.append((da.id, '{name} ({r} - chair rolled, this panellist gave oral)'.format( - name=da.adjudicator.name, r=debate.round.name))) - else: - choices.append((chair.id, '{name} ({r})'.format( - name=chair.adjudicator.name, r=debate.round.name))) - - def coerce_da(value): - return DebateAdjudicator.objects.get(id=int(value)) + for adj, pos in debate.adjudicators.voting_with_positions(): + choices.append(adj_choice(adj, debate, pos)) class FeedbackForm(BaseFeedbackForm): - tournament = source.tournament # BaseFeedbackForm setting - _use_tournament_password = True # BaseFeedbackForm setting + _tournament = tournament # BaseFeedbackForm setting + _use_tournament_password = True # BaseFeedbackForm setting _confirm_on_submit = confirm_on_submit _enforce_required = enforce_required - question_filter = dict(team_on_orallist=True) + question_filter = dict(from_team=True) - debate_adjudicator = RequiredTypedChoiceField(choices=choices, coerce=coerce_da) + target = RequiredTypedChoiceField(choices=choices, coerce=BaseFeedbackForm.coerce_target) def save(self): # Saves the form and returns the m.AdjudicatorFeedback object - da = self.cleaned_data['debate_adjudicator'] - st = DebateTeam.objects.get(team=source, debate=da.debate) - kwargs = dict(adjudicator=da.adjudicator, source_adjudicator=None, source_team=st) + debate, target = self.cleaned_data['target'] + st = DebateTeam.objects.get(team=source, debate=debate) + kwargs = dict(adjudicator=target, source_adjudicator=None, source_team=st) kwargs.update(submission_fields) return self.save_adjudicatorfeedback(**kwargs) return FeedbackForm - diff --git a/adjfeedback/management/commands/generatefeedback.py b/tabbycat/adjfeedback/management/commands/generatefeedback.py similarity index 65% rename from adjfeedback/management/commands/generatefeedback.py rename to tabbycat/adjfeedback/management/commands/generatefeedback.py index b27803595e2..656031364ea 100644 --- a/adjfeedback/management/commands/generatefeedback.py +++ b/tabbycat/adjfeedback/management/commands/generatefeedback.py @@ -1,10 +1,10 @@ -from utils.management.base import RoundCommand, CommandError -from ...dbutils import add_feedback, add_feedback_to_round, delete_all_feedback_for_round, delete_feedback - from django.contrib.auth import get_user_model -from tournaments.models import Round -from draw.models import Debate + from adjfeedback.models import AdjudicatorFeedback +from draw.models import Debate +from utils.management.base import CommandError, RoundCommand + +from ...dbutils import add_feedback, add_feedback_to_round, delete_all_feedback_for_round, delete_feedback OBJECT_TYPE_CHOICES = ["round", "debate"] SUBMITTER_TYPE_MAP = { @@ -13,6 +13,7 @@ } User = get_user_model() + class Command(RoundCommand): help = "Adds randomly-generated feedback to the database" @@ -20,17 +21,32 @@ class Command(RoundCommand): def add_arguments(self, parser): super(Command, self).add_arguments(parser) - parser.add_argument("--debates", type=int, nargs="+", help="IDs of specific debates to add feedback to. Done in addition to rounds, if any.", default=[]) - parser.add_argument("-p", "--probability", type=float, help="Probability with which to add feedback", default=1.0) - parser.add_argument("-T", "--submitter-type", type=str, help="Submitter type, either 'tabroom' or 'public'", choices=list(SUBMITTER_TYPE_MAP.keys()), default="tabroom") - parser.add_argument("-u", "--user", type=str, help="Username of submitter", default="random") + parser.add_argument("--debates", type=int, nargs="+", + help="IDs of specific debates to add feedback to. " + "Done in addition to rounds, if any.", + default=[]) + parser.add_argument("-p", "--probability", type=float, + help="Probability with which to add feedback", + default=1.0) + parser.add_argument("-T", "--submitter-type", type=str, + help="Submitter type, either 'tabroom' or 'public'", + choices=list(SUBMITTER_TYPE_MAP.keys()), + default="tabroom") + parser.add_argument("-u", "--user", type=str, + help="Username of submitter", default="random") status = parser.add_mutually_exclusive_group() - status.add_argument("-D", "--discarded", action="store_true", help="Make feedback discarded") - status.add_argument("-c", "--confirmed", action="store_true", help="Make feedback confirmed") - - parser.add_argument("--clean", help="Remove all associated feedback first", action="store_true") - parser.add_argument("--create-user", help="Create user if it doesn't exist", action="store_true") + status.add_argument("-D", "--discarded", action="store_true", + help="Make feedback discarded") + status.add_argument("-c", "--confirmed", action="store_true", + help="Make feedback confirmed") + + parser.add_argument("--clean", + help="Remove all associated feedback first", + action="store_true") + parser.add_argument("--create-user", + help="Create user if it doesn't exist", + action="store_true") @staticmethod def _get_user(options): @@ -58,14 +74,17 @@ def handle(self, *args, **options): if not self.get_rounds(options) and not options["debates"]: raise CommandError("No rounds or debates were given. (Use --help for more info.)") - super(Command, self).handle(*args, **options) # handles rounds + super(Command, self).handle(*args, **options) # Handles rounds for tournament in self.get_tournaments(options): for debate_id in options["debates"]: try: debate = Debate.objects.get(round__tournament=tournament, id=debate_id) except Debate.DoesNotExist: - self.stdout.write(self.style.WARNING("Warning: There is no debate with id {:d} for tournament {!r}, skipping".format(debate_id, tournament.slug))) + self.stdout.write( + self.style.WARNING("Warning: There is no debate with " + "id {:d} for tournament {!r}, " + "skipping".format(debate_id, tournament.slug))) self.handle_debate(debate, **options) def handle_round(self, round, **options): @@ -89,4 +108,3 @@ def handle_debate(self, debate, **options): add_feedback(debate, **self.feedback_kwargs(options)) except ValueError as e: raise CommandError(e) - diff --git a/adjfeedback/management/commands/printmultiplefeedback.py b/tabbycat/adjfeedback/management/commands/printmultiplefeedback.py similarity index 69% rename from adjfeedback/management/commands/printmultiplefeedback.py rename to tabbycat/adjfeedback/management/commands/printmultiplefeedback.py index ef65c78ff62..1a8d903baec 100644 --- a/adjfeedback/management/commands/printmultiplefeedback.py +++ b/tabbycat/adjfeedback/management/commands/printmultiplefeedback.py @@ -1,12 +1,15 @@ from utils.management.base import TournamentCommand + class Command(TournamentCommand): help = "Checks for feedback with more than one version." def add_arguments(self, parser): super(Command, self).add_arguments(parser) - parser.add_argument("--num", "-n", type=int, help="Show feedback with at least this many versions", default=2) + parser.add_argument( + "--num", "-n", type=int, + help="Show feedback with at least this many versions", default=2) def handle_tournament(self, tournament, **options): @@ -21,8 +24,9 @@ def handle_tournament(self, tournament, **options): source_team=feedback.source_team).order_by('version') num = others.count() if num >= options["num"]: - self.stdout.write(self.style.MIGRATE_HEADING(" *** Adjudicator: {0}, from: {1}, {2:d} versions".format(adj, feedback.source, num))) + self.stdout.write(self.style.MIGRATE_HEADING( + " *** Adjudicator: {0}, from: {1}, {2:d} versions".format(adj, feedback.source, num))) for other in others: self.stdout.write(" {id:>3} {submitter:<12} {round:<4} {c} {version} {score:.1f}".format( - score=other.score, version=other.version, round=other.round.abbreviation, submitter=other.submitter.username, - id=other.id, c="c" if other.confirmed else "-")) + score=other.score, version=other.version, round=other.round.abbreviation, submitter=other.submitter.username, + id=other.id, c="c" if other.confirmed else "-")) diff --git a/adjfeedback/migrations/0001_initial.py b/tabbycat/adjfeedback/migrations/0001_initial.py similarity index 100% rename from adjfeedback/migrations/0001_initial.py rename to tabbycat/adjfeedback/migrations/0001_initial.py diff --git a/adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py b/tabbycat/adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py similarity index 100% rename from adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py rename to tabbycat/adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py diff --git a/adjfeedback/migrations/0003_auto_20160103_1927.py b/tabbycat/adjfeedback/migrations/0003_auto_20160103_1927.py similarity index 100% rename from adjfeedback/migrations/0003_auto_20160103_1927.py rename to tabbycat/adjfeedback/migrations/0003_auto_20160103_1927.py diff --git a/adjfeedback/migrations/0004_auto_20160109_1834.py b/tabbycat/adjfeedback/migrations/0004_auto_20160109_1834.py similarity index 100% rename from adjfeedback/migrations/0004_auto_20160109_1834.py rename to tabbycat/adjfeedback/migrations/0004_auto_20160109_1834.py diff --git a/adjfeedback/migrations/0005_auto_20160228_1838.py b/tabbycat/adjfeedback/migrations/0005_auto_20160228_1838.py similarity index 100% rename from adjfeedback/migrations/0005_auto_20160228_1838.py rename to tabbycat/adjfeedback/migrations/0005_auto_20160228_1838.py diff --git a/tabbycat/adjfeedback/migrations/0006_auto_20160716_1245.py b/tabbycat/adjfeedback/migrations/0006_auto_20160716_1245.py new file mode 100644 index 00000000000..c4e37d9273c --- /dev/null +++ b/tabbycat/adjfeedback/migrations/0006_auto_20160716_1245.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.9.7 on 2016-07-16 12:45 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('adjfeedback', '0005_auto_20160228_1838'), + ] + + operations = [ + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='chair_on_panellist', + field=models.BooleanField(help_text='Despite the name, applies to all adjudicator-on-adjudicator feedback'), + ), + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_chair', + field=models.BooleanField(help_text='Not currently used, reserved for future use'), + ), + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_panellist', + field=models.BooleanField(help_text='Not currently used, reserved for future use'), + ), + ] diff --git a/tabbycat/adjfeedback/migrations/0007_from_adj_from_team.py b/tabbycat/adjfeedback/migrations/0007_from_adj_from_team.py new file mode 100644 index 00000000000..2e43c36ec87 --- /dev/null +++ b/tabbycat/adjfeedback/migrations/0007_from_adj_from_team.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.9.7 on 2016-07-26 20:04 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('adjfeedback', '0006_auto_20160716_1245'), + ] + + operations = [ + migrations.RenameField( + model_name='adjudicatorfeedbackquestion', + old_name='chair_on_panellist', + new_name='from_adj', + ), + migrations.RenameField( + model_name='adjudicatorfeedbackquestion', + old_name='team_on_orallist', + new_name='from_team', + ), + migrations.RemoveField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_chair', + ), + migrations.RemoveField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_panellist', + ), + ] diff --git a/tabbycat/adjfeedback/migrations/0008_auto_20160726_2007.py b/tabbycat/adjfeedback/migrations/0008_auto_20160726_2007.py new file mode 100644 index 00000000000..95f4c7313d0 --- /dev/null +++ b/tabbycat/adjfeedback/migrations/0008_auto_20160726_2007.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.9.7 on 2016-07-26 20:07 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('adjfeedback', '0007_from_adj_from_team'), + ] + + operations = [ + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='from_adj', + field=models.BooleanField(help_text='Adjudicators should be asked this question (about other adjudicators)'), + ), + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='from_team', + field=models.BooleanField(help_text='Teams should be asked this question'), + ), + ] diff --git a/adjfeedback/migrations/__init__.py b/tabbycat/adjfeedback/migrations/__init__.py similarity index 100% rename from adjfeedback/migrations/__init__.py rename to tabbycat/adjfeedback/migrations/__init__.py diff --git a/adjfeedback/models.py b/tabbycat/adjfeedback/models.py similarity index 88% rename from adjfeedback/models.py rename to tabbycat/adjfeedback/models.py index 56f1f9a1af6..d98e1b798c0 100644 --- a/adjfeedback/models.py +++ b/tabbycat/adjfeedback/models.py @@ -2,8 +2,8 @@ from django.db import models from django.utils.functional import cached_property -from results.models import Submission from adjallocation.models import DebateAdjudicator +from results.models import Submission class AdjudicatorTestScoreHistory(models.Model): @@ -97,19 +97,15 @@ class AdjudicatorFeedbackQuestion(models.Model): help_text="The order in which questions are displayed") text = models.CharField( max_length=255, - help_text= - "The question displayed to participants, e.g., \"Did you agree with the decision?\"") + help_text="The question displayed to participants, e.g., \"Did you agree with the decision?\"") name = models.CharField( max_length=30, - help_text= - "A short name for the question, e.g., \"Agree with decision\"") + help_text="A short name for the question, e.g., \"Agree with decision\"") reference = models.SlugField( help_text="Code-compatible reference, e.g., \"agree_with_decision\"") - chair_on_panellist = models.BooleanField() - panellist_on_chair = models.BooleanField() # for future use - panellist_on_panellist = models.BooleanField() # for future use - team_on_orallist = models.BooleanField() + from_adj = models.BooleanField(help_text="Adjudicators should be asked this question (about other adjudicators)") + from_team = models.BooleanField(help_text="Teams should be asked this question") answer_type = models.CharField(max_length=2, choices=ANSWER_TYPE_CHOICES) required = models.BooleanField( @@ -118,19 +114,16 @@ class AdjudicatorFeedbackQuestion(models.Model): min_value = models.FloatField( blank=True, null=True, - help_text= - "Minimum allowed value for numeric fields (ignored for text or boolean fields)") + help_text="Minimum allowed value for numeric fields (ignored for text or boolean fields)") max_value = models.FloatField( blank=True, null=True, - help_text= - "Maximum allowed value for numeric fields (ignored for text or boolean fields)") + help_text="Maximum allowed value for numeric fields (ignored for text or boolean fields)") choices = models.CharField( max_length=500, blank=True, null=True, - help_text= - "Permissible choices for select one/multiple fields, separated by %r (ignored for other fields)" + help_text="Permissible choices for select one/multiple fields, separated by %r (ignored for other fields)" % CHOICE_SEPARATOR) class Meta: @@ -198,7 +191,7 @@ def debate_adjudicator(self): try: return self.adjudicator.debateadjudicator_set.get( debate=self.debate) - except DebateAdjudicator.DoesNotExist as e: + except DebateAdjudicator.DoesNotExist: return None @property @@ -215,6 +208,9 @@ def clean(self): if not (self.source_adjudicator or self.source_team): raise ValidationError( "Either the source adjudicator or source team wasn't specified.") + if self.source_adjudicator and self.source_team: + raise ValidationError( + "There was both a source adjudicator and a source team.") if self.adjudicator not in self.debate.adjudicators: - raise ValidationError("Adjudicator did not see this debate") - super(AdjudicatorFeedback, self).clean() + raise ValidationError("Adjudicator did not see this debate.") + return super(AdjudicatorFeedback, self).clean() diff --git a/tabbycat/adjfeedback/progress.py b/tabbycat/adjfeedback/progress.py new file mode 100644 index 00000000000..4a45599641a --- /dev/null +++ b/tabbycat/adjfeedback/progress.py @@ -0,0 +1,378 @@ +"""Utilities to compute which feedback has been submitted and not submitted +by participants of the tournament. + +There are a few possibilities for how to characterise a feedback submission: +""" + +import logging +from operator import attrgetter + +from adjallocation.models import DebateAdjudicator +from adjfeedback.models import AdjudicatorFeedback +from draw.models import DebateTeam +from results.prefetch import populate_confirmed_ballots +from tournaments.models import Round + +from .utils import expected_feedback_targets + +logger = logging.getLogger(__name__) + + +class BaseFeedbackExpectedSubmissionTracker: + """Represents a single piece of expected feedback.""" + + expected = True + + def __init__(self, source): + self.source = source # either a DebateTeam or a DebateAdjudicator + + @property + def round(self): + return self.source.debate.round + + @property + def count(self): + return len(self.acceptable_submissions()) + + @property + def fulfilled(self): + return self.count == 1 + + def acceptable_submissions(self): + if not hasattr(self, '_acceptable_submissions'): + self._acceptable_submissions = self.get_acceptable_submissions() + return self._acceptable_submissions + + def get_acceptable_submissions(self): + """Subclasses should override this method to provide an iterable of + acceptable submissions. Users of this class might pre-populate + the `_acceptable_submissions` attribute to avoid duplicate database + hits.""" + raise NotImplementedError + + def submission(self): + if self.fulfilled: + return self.acceptable_submissions()[0] + else: + return None + + +class FeedbackExpectedSubmissionFromTeamTracker(BaseFeedbackExpectedSubmissionTracker): + """Represents a single piece of expected feedback from a team.""" + + def __init__(self, source, enforce_orallist=True): + self.enforce_orallist = enforce_orallist + super().__init__(source) + + def acceptable_targets(self): + """For a team, this must be the adjudicator who delivered the oral + adjudication. If the chair was rolled, then it is one of the majority + adjudicators; if the chair was in the majority, then it must be the + chair.""" + + if self.enforce_orallist and self.source.debate.confirmed_ballot: + majority = self.source.debate.confirmed_ballot.ballot_set.majority_adj + chair = self.source.debate.adjudicators.chair + if chair in majority: + return [chair] + else: + return majority + else: + return list(self.source.debate.adjudicators.voting()) + + def get_acceptable_submissions(self): + return self.source.adjudicatorfeedback_set.filter(confirmed=True, + source_team=self.source, + adjudicator__in=self.acceptable_targets()).select_related( + 'source_team', 'adjudicator', 'adjudicator__institution') + + +class FeedbackExpectedSubmissionFromAdjudicatorTracker(BaseFeedbackExpectedSubmissionTracker): + """Represents a single piece of expected feedback from an adjudicator.""" + + def __init__(self, source, target): + self.target = target + return super().__init__(source) + + def get_acceptable_submissions(self): + return self.source.adjudicatorfeedback_set.filter(confirmed=True, + adjudicator=self.target, source_adjudicator=self.source).select_related( + 'source_adjudicator', 'adjudicator', 'adjudicator__institution') + + def acceptable_targets(self): + return [self.target] + + +class FeedbackUnexpectedSubmissionTracker: + """Represents a single piece of unexpected feedback.""" + + expected = False + fulfilled = False + + def __init__(self, feedback): + self.feedback = feedback # an AdjudicatorFeedback instance + + @property + def round(self): + return self.feedback.round + + @property + def count(self): + return 1 + + def submission(self): + return self.feedback + + +class BaseFeedbackProgress: + """Class to compute feedback submitted or owed by a participant. + + Rather than just counting and comparing aggregates, everything is compared + at the individual feedback level using objects called "trackers". This + ensures that feedbacks that were actually submitted match those that were + expected.""" + + def __init__(self, tournament): + self.show_unexpected = tournament.pref('show_unexpected_feedback') + + def get_expected_trackers(self): + raise NotImplementedError + + def get_submitted_feedback(self): + raise NotImplementedError + + def expected_trackers(self): + if not hasattr(self, "_expected_trackers"): + self._expected_trackers = self.get_expected_trackers() + return self._expected_trackers + + def submitted_feedback(self): + if not hasattr(self, "_submitted_feedback"): + self._submitted_feedback = self.get_submitted_feedback() + return self._submitted_feedback + + def expected_feedback(self): + """Returns a list of AdjudicatorFeedback objects that are submitted + as expected (including where more are submitted than expected).""" + return [feedback for tracker in self.expected_trackers() + for feedback in tracker.acceptable_submissions()] + + def unexpected_trackers(self): + """Returns a list of trackers for feedback that was submitted but not + expected to be there.""" + if self.show_unexpected: + return [FeedbackUnexpectedSubmissionTracker(feedback) for feedback in + self.submitted_feedback() if feedback not in self.expected_feedback()] + else: + return [] + + def fulfilled_trackers(self): + """Returns a list of trackers that are fulfilled.""" + return [tracker for tracker in self.expected_trackers() if tracker.fulfilled] + + def trackers(self): + """Returns a list of all trackers, sorted by round.""" + return sorted(self.expected_trackers() + self.unexpected_trackers(), + key=lambda x: x.round.seq) + + def num_submitted(self): + """Returns the number of feedbacks that were submitted, including + duplicate and unexpected submissions.""" + return len(self.submitted_feedback()) + + def num_expected(self): + """Returns the number of feedbacks that are expected from this participant.""" + return len(self.expected_trackers()) + + def num_fulfilled(self): + """Returns the number of feedbacks that are correctly submitted, + excluding those where more than one feedback was submitted but only + one was expected.""" + return len(self.fulfilled_trackers()) + + def num_unsubmitted(self): + return self.num_expected() - self.num_fulfilled() + + def coverage(self): + """Returns the number of fulfilled feedbacks divided by the number + of expected feedbacks.""" + if self.num_expected() == 0: + return 1.0 + return self.num_fulfilled() / self.num_expected() + + def _prefetch_tracker_acceptable_submissions(self, trackers, tracker_identifier, feedback_identifier): + trackers_by_identifier = {} + for tracker in trackers: + tracker._acceptable_submissions = [] + identifier = tracker_identifier(tracker) + trackers_by_identifier[identifier] = tracker + for feedback in self.submitted_feedback(): + identifier = feedback_identifier(feedback) + try: + tracker = trackers_by_identifier[identifier] + except KeyError: + continue + if feedback.adjudicator in tracker.acceptable_targets(): + tracker._acceptable_submissions.append(feedback) + + +class FeedbackProgressForTeam(BaseFeedbackProgress): + """Class to compute feedback submitted or owed by a team.""" + + def __init__(self, team, tournament=None): + self.team = team + if tournament is None: + tournament = team.tournament + self.enforce_orallist = tournament.pref("show_splitting_adjudicators") + super().__init__(tournament) + + @staticmethod + def _submitted_feedback_queryset_operations(queryset): + # this is also used by get_feedback_progress + return queryset.filter(confirmed=True, + source_team__debate__round__stage=Round.STAGE_PRELIMINARY).select_related( + 'adjudicator', 'adjudicator__institution', 'source_team__debate__round') + + def get_submitted_feedback(self): + queryset = AdjudicatorFeedback.objects.filter(source_team__team=self.team) + return self._submitted_feedback_queryset_operations(queryset) + + @staticmethod + def _debateteam_queryset_operations(queryset): + # this is also used by get_feedback_progress + debateteams = queryset.filter( + debate__ballotsubmission__confirmed=True, + debate__round__silent=False, + debate__round__stage=Round.STAGE_PRELIMINARY + ).select_related('debate', 'debate__round').prefetch_related( + 'debate__debateadjudicator_set__adjudicator') + populate_confirmed_ballots([dt.debate for dt in debateteams], ballotsets=True) + return debateteams + + def _get_debateteams(self): + if not hasattr(self, '_debateteams'): + self._debateteams = self._debateteam_queryset_operations(self.team.debateteam_set) + return self._debateteams + + def get_expected_trackers(self): + # There is one tracker for each debate for which there is a confirmed ballot, + # and the round is not silent. + + debateteams = self._get_debateteams() + trackers = [FeedbackExpectedSubmissionFromTeamTracker(dt, self.enforce_orallist) for dt in debateteams] + self._prefetch_tracker_acceptable_submissions(trackers, + attrgetter('source'), attrgetter('source_team')) + return trackers + + +class FeedbackProgressForAdjudicator(BaseFeedbackProgress): + """Class to compute feedback submitted or owed by an adjudicator.""" + + def __init__(self, adjudicator, tournament=None): + self.adjudicator = adjudicator + if tournament is None: + tournament = adjudicator.tournament + if tournament is None: + logger.warning("No tournament specified and adjudicator %s has no tournament", adjudicator) + else: + self.feedback_paths = tournament.pref('feedback_paths') + super().__init__(tournament) + + @staticmethod + def _submitted_feedback_queryset_operations(queryset): + # this is also used by get_feedback_progress + return queryset.filter(confirmed=True, + source_adjudicator__debate__round__stage=Round.STAGE_PRELIMINARY).select_related( + 'adjudicator', 'adjudicator__institution', 'source_adjudicator__debate__round') + + def get_submitted_feedback(self): + queryset = AdjudicatorFeedback.objects.filter(source_adjudicator__adjudicator=self.adjudicator) + return self._submitted_feedback_queryset_operations(queryset) + + @staticmethod + def _debateadjudicator_queryset_operations(queryset): + # this is also used by get_feedback_progress + return queryset.filter( + debate__ballotsubmission__confirmed=True, + debate__round__stage=Round.STAGE_PRELIMINARY + ).select_related('debate', 'debate__round').prefetch_related( + 'debate__debateadjudicator_set__adjudicator') + + def _get_debateadjudicators(self): + if not hasattr(self, '_debateadjudicators'): + self._debateadjudicators = self._debateadjudicator_queryset_operations(self.adjudicator.debateadjudicator_set) + return self._debateadjudicators + + def get_expected_trackers(self): + """Trackers are as follows: + - Chairs owe on everyone in their panel. + - Panellists owe on chairs if the relevant tournament preference is enabled. + """ + debateadjs = self._get_debateadjudicators() + + trackers = [] + for debateadj in debateadjs: + for target, _ in expected_feedback_targets(debateadj, self.feedback_paths): + trackers.append(FeedbackExpectedSubmissionFromAdjudicatorTracker(debateadj, target)) + + self._prefetch_tracker_acceptable_submissions(trackers, + attrgetter('source', 'target'), attrgetter('source_adjudicator', 'adjudicator')) + + return trackers + + +def get_feedback_progress(t): + """Returns a list of FeedbackProgressForTeam objects and a list of + FeedbackProgressForAdjudicator objects. + + This function pre-populates the FeedbackProgress objects to avoid needing + duplicate SQL queries for every team and adjudicator, so it should be used + for performance when the feedback progress of all teams and adjudicators is + needed.""" + + teams_progress = [] + adjs_progress = [] + + teams = t.team_set.prefetch_related('speaker_set').all() + + submitted_feedback_by_team_id = {team.id: [] for team in teams} + submitted_feedback_teams = AdjudicatorFeedback.objects.filter( + source_team__team__in=teams).select_related('source_team') + submitted_feedback_teams = FeedbackProgressForTeam._submitted_feedback_queryset_operations(submitted_feedback_teams) + for feedback in submitted_feedback_teams: + submitted_feedback_by_team_id[feedback.source_team.team_id].append(feedback) + + debateteams_by_team_id = {team.id: [] for team in teams} + debateteams = DebateTeam.objects.filter(team__in=teams) + debateteams = FeedbackProgressForTeam._debateteam_queryset_operations(debateteams) + for debateteam in debateteams: + debateteams_by_team_id[debateteam.team_id].append(debateteam) + + for team in teams: + progress = FeedbackProgressForTeam(team) + progress._submitted_feedback = submitted_feedback_by_team_id[team.id] + progress._debateteams = debateteams_by_team_id[team.id] + teams_progress.append(progress) + + adjudicators = t.adjudicator_set.all() + + submitted_feedback_by_adj_id = {adj.id: [] for adj in adjudicators} + submitted_feedback_adjs = AdjudicatorFeedback.objects.filter( + source_adjudicator__adjudicator__in=adjudicators).select_related('source_adjudicator') + submitted_feedback_adjs = FeedbackProgressForAdjudicator._submitted_feedback_queryset_operations(submitted_feedback_adjs) + for feedback in submitted_feedback_adjs: + submitted_feedback_by_adj_id[feedback.source_adjudicator.adjudicator_id].append(feedback) + + debateadjs_by_adj_id = {adj.id: [] for adj in adjudicators} + debateadjs = DebateAdjudicator.objects.filter(adjudicator__in=adjudicators) + debateadjs = FeedbackProgressForAdjudicator._debateadjudicator_queryset_operations(debateadjs) + for debateadj in debateadjs: + debateadjs_by_adj_id[debateadj.adjudicator_id].append(debateadj) + + for adj in adjudicators: + progress = FeedbackProgressForAdjudicator(adj) + progress._submitted_feedback = submitted_feedback_by_adj_id[adj.id] + progress._debateadjudicators = debateadjs_by_adj_id[adj.id] + adjs_progress.append(progress) + + return teams_progress, adjs_progress diff --git a/tabbycat/adjfeedback/tables.py b/tabbycat/adjfeedback/tables.py new file mode 100644 index 00000000000..290d666d9e7 --- /dev/null +++ b/tabbycat/adjfeedback/tables.py @@ -0,0 +1,157 @@ +import logging + +from utils.misc import reverse_tournament +from utils.tables import TabbycatTableBuilder + +from .progress import FeedbackProgressForAdjudicator, FeedbackProgressForTeam + +logger = logging.getLogger(__name__) + + +class FeedbackTableBuilder(TabbycatTableBuilder): + + def add_breaking_checkbox(self, adjudicators, key="Breaking"): + breaking_header = { + 'key': 'B', + 'icon': 'glyphicon-star', + 'tooltip': 'Whether the adj is marked as breaking (click to mark)', + } + breaking_data = [{ + 'text': '' % (adj.id, 'checked' if adj.breaking else ''), + 'sort': adj.breaking, + 'class': 'checkbox-target' + } for adj in adjudicators] + + self.add_column(breaking_header, breaking_data) + + def add_score_columns(self, adjudicators): + + feedback_weight = self.tournament.current_round.feedback_weight + scores = {adj: adj.weighted_score(feedback_weight) for adj in adjudicators} + + overall_header = { + 'key': 'Overall Score', + 'icon': 'glyphicon-signal', + 'tooltip': 'Current weighted score', + } + overall_data = [{ + 'text': '%0.1f' % scores[adj] if scores[adj] is not None else 'N/A', + 'tooltip': 'Current weighted average of all feedback', + } for adj in adjudicators] + self.add_column(overall_header, overall_data) + + test_header = { + 'key': 'Test Score', + 'icon': 'glyphicon-scale', + 'tooltip': 'Test score result', + } + test_data = [{ + 'text': '%0.1f' % adj.test_score if adj.test_score is not None else 'N/A', + 'modal': adj.id, + 'class': 'edit-test-score', + 'tooltip': 'Click to edit test score', + } for adj in adjudicators] + self.add_column(test_header, test_data) + + def add_feedback_graphs(self, adjudicators): + feedback_head = { + 'key': 'Feedback', + 'text': 'Feedback as Chair ' + + ' Panellist ' + + ' Trainee ' + } + feedback_data = [{ + 'graphData': adj.feedback_data, + 'component': 'feedback-trend', + 'minScore': self.tournament.pref('adj_min_score'), + 'maxScore': self.tournament.pref('adj_max_score'), + 'roundSeq': len(self.tournament.prelim_rounds()), + } for adj in adjudicators] + self.add_column(feedback_head, feedback_data) + + def add_feedback_link_columns(self, adjudicators): + link_head = { + 'key': 'VF', + 'icon': 'glyphicon-question-sign' + } + link_cell = [{ + 'text': 'View
Feedback', + 'class': 'view-feedback', + 'link': reverse_tournament('adjfeedback-view-on-adjudicator', self.tournament, kwargs={'pk': adj.pk}) + } for adj in adjudicators] + self.add_column(link_head, link_cell) + + def add_feedback_misc_columns(self, adjudicators): + if self.tournament.pref('enable_adj_notes'): + note_head = { + 'key': 'NO', + 'icon': 'glyphicon-list-alt' + } + note_cell = [{ + 'text': 'Edit
Note', + 'class': 'edit-note', + 'modal': str(adj.id) + '===' + str(adj.notes) + } for adj in adjudicators] + self.add_column(note_head, note_cell) + + adjudications_head = { + 'key': 'DD', + 'icon': 'glyphicon-eye-open', + 'tooltip': 'Debates adjudicated' + } + adjudications_cell = [{'text': adj.debates} for adj in adjudicators] + self.add_column(adjudications_head, adjudications_cell) + + avgs_head = { + 'key': 'AVGS', + 'icon': 'glyphicon-resize-full', + 'tooltip': 'Average Margin (top) and Average Score (bottom)' + } + avgs_cell = [{ + 'text': "%0.1f
%0.1f" % (adj.avg_margin if adj.avg_margin else 0, adj.avg_score if adj.avg_margin else 0), + 'tooltip': 'Average Margin (top) and Average Score (bottom)' + } for adj in adjudicators] + self.add_column(avgs_head, avgs_cell) + + def add_feedback_progress_columns(self, progress_list, key="P"): + + def _owed_cell(progress): + owed = progress.num_unsubmitted() + cell = { + 'text': owed, + 'sort': owed, + 'class': 'text-danger strong' if owed > 0 else 'text-success' + } + return cell + + owed_header = { + 'key': 'Owed', + 'icon': 'glyphicon-remove', + 'tooltip': 'Unsubmitted feedback ballots', + } + owed_data = [_owed_cell(progress) for progress in progress_list] + self.add_column(owed_header, owed_data) + + if self._show_record_links: + + def _record_link(progress): + if isinstance(progress, FeedbackProgressForTeam): + url_name = 'participants-team-record' if self.admin else 'participants-public-team-record' + pk = progress.team.pk + elif isinstance(progress, FeedbackProgressForAdjudicator): + url_name = 'participants-adjudicator-record' if self.admin else 'participants-public-adjudicator-record' + pk = progress.adjudicator.pk + else: + logger.error("Unrecognised progress type: %s", progress.__class__.__name__) + return '' + return reverse_tournament(url_name, self.tournament, kwargs={'pk': pk}) + + owed_link_header = { + 'key': 'Submitted', + 'icon': 'glyphicon-question-sign', + } + owed_link_data = [{ + 'text': 'View Missing Feedback', + 'link': _record_link(progress) + } for progress in progress_list] + self.add_column(owed_link_header, owed_link_data) diff --git a/adjfeedback/templates/add_feedback.html b/tabbycat/adjfeedback/templates/add_feedback.html similarity index 65% rename from adjfeedback/templates/add_feedback.html rename to tabbycat/adjfeedback/templates/add_feedback.html index 5b22a678e33..c35011512c7 100644 --- a/adjfeedback/templates/add_feedback.html +++ b/tabbycat/adjfeedback/templates/add_feedback.html @@ -1,24 +1,16 @@ -{% extends "base.html" %} +{% extends "feedback_base.html" %} {% load debate_tags %} +{% load static %} {% block head-title %}Who is the feedback from?{% endblock %} {% block page-title %}Enter Feedback{% endblock %} -{% block page-subnav-sections %} - - {% include "tables/table_search.html" %} -{% endblock %} - {% block content %}
@@ -53,7 +45,7 @@
| Unused Adjudicators | @@ -199,39 +199,42 @@ - - + {% endblock content %} -{% block extra-js %} +{% block extra-css %} + + +{% endblock extra-css %} + +{% block js %} + {{ block.super }} + -{% endblock extra-js %} +{% endblock js %} diff --git a/tabbycat/adjallocation/templates/edit_adj_allocation.html b/tabbycat/adjallocation/templates/edit_adj_allocation.html new file mode 100644 index 00000000000..ae694690927 --- /dev/null +++ b/tabbycat/adjallocation/templates/edit_adj_allocation.html @@ -0,0 +1,41 @@ +{% extends "base.html" %} +{% load debate_tags %} + +{% block nav %}{% endblock %} +{% block header %}{% endblock %} +{% block subheader %}{% endblock %} +{% block footer %}{% endblock %} +{% block page-subnav-sections %}{% endblock page-subnav-sections %} + +{% block content %} + +
|---|
{choice_value}{sub_widgets}
'
+
class IntegerRadioSelect(forms.RadioSelect):
renderer = IntegerRadioFieldRenderer
+
class IntegerScaleField(forms.IntegerField):
"""Class to do integer scale fields."""
widget = IntegerRadioSelect
@@ -33,6 +48,7 @@ def __init__(self, *args, **kwargs):
super(IntegerScaleField, self).__init__(*args, **kwargs)
self.widget.choices = tuple((i, str(i)) for i in range(self.min_value, self.max_value+1))
+
class BlankUnknownBooleanSelect(forms.NullBooleanSelect):
"""Uses '--------' instead of 'Unknown' for the None choice."""
@@ -43,16 +59,19 @@ def __init__(self, attrs=None):
# skip the NullBooleanSelect constructor
super(forms.NullBooleanSelect, self).__init__(attrs, choices)
+
class BooleanSelectField(forms.NullBooleanField):
"""Widget to do boolean select fields following our conventions.
Specifically, if 'required', checks that an option was chosen."""
widget = BlankUnknownBooleanSelect
+
def clean(self, value):
value = super(BooleanSelectField, self).clean(value)
if self.required and value is None:
raise forms.ValidationError(_("This field is required."))
return value
+
class RequiredTypedChoiceField(forms.TypedChoiceField):
def clean(self, value):
value = super(RequiredTypedChoiceField, self).clean(value)
@@ -60,16 +79,21 @@ def clean(self, value):
raise forms.ValidationError(_("This field is required."))
return value
+
+# ==============================================================================
# Feedback Fields
+# ==============================================================================
class AdjudicatorFeedbackCheckboxFieldRenderer(forms.widgets.CheckboxFieldRenderer):
"""Used by AdjudicatorFeedbackCheckboxSelectMultiple."""
outer_html = '{choice_value}{sub_widgets}
'
+
class AdjudicatorFeedbackCheckboxSelectMultiple(forms.CheckboxSelectMultiple):
renderer = AdjudicatorFeedbackCheckboxFieldRenderer
+
class AdjudicatorFeedbackCheckboxSelectMultipleField(forms.MultipleChoiceField):
"""Class to do multiple choice fields following our conventions.
Specifically, converts to a string rather than a list."""
@@ -79,14 +103,17 @@ def clean(self, value):
value = super(AdjudicatorFeedbackCheckboxSelectMultipleField, self).clean(value)
return AdjudicatorFeedbackQuestion.CHOICE_SEPARATOR.join(value)
+
+# ==============================================================================
# Feedback Forms
+# ==============================================================================
class BaseFeedbackForm(forms.Form):
"""Base class for all dynamically-created feedback forms. Contains all
question fields."""
# parameters set at "compile time" by subclasses
- tournament = None # must be set by subclasses
+ _tournament = None # must be set by subclasses
_use_tournament_password = False
_confirm_on_submit = False
_enforce_required = True
@@ -96,6 +123,13 @@ def __init__(self, *args, **kwargs):
super(BaseFeedbackForm, self).__init__(*args, **kwargs)
self._create_fields()
+ @staticmethod
+ def coerce_target(value):
+ debate_id, adj_id = value.split('-')
+ debate = Debate.objects.get(id=int(debate_id))
+ adjudicator = Adjudicator.objects.get(id=int(adj_id))
+ return debate, adjudicator
+
def _make_question_field(self, question):
if question.answer_type == question.ANSWER_TYPE_BOOLEAN_SELECT:
field = BooleanSelectField()
@@ -114,8 +148,7 @@ def _make_question_field(self, question):
else:
field = IntegerScaleField(min_value=min_value, max_value=max_value)
elif question.answer_type == question.ANSWER_TYPE_FLOAT:
- field = forms.FloatField(min_value=question.min_value,
- max_value=question.max_value)
+ field = forms.FloatField(min_value=question.min_value, max_value=question.max_value)
elif question.answer_type == question.ANSWER_TYPE_TEXT:
field = forms.CharField()
elif question.answer_type == question.ANSWER_TYPE_LONGTEXT:
@@ -133,17 +166,17 @@ def _make_question_field(self, question):
def _create_fields(self):
"""Creates dynamic fields in the form."""
# Feedback questions defined for the tournament
- adj_min_score = self.tournament.pref('adj_min_score')
- adj_max_score = self.tournament.pref('adj_max_score')
+ adj_min_score = self._tournament.pref('adj_min_score')
+ adj_max_score = self._tournament.pref('adj_max_score')
score_label = mark_safe("Overall score(%s=lowest, %s=highest)" % (adj_min_score, adj_max_score)) self.fields['score'] = forms.FloatField(min_value=adj_min_score, max_value=adj_max_score, label=score_label) - for question in self.tournament.adj_feedback_questions.filter(**self.question_filter): + for question in self._tournament.adj_feedback_questions.filter(**self.question_filter): self.fields[question.reference] = self._make_question_field(question) # Tournament password field, if applicable - if self._use_tournament_password and self.tournament.pref('public_use_password'): - self.fields['password'] = TournamentPasswordField(tournament=self.tournament) + if self._use_tournament_password and self._tournament.pref('public_use_password'): + self.fields['password'] = TournamentPasswordField(tournament=self._tournament) def save_adjudicatorfeedback(self, **kwargs): """Saves the question fields and returns the AdjudicatorFeedback. @@ -152,17 +185,17 @@ def save_adjudicatorfeedback(self, **kwargs): if self._confirm_on_submit: self.discard_all_existing(adjudicator=kwargs['adjudicator'], - source_adjudicator=kwargs['source_adjudicator'], - source_team=kwargs['source_team']) + source_adjudicator=kwargs['source_adjudicator'], + source_team=kwargs['source_team']) af.confirmed = True af.score = self.cleaned_data['score'] af.save() - for question in self.tournament.adj_feedback_questions.filter(**self.question_filter): + for question in self._tournament.adj_feedback_questions.filter(**self.question_filter): if self.cleaned_data[question.reference] is not None: - answer = question.answer_type_class(feedback=af, question=question, - answer=self.cleaned_data[question.reference]) + answer = question.answer_type_class( + feedback=af, question=question, answer=self.cleaned_data[question.reference]) answer.save() return af @@ -172,7 +205,8 @@ def discard_all_existing(self, **kwargs): fb.discarded = True fb.save() -def make_feedback_form_class(source, *args, **kwargs): + +def make_feedback_form_class(source, tournament, *args, **kwargs): """Constructs a FeedbackForm class specific to the given source. 'source' is the Adjudicator or Team who is giving feedback. 'submission_fields' is a dict of fields that is passed directly as keyword @@ -180,111 +214,109 @@ def make_feedback_form_class(source, *args, **kwargs): 'confirm_on_submit' is a bool, and indicates that this feedback should be as confirmed and all others discarded.""" if isinstance(source, Adjudicator): - return make_feedback_form_class_for_adj(source, *args, **kwargs) + return make_feedback_form_class_for_adj(source, tournament, *args, **kwargs) elif isinstance(source, Team): - return make_feedback_form_class_for_team(source, *args, **kwargs) + return make_feedback_form_class_for_team(source, tournament, *args, **kwargs) else: raise TypeError('source must be Adjudicator or Team: %r' % source) -def make_feedback_form_class_for_adj(source, submission_fields, confirm_on_submit=False, - enforce_required=True, include_unreleased_draws=False): + +def make_feedback_form_class_for_adj(source, tournament, submission_fields, confirm_on_submit=False, + enforce_required=True, include_unreleased_draws=False): """Constructs a FeedbackForm class specific to the given source adjudicator. Parameters are as for make_feedback_form_class.""" - def adj_choice(da): - return (da.id, '%s (%s, %s)' % (da.adjudicator.name, - da.debate.round.name, da.get_type_display())) - def coerce_da(value): - return DebateAdjudicator.objects.get(id=int(value)) + def adj_choice(adj, debate, pos): + value = '%d-%d' % (debate.id, adj.id) + display = '%s (%s, %s)' % (adj.name, debate.round.name, ADJUDICATOR_POSITION_NAMES[pos]) + return (value, display) + + debateadjs = DebateAdjudicator.objects.filter( + debate__round__tournament=tournament, adjudicator=source, + debate__round__seq__lte=tournament.current_round.seq, + debate__round__stage=Round.STAGE_PRELIMINARY + ).order_by('-debate__round__seq').prefetch_related( + 'debate__debateadjudicator_set__adjudicator' + ) - debate_filter = {'debateadjudicator__adjudicator': source} - if not source.tournament.pref('panellist_feedback_enabled'): - debate_filter['debateadjudicator__type'] = DebateAdjudicator.TYPE_CHAIR # include only debates for which this adj was the chair if include_unreleased_draws: - debate_filter['round__draw_status__in'] = [Round.STATUS_CONFIRMED, Round.STATUS_RELEASED] + debateadjs = debateadjs.filter(debate__round__draw_status__in=[Round.STATUS_CONFIRMED, Round.STATUS_RELEASED]) else: - debate_filter['round__draw_status'] = Round.STATUS_RELEASED - debates = Debate.objects.filter(**debate_filter) + debateadjs = debateadjs.filter(debate__round__draw_status=Round.STATUS_RELEASED) choices = [(None, '-- Adjudicators --')] - # for an adjudicator, find every adjudicator on their panel except them - choices.extend(adj_choice(da) for da in DebateAdjudicator.objects.filter( - debate__in=debates).exclude( - adjudicator=source).select_related( - 'debate').order_by( - '-debate__round__seq')) + for debateadj in debateadjs: + targets = expected_feedback_targets(debateadj, tournament.pref('feedback_paths')) + for target, pos in targets: + choices.append(adj_choice(target, debateadj.debate, pos)) class FeedbackForm(BaseFeedbackForm): - tournament = source.tournament # BaseFeedbackForm setting - _use_tournament_password = True # BaseFeedbackForm setting + _tournament = tournament # BaseFeedbackForm setting + _use_tournament_password = True # BaseFeedbackForm setting _confirm_on_submit = confirm_on_submit _enforce_required = enforce_required - question_filter = dict(chair_on_panellist=True) + question_filter = dict(from_adj=True) - debate_adjudicator = RequiredTypedChoiceField(choices=choices, coerce=coerce_da) + target = RequiredTypedChoiceField(choices=choices, coerce=BaseFeedbackForm.coerce_target, label='Adjudicator this feedback is about') def save(self): """Saves the form and returns the AdjudicatorFeedback object.""" - da = self.cleaned_data['debate_adjudicator'] - sa = DebateAdjudicator.objects.get(adjudicator=source, debate=da.debate) - kwargs = dict(adjudicator=da.adjudicator, source_adjudicator=sa, source_team=None) + debate, target = self.cleaned_data['target'] + sa = DebateAdjudicator.objects.get(adjudicator=source, debate=debate) + kwargs = dict(adjudicator=target, source_adjudicator=sa, source_team=None) kwargs.update(submission_fields) return self.save_adjudicatorfeedback(**kwargs) return FeedbackForm -def make_feedback_form_class_for_team(source, submission_fields, confirm_on_submit=False, - enforce_required=True, include_unreleased_draws=False): + +def make_feedback_form_class_for_team(source, tournament, submission_fields, confirm_on_submit=False, + enforce_required=True, include_unreleased_draws=False): """Constructs a FeedbackForm class specific to the given source team. Parameters are as for make_feedback_form_class.""" + def adj_choice(adj, debate, pos): + value = '%d-%d' % (debate.id, adj.id) + if pos == AdjudicatorAllocation.POSITION_CHAIR: + pos_text = '—chair gave oral' + elif pos == AdjudicatorAllocation.POSITION_PANELLIST: + pos_text = '—chair rolled, this panellist gave oral' + elif pos == AdjudicatorAllocation.POSITION_ONLY: + pos_text = '' + display = '{name} ({r}{pos})'.format(name=adj.name, r=debate.round.name, pos=pos_text) + return (value, display) + # Only include non-silent rounds for teams. - debate_filter = { - 'debateteam__team': source, - 'round__silent': False, - } + debates = Debate.objects.filter( + debateteam__team=source, round__silent=False, + round__seq__lte=tournament.current_round.seq, + round__stage=Round.STAGE_PRELIMINARY + ).order_by('-round__seq').prefetch_related('debateadjudicator_set__adjudicator') if include_unreleased_draws: - debate_filter['round__draw_status__in'] = [Round.STATUS_CONFIRMED, Round.STATUS_RELEASED] + debates = debates.filter(round__draw_status__in=[Round.STATUS_CONFIRMED, Round.STATUS_RELEASED]) else: - debate_filter['round__draw_status'] = Round.STATUS_RELEASED - debates = Debate.objects.filter(**debate_filter).order_by('-round__seq') + debates = debates.filter(round__draw_status=Round.STATUS_RELEASED) choices = [(None, '-- Adjudicators --')] for debate in debates: - try: - chair = DebateAdjudicator.objects.get(debate=debate, type=DebateAdjudicator.TYPE_CHAIR) - except DebateAdjudicator.DoesNotExist: - continue - panel = DebateAdjudicator.objects.filter(debate=debate, type=DebateAdjudicator.TYPE_PANEL) - if panel.exists(): - choices.append((chair.id, '{name} ({r} - chair gave oral)'.format( - name=chair.adjudicator.name, r=debate.round.name))) - for da in panel: - choices.append((da.id, '{name} ({r} - chair rolled, this panellist gave oral)'.format( - name=da.adjudicator.name, r=debate.round.name))) - else: - choices.append((chair.id, '{name} ({r})'.format( - name=chair.adjudicator.name, r=debate.round.name))) - - def coerce_da(value): - return DebateAdjudicator.objects.get(id=int(value)) + for adj, pos in debate.adjudicators.voting_with_positions(): + choices.append(adj_choice(adj, debate, pos)) class FeedbackForm(BaseFeedbackForm): - tournament = source.tournament # BaseFeedbackForm setting - _use_tournament_password = True # BaseFeedbackForm setting + _tournament = tournament # BaseFeedbackForm setting + _use_tournament_password = True # BaseFeedbackForm setting _confirm_on_submit = confirm_on_submit _enforce_required = enforce_required - question_filter = dict(team_on_orallist=True) + question_filter = dict(from_team=True) - debate_adjudicator = RequiredTypedChoiceField(choices=choices, coerce=coerce_da) + target = RequiredTypedChoiceField(choices=choices, coerce=BaseFeedbackForm.coerce_target) def save(self): # Saves the form and returns the m.AdjudicatorFeedback object - da = self.cleaned_data['debate_adjudicator'] - st = DebateTeam.objects.get(team=source, debate=da.debate) - kwargs = dict(adjudicator=da.adjudicator, source_adjudicator=None, source_team=st) + debate, target = self.cleaned_data['target'] + st = DebateTeam.objects.get(team=source, debate=debate) + kwargs = dict(adjudicator=target, source_adjudicator=None, source_team=st) kwargs.update(submission_fields) return self.save_adjudicatorfeedback(**kwargs) return FeedbackForm - diff --git a/adjfeedback/management/commands/generatefeedback.py b/tabbycat/adjfeedback/management/commands/generatefeedback.py similarity index 65% rename from adjfeedback/management/commands/generatefeedback.py rename to tabbycat/adjfeedback/management/commands/generatefeedback.py index b27803595e2..656031364ea 100644 --- a/adjfeedback/management/commands/generatefeedback.py +++ b/tabbycat/adjfeedback/management/commands/generatefeedback.py @@ -1,10 +1,10 @@ -from utils.management.base import RoundCommand, CommandError -from ...dbutils import add_feedback, add_feedback_to_round, delete_all_feedback_for_round, delete_feedback - from django.contrib.auth import get_user_model -from tournaments.models import Round -from draw.models import Debate + from adjfeedback.models import AdjudicatorFeedback +from draw.models import Debate +from utils.management.base import CommandError, RoundCommand + +from ...dbutils import add_feedback, add_feedback_to_round, delete_all_feedback_for_round, delete_feedback OBJECT_TYPE_CHOICES = ["round", "debate"] SUBMITTER_TYPE_MAP = { @@ -13,6 +13,7 @@ } User = get_user_model() + class Command(RoundCommand): help = "Adds randomly-generated feedback to the database" @@ -20,17 +21,32 @@ class Command(RoundCommand): def add_arguments(self, parser): super(Command, self).add_arguments(parser) - parser.add_argument("--debates", type=int, nargs="+", help="IDs of specific debates to add feedback to. Done in addition to rounds, if any.", default=[]) - parser.add_argument("-p", "--probability", type=float, help="Probability with which to add feedback", default=1.0) - parser.add_argument("-T", "--submitter-type", type=str, help="Submitter type, either 'tabroom' or 'public'", choices=list(SUBMITTER_TYPE_MAP.keys()), default="tabroom") - parser.add_argument("-u", "--user", type=str, help="Username of submitter", default="random") + parser.add_argument("--debates", type=int, nargs="+", + help="IDs of specific debates to add feedback to. " + "Done in addition to rounds, if any.", + default=[]) + parser.add_argument("-p", "--probability", type=float, + help="Probability with which to add feedback", + default=1.0) + parser.add_argument("-T", "--submitter-type", type=str, + help="Submitter type, either 'tabroom' or 'public'", + choices=list(SUBMITTER_TYPE_MAP.keys()), + default="tabroom") + parser.add_argument("-u", "--user", type=str, + help="Username of submitter", default="random") status = parser.add_mutually_exclusive_group() - status.add_argument("-D", "--discarded", action="store_true", help="Make feedback discarded") - status.add_argument("-c", "--confirmed", action="store_true", help="Make feedback confirmed") - - parser.add_argument("--clean", help="Remove all associated feedback first", action="store_true") - parser.add_argument("--create-user", help="Create user if it doesn't exist", action="store_true") + status.add_argument("-D", "--discarded", action="store_true", + help="Make feedback discarded") + status.add_argument("-c", "--confirmed", action="store_true", + help="Make feedback confirmed") + + parser.add_argument("--clean", + help="Remove all associated feedback first", + action="store_true") + parser.add_argument("--create-user", + help="Create user if it doesn't exist", + action="store_true") @staticmethod def _get_user(options): @@ -58,14 +74,17 @@ def handle(self, *args, **options): if not self.get_rounds(options) and not options["debates"]: raise CommandError("No rounds or debates were given. (Use --help for more info.)") - super(Command, self).handle(*args, **options) # handles rounds + super(Command, self).handle(*args, **options) # Handles rounds for tournament in self.get_tournaments(options): for debate_id in options["debates"]: try: debate = Debate.objects.get(round__tournament=tournament, id=debate_id) except Debate.DoesNotExist: - self.stdout.write(self.style.WARNING("Warning: There is no debate with id {:d} for tournament {!r}, skipping".format(debate_id, tournament.slug))) + self.stdout.write( + self.style.WARNING("Warning: There is no debate with " + "id {:d} for tournament {!r}, " + "skipping".format(debate_id, tournament.slug))) self.handle_debate(debate, **options) def handle_round(self, round, **options): @@ -89,4 +108,3 @@ def handle_debate(self, debate, **options): add_feedback(debate, **self.feedback_kwargs(options)) except ValueError as e: raise CommandError(e) - diff --git a/adjfeedback/management/commands/printmultiplefeedback.py b/tabbycat/adjfeedback/management/commands/printmultiplefeedback.py similarity index 69% rename from adjfeedback/management/commands/printmultiplefeedback.py rename to tabbycat/adjfeedback/management/commands/printmultiplefeedback.py index ef65c78ff62..1a8d903baec 100644 --- a/adjfeedback/management/commands/printmultiplefeedback.py +++ b/tabbycat/adjfeedback/management/commands/printmultiplefeedback.py @@ -1,12 +1,15 @@ from utils.management.base import TournamentCommand + class Command(TournamentCommand): help = "Checks for feedback with more than one version." def add_arguments(self, parser): super(Command, self).add_arguments(parser) - parser.add_argument("--num", "-n", type=int, help="Show feedback with at least this many versions", default=2) + parser.add_argument( + "--num", "-n", type=int, + help="Show feedback with at least this many versions", default=2) def handle_tournament(self, tournament, **options): @@ -21,8 +24,9 @@ def handle_tournament(self, tournament, **options): source_team=feedback.source_team).order_by('version') num = others.count() if num >= options["num"]: - self.stdout.write(self.style.MIGRATE_HEADING(" *** Adjudicator: {0}, from: {1}, {2:d} versions".format(adj, feedback.source, num))) + self.stdout.write(self.style.MIGRATE_HEADING( + " *** Adjudicator: {0}, from: {1}, {2:d} versions".format(adj, feedback.source, num))) for other in others: self.stdout.write(" {id:>3} {submitter:<12} {round:<4} {c} {version} {score:.1f}".format( - score=other.score, version=other.version, round=other.round.abbreviation, submitter=other.submitter.username, - id=other.id, c="c" if other.confirmed else "-")) + score=other.score, version=other.version, round=other.round.abbreviation, submitter=other.submitter.username, + id=other.id, c="c" if other.confirmed else "-")) diff --git a/adjfeedback/migrations/0001_initial.py b/tabbycat/adjfeedback/migrations/0001_initial.py similarity index 100% rename from adjfeedback/migrations/0001_initial.py rename to tabbycat/adjfeedback/migrations/0001_initial.py diff --git a/adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py b/tabbycat/adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py similarity index 100% rename from adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py rename to tabbycat/adjfeedback/migrations/0002_adjudicatortestscorehistory_adjudicator.py diff --git a/adjfeedback/migrations/0003_auto_20160103_1927.py b/tabbycat/adjfeedback/migrations/0003_auto_20160103_1927.py similarity index 100% rename from adjfeedback/migrations/0003_auto_20160103_1927.py rename to tabbycat/adjfeedback/migrations/0003_auto_20160103_1927.py diff --git a/adjfeedback/migrations/0004_auto_20160109_1834.py b/tabbycat/adjfeedback/migrations/0004_auto_20160109_1834.py similarity index 100% rename from adjfeedback/migrations/0004_auto_20160109_1834.py rename to tabbycat/adjfeedback/migrations/0004_auto_20160109_1834.py diff --git a/adjfeedback/migrations/0005_auto_20160228_1838.py b/tabbycat/adjfeedback/migrations/0005_auto_20160228_1838.py similarity index 100% rename from adjfeedback/migrations/0005_auto_20160228_1838.py rename to tabbycat/adjfeedback/migrations/0005_auto_20160228_1838.py diff --git a/tabbycat/adjfeedback/migrations/0006_auto_20160716_1245.py b/tabbycat/adjfeedback/migrations/0006_auto_20160716_1245.py new file mode 100644 index 00000000000..c4e37d9273c --- /dev/null +++ b/tabbycat/adjfeedback/migrations/0006_auto_20160716_1245.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.9.7 on 2016-07-16 12:45 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('adjfeedback', '0005_auto_20160228_1838'), + ] + + operations = [ + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='chair_on_panellist', + field=models.BooleanField(help_text='Despite the name, applies to all adjudicator-on-adjudicator feedback'), + ), + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_chair', + field=models.BooleanField(help_text='Not currently used, reserved for future use'), + ), + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_panellist', + field=models.BooleanField(help_text='Not currently used, reserved for future use'), + ), + ] diff --git a/tabbycat/adjfeedback/migrations/0007_from_adj_from_team.py b/tabbycat/adjfeedback/migrations/0007_from_adj_from_team.py new file mode 100644 index 00000000000..2e43c36ec87 --- /dev/null +++ b/tabbycat/adjfeedback/migrations/0007_from_adj_from_team.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.9.7 on 2016-07-26 20:04 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('adjfeedback', '0006_auto_20160716_1245'), + ] + + operations = [ + migrations.RenameField( + model_name='adjudicatorfeedbackquestion', + old_name='chair_on_panellist', + new_name='from_adj', + ), + migrations.RenameField( + model_name='adjudicatorfeedbackquestion', + old_name='team_on_orallist', + new_name='from_team', + ), + migrations.RemoveField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_chair', + ), + migrations.RemoveField( + model_name='adjudicatorfeedbackquestion', + name='panellist_on_panellist', + ), + ] diff --git a/tabbycat/adjfeedback/migrations/0008_auto_20160726_2007.py b/tabbycat/adjfeedback/migrations/0008_auto_20160726_2007.py new file mode 100644 index 00000000000..95f4c7313d0 --- /dev/null +++ b/tabbycat/adjfeedback/migrations/0008_auto_20160726_2007.py @@ -0,0 +1,25 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.9.7 on 2016-07-26 20:07 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('adjfeedback', '0007_from_adj_from_team'), + ] + + operations = [ + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='from_adj', + field=models.BooleanField(help_text='Adjudicators should be asked this question (about other adjudicators)'), + ), + migrations.AlterField( + model_name='adjudicatorfeedbackquestion', + name='from_team', + field=models.BooleanField(help_text='Teams should be asked this question'), + ), + ] diff --git a/adjfeedback/migrations/__init__.py b/tabbycat/adjfeedback/migrations/__init__.py similarity index 100% rename from adjfeedback/migrations/__init__.py rename to tabbycat/adjfeedback/migrations/__init__.py diff --git a/adjfeedback/models.py b/tabbycat/adjfeedback/models.py similarity index 88% rename from adjfeedback/models.py rename to tabbycat/adjfeedback/models.py index 56f1f9a1af6..d98e1b798c0 100644 --- a/adjfeedback/models.py +++ b/tabbycat/adjfeedback/models.py @@ -2,8 +2,8 @@ from django.db import models from django.utils.functional import cached_property -from results.models import Submission from adjallocation.models import DebateAdjudicator +from results.models import Submission class AdjudicatorTestScoreHistory(models.Model): @@ -97,19 +97,15 @@ class AdjudicatorFeedbackQuestion(models.Model): help_text="The order in which questions are displayed") text = models.CharField( max_length=255, - help_text= - "The question displayed to participants, e.g., \"Did you agree with the decision?\"") + help_text="The question displayed to participants, e.g., \"Did you agree with the decision?\"") name = models.CharField( max_length=30, - help_text= - "A short name for the question, e.g., \"Agree with decision\"") + help_text="A short name for the question, e.g., \"Agree with decision\"") reference = models.SlugField( help_text="Code-compatible reference, e.g., \"agree_with_decision\"") - chair_on_panellist = models.BooleanField() - panellist_on_chair = models.BooleanField() # for future use - panellist_on_panellist = models.BooleanField() # for future use - team_on_orallist = models.BooleanField() + from_adj = models.BooleanField(help_text="Adjudicators should be asked this question (about other adjudicators)") + from_team = models.BooleanField(help_text="Teams should be asked this question") answer_type = models.CharField(max_length=2, choices=ANSWER_TYPE_CHOICES) required = models.BooleanField( @@ -118,19 +114,16 @@ class AdjudicatorFeedbackQuestion(models.Model): min_value = models.FloatField( blank=True, null=True, - help_text= - "Minimum allowed value for numeric fields (ignored for text or boolean fields)") + help_text="Minimum allowed value for numeric fields (ignored for text or boolean fields)") max_value = models.FloatField( blank=True, null=True, - help_text= - "Maximum allowed value for numeric fields (ignored for text or boolean fields)") + help_text="Maximum allowed value for numeric fields (ignored for text or boolean fields)") choices = models.CharField( max_length=500, blank=True, null=True, - help_text= - "Permissible choices for select one/multiple fields, separated by %r (ignored for other fields)" + help_text="Permissible choices for select one/multiple fields, separated by %r (ignored for other fields)" % CHOICE_SEPARATOR) class Meta: @@ -198,7 +191,7 @@ def debate_adjudicator(self): try: return self.adjudicator.debateadjudicator_set.get( debate=self.debate) - except DebateAdjudicator.DoesNotExist as e: + except DebateAdjudicator.DoesNotExist: return None @property @@ -215,6 +208,9 @@ def clean(self): if not (self.source_adjudicator or self.source_team): raise ValidationError( "Either the source adjudicator or source team wasn't specified.") + if self.source_adjudicator and self.source_team: + raise ValidationError( + "There was both a source adjudicator and a source team.") if self.adjudicator not in self.debate.adjudicators: - raise ValidationError("Adjudicator did not see this debate") - super(AdjudicatorFeedback, self).clean() + raise ValidationError("Adjudicator did not see this debate.") + return super(AdjudicatorFeedback, self).clean() diff --git a/tabbycat/adjfeedback/progress.py b/tabbycat/adjfeedback/progress.py new file mode 100644 index 00000000000..4a45599641a --- /dev/null +++ b/tabbycat/adjfeedback/progress.py @@ -0,0 +1,378 @@ +"""Utilities to compute which feedback has been submitted and not submitted +by participants of the tournament. + +There are a few possibilities for how to characterise a feedback submission: +""" + +import logging +from operator import attrgetter + +from adjallocation.models import DebateAdjudicator +from adjfeedback.models import AdjudicatorFeedback +from draw.models import DebateTeam +from results.prefetch import populate_confirmed_ballots +from tournaments.models import Round + +from .utils import expected_feedback_targets + +logger = logging.getLogger(__name__) + + +class BaseFeedbackExpectedSubmissionTracker: + """Represents a single piece of expected feedback.""" + + expected = True + + def __init__(self, source): + self.source = source # either a DebateTeam or a DebateAdjudicator + + @property + def round(self): + return self.source.debate.round + + @property + def count(self): + return len(self.acceptable_submissions()) + + @property + def fulfilled(self): + return self.count == 1 + + def acceptable_submissions(self): + if not hasattr(self, '_acceptable_submissions'): + self._acceptable_submissions = self.get_acceptable_submissions() + return self._acceptable_submissions + + def get_acceptable_submissions(self): + """Subclasses should override this method to provide an iterable of + acceptable submissions. Users of this class might pre-populate + the `_acceptable_submissions` attribute to avoid duplicate database + hits.""" + raise NotImplementedError + + def submission(self): + if self.fulfilled: + return self.acceptable_submissions()[0] + else: + return None + + +class FeedbackExpectedSubmissionFromTeamTracker(BaseFeedbackExpectedSubmissionTracker): + """Represents a single piece of expected feedback from a team.""" + + def __init__(self, source, enforce_orallist=True): + self.enforce_orallist = enforce_orallist + super().__init__(source) + + def acceptable_targets(self): + """For a team, this must be the adjudicator who delivered the oral + adjudication. If the chair was rolled, then it is one of the majority + adjudicators; if the chair was in the majority, then it must be the + chair.""" + + if self.enforce_orallist and self.source.debate.confirmed_ballot: + majority = self.source.debate.confirmed_ballot.ballot_set.majority_adj + chair = self.source.debate.adjudicators.chair + if chair in majority: + return [chair] + else: + return majority + else: + return list(self.source.debate.adjudicators.voting()) + + def get_acceptable_submissions(self): + return self.source.adjudicatorfeedback_set.filter(confirmed=True, + source_team=self.source, + adjudicator__in=self.acceptable_targets()).select_related( + 'source_team', 'adjudicator', 'adjudicator__institution') + + +class FeedbackExpectedSubmissionFromAdjudicatorTracker(BaseFeedbackExpectedSubmissionTracker): + """Represents a single piece of expected feedback from an adjudicator.""" + + def __init__(self, source, target): + self.target = target + return super().__init__(source) + + def get_acceptable_submissions(self): + return self.source.adjudicatorfeedback_set.filter(confirmed=True, + adjudicator=self.target, source_adjudicator=self.source).select_related( + 'source_adjudicator', 'adjudicator', 'adjudicator__institution') + + def acceptable_targets(self): + return [self.target] + + +class FeedbackUnexpectedSubmissionTracker: + """Represents a single piece of unexpected feedback.""" + + expected = False + fulfilled = False + + def __init__(self, feedback): + self.feedback = feedback # an AdjudicatorFeedback instance + + @property + def round(self): + return self.feedback.round + + @property + def count(self): + return 1 + + def submission(self): + return self.feedback + + +class BaseFeedbackProgress: + """Class to compute feedback submitted or owed by a participant. + + Rather than just counting and comparing aggregates, everything is compared + at the individual feedback level using objects called "trackers". This + ensures that feedbacks that were actually submitted match those that were + expected.""" + + def __init__(self, tournament): + self.show_unexpected = tournament.pref('show_unexpected_feedback') + + def get_expected_trackers(self): + raise NotImplementedError + + def get_submitted_feedback(self): + raise NotImplementedError + + def expected_trackers(self): + if not hasattr(self, "_expected_trackers"): + self._expected_trackers = self.get_expected_trackers() + return self._expected_trackers + + def submitted_feedback(self): + if not hasattr(self, "_submitted_feedback"): + self._submitted_feedback = self.get_submitted_feedback() + return self._submitted_feedback + + def expected_feedback(self): + """Returns a list of AdjudicatorFeedback objects that are submitted + as expected (including where more are submitted than expected).""" + return [feedback for tracker in self.expected_trackers() + for feedback in tracker.acceptable_submissions()] + + def unexpected_trackers(self): + """Returns a list of trackers for feedback that was submitted but not + expected to be there.""" + if self.show_unexpected: + return [FeedbackUnexpectedSubmissionTracker(feedback) for feedback in + self.submitted_feedback() if feedback not in self.expected_feedback()] + else: + return [] + + def fulfilled_trackers(self): + """Returns a list of trackers that are fulfilled.""" + return [tracker for tracker in self.expected_trackers() if tracker.fulfilled] + + def trackers(self): + """Returns a list of all trackers, sorted by round.""" + return sorted(self.expected_trackers() + self.unexpected_trackers(), + key=lambda x: x.round.seq) + + def num_submitted(self): + """Returns the number of feedbacks that were submitted, including + duplicate and unexpected submissions.""" + return len(self.submitted_feedback()) + + def num_expected(self): + """Returns the number of feedbacks that are expected from this participant.""" + return len(self.expected_trackers()) + + def num_fulfilled(self): + """Returns the number of feedbacks that are correctly submitted, + excluding those where more than one feedback was submitted but only + one was expected.""" + return len(self.fulfilled_trackers()) + + def num_unsubmitted(self): + return self.num_expected() - self.num_fulfilled() + + def coverage(self): + """Returns the number of fulfilled feedbacks divided by the number + of expected feedbacks.""" + if self.num_expected() == 0: + return 1.0 + return self.num_fulfilled() / self.num_expected() + + def _prefetch_tracker_acceptable_submissions(self, trackers, tracker_identifier, feedback_identifier): + trackers_by_identifier = {} + for tracker in trackers: + tracker._acceptable_submissions = [] + identifier = tracker_identifier(tracker) + trackers_by_identifier[identifier] = tracker + for feedback in self.submitted_feedback(): + identifier = feedback_identifier(feedback) + try: + tracker = trackers_by_identifier[identifier] + except KeyError: + continue + if feedback.adjudicator in tracker.acceptable_targets(): + tracker._acceptable_submissions.append(feedback) + + +class FeedbackProgressForTeam(BaseFeedbackProgress): + """Class to compute feedback submitted or owed by a team.""" + + def __init__(self, team, tournament=None): + self.team = team + if tournament is None: + tournament = team.tournament + self.enforce_orallist = tournament.pref("show_splitting_adjudicators") + super().__init__(tournament) + + @staticmethod + def _submitted_feedback_queryset_operations(queryset): + # this is also used by get_feedback_progress + return queryset.filter(confirmed=True, + source_team__debate__round__stage=Round.STAGE_PRELIMINARY).select_related( + 'adjudicator', 'adjudicator__institution', 'source_team__debate__round') + + def get_submitted_feedback(self): + queryset = AdjudicatorFeedback.objects.filter(source_team__team=self.team) + return self._submitted_feedback_queryset_operations(queryset) + + @staticmethod + def _debateteam_queryset_operations(queryset): + # this is also used by get_feedback_progress + debateteams = queryset.filter( + debate__ballotsubmission__confirmed=True, + debate__round__silent=False, + debate__round__stage=Round.STAGE_PRELIMINARY + ).select_related('debate', 'debate__round').prefetch_related( + 'debate__debateadjudicator_set__adjudicator') + populate_confirmed_ballots([dt.debate for dt in debateteams], ballotsets=True) + return debateteams + + def _get_debateteams(self): + if not hasattr(self, '_debateteams'): + self._debateteams = self._debateteam_queryset_operations(self.team.debateteam_set) + return self._debateteams + + def get_expected_trackers(self): + # There is one tracker for each debate for which there is a confirmed ballot, + # and the round is not silent. + + debateteams = self._get_debateteams() + trackers = [FeedbackExpectedSubmissionFromTeamTracker(dt, self.enforce_orallist) for dt in debateteams] + self._prefetch_tracker_acceptable_submissions(trackers, + attrgetter('source'), attrgetter('source_team')) + return trackers + + +class FeedbackProgressForAdjudicator(BaseFeedbackProgress): + """Class to compute feedback submitted or owed by an adjudicator.""" + + def __init__(self, adjudicator, tournament=None): + self.adjudicator = adjudicator + if tournament is None: + tournament = adjudicator.tournament + if tournament is None: + logger.warning("No tournament specified and adjudicator %s has no tournament", adjudicator) + else: + self.feedback_paths = tournament.pref('feedback_paths') + super().__init__(tournament) + + @staticmethod + def _submitted_feedback_queryset_operations(queryset): + # this is also used by get_feedback_progress + return queryset.filter(confirmed=True, + source_adjudicator__debate__round__stage=Round.STAGE_PRELIMINARY).select_related( + 'adjudicator', 'adjudicator__institution', 'source_adjudicator__debate__round') + + def get_submitted_feedback(self): + queryset = AdjudicatorFeedback.objects.filter(source_adjudicator__adjudicator=self.adjudicator) + return self._submitted_feedback_queryset_operations(queryset) + + @staticmethod + def _debateadjudicator_queryset_operations(queryset): + # this is also used by get_feedback_progress + return queryset.filter( + debate__ballotsubmission__confirmed=True, + debate__round__stage=Round.STAGE_PRELIMINARY + ).select_related('debate', 'debate__round').prefetch_related( + 'debate__debateadjudicator_set__adjudicator') + + def _get_debateadjudicators(self): + if not hasattr(self, '_debateadjudicators'): + self._debateadjudicators = self._debateadjudicator_queryset_operations(self.adjudicator.debateadjudicator_set) + return self._debateadjudicators + + def get_expected_trackers(self): + """Trackers are as follows: + - Chairs owe on everyone in their panel. + - Panellists owe on chairs if the relevant tournament preference is enabled. + """ + debateadjs = self._get_debateadjudicators() + + trackers = [] + for debateadj in debateadjs: + for target, _ in expected_feedback_targets(debateadj, self.feedback_paths): + trackers.append(FeedbackExpectedSubmissionFromAdjudicatorTracker(debateadj, target)) + + self._prefetch_tracker_acceptable_submissions(trackers, + attrgetter('source', 'target'), attrgetter('source_adjudicator', 'adjudicator')) + + return trackers + + +def get_feedback_progress(t): + """Returns a list of FeedbackProgressForTeam objects and a list of + FeedbackProgressForAdjudicator objects. + + This function pre-populates the FeedbackProgress objects to avoid needing + duplicate SQL queries for every team and adjudicator, so it should be used + for performance when the feedback progress of all teams and adjudicators is + needed.""" + + teams_progress = [] + adjs_progress = [] + + teams = t.team_set.prefetch_related('speaker_set').all() + + submitted_feedback_by_team_id = {team.id: [] for team in teams} + submitted_feedback_teams = AdjudicatorFeedback.objects.filter( + source_team__team__in=teams).select_related('source_team') + submitted_feedback_teams = FeedbackProgressForTeam._submitted_feedback_queryset_operations(submitted_feedback_teams) + for feedback in submitted_feedback_teams: + submitted_feedback_by_team_id[feedback.source_team.team_id].append(feedback) + + debateteams_by_team_id = {team.id: [] for team in teams} + debateteams = DebateTeam.objects.filter(team__in=teams) + debateteams = FeedbackProgressForTeam._debateteam_queryset_operations(debateteams) + for debateteam in debateteams: + debateteams_by_team_id[debateteam.team_id].append(debateteam) + + for team in teams: + progress = FeedbackProgressForTeam(team) + progress._submitted_feedback = submitted_feedback_by_team_id[team.id] + progress._debateteams = debateteams_by_team_id[team.id] + teams_progress.append(progress) + + adjudicators = t.adjudicator_set.all() + + submitted_feedback_by_adj_id = {adj.id: [] for adj in adjudicators} + submitted_feedback_adjs = AdjudicatorFeedback.objects.filter( + source_adjudicator__adjudicator__in=adjudicators).select_related('source_adjudicator') + submitted_feedback_adjs = FeedbackProgressForAdjudicator._submitted_feedback_queryset_operations(submitted_feedback_adjs) + for feedback in submitted_feedback_adjs: + submitted_feedback_by_adj_id[feedback.source_adjudicator.adjudicator_id].append(feedback) + + debateadjs_by_adj_id = {adj.id: [] for adj in adjudicators} + debateadjs = DebateAdjudicator.objects.filter(adjudicator__in=adjudicators) + debateadjs = FeedbackProgressForAdjudicator._debateadjudicator_queryset_operations(debateadjs) + for debateadj in debateadjs: + debateadjs_by_adj_id[debateadj.adjudicator_id].append(debateadj) + + for adj in adjudicators: + progress = FeedbackProgressForAdjudicator(adj) + progress._submitted_feedback = submitted_feedback_by_adj_id[adj.id] + progress._debateadjudicators = debateadjs_by_adj_id[adj.id] + adjs_progress.append(progress) + + return teams_progress, adjs_progress diff --git a/tabbycat/adjfeedback/tables.py b/tabbycat/adjfeedback/tables.py new file mode 100644 index 00000000000..290d666d9e7 --- /dev/null +++ b/tabbycat/adjfeedback/tables.py @@ -0,0 +1,157 @@ +import logging + +from utils.misc import reverse_tournament +from utils.tables import TabbycatTableBuilder + +from .progress import FeedbackProgressForAdjudicator, FeedbackProgressForTeam + +logger = logging.getLogger(__name__) + + +class FeedbackTableBuilder(TabbycatTableBuilder): + + def add_breaking_checkbox(self, adjudicators, key="Breaking"): + breaking_header = { + 'key': 'B', + 'icon': 'glyphicon-star', + 'tooltip': 'Whether the adj is marked as breaking (click to mark)', + } + breaking_data = [{ + 'text': '' % (adj.id, 'checked' if adj.breaking else ''), + 'sort': adj.breaking, + 'class': 'checkbox-target' + } for adj in adjudicators] + + self.add_column(breaking_header, breaking_data) + + def add_score_columns(self, adjudicators): + + feedback_weight = self.tournament.current_round.feedback_weight + scores = {adj: adj.weighted_score(feedback_weight) for adj in adjudicators} + + overall_header = { + 'key': 'Overall Score', + 'icon': 'glyphicon-signal', + 'tooltip': 'Current weighted score', + } + overall_data = [{ + 'text': '%0.1f' % scores[adj] if scores[adj] is not None else 'N/A', + 'tooltip': 'Current weighted average of all feedback', + } for adj in adjudicators] + self.add_column(overall_header, overall_data) + + test_header = { + 'key': 'Test Score', + 'icon': 'glyphicon-scale', + 'tooltip': 'Test score result', + } + test_data = [{ + 'text': '%0.1f' % adj.test_score if adj.test_score is not None else 'N/A', + 'modal': adj.id, + 'class': 'edit-test-score', + 'tooltip': 'Click to edit test score', + } for adj in adjudicators] + self.add_column(test_header, test_data) + + def add_feedback_graphs(self, adjudicators): + feedback_head = { + 'key': 'Feedback', + 'text': 'Feedback as Chair ' + + ' Panellist ' + + ' Trainee ' + } + feedback_data = [{ + 'graphData': adj.feedback_data, + 'component': 'feedback-trend', + 'minScore': self.tournament.pref('adj_min_score'), + 'maxScore': self.tournament.pref('adj_max_score'), + 'roundSeq': len(self.tournament.prelim_rounds()), + } for adj in adjudicators] + self.add_column(feedback_head, feedback_data) + + def add_feedback_link_columns(self, adjudicators): + link_head = { + 'key': 'VF', + 'icon': 'glyphicon-question-sign' + } + link_cell = [{ + 'text': 'View
Feedback', + 'class': 'view-feedback', + 'link': reverse_tournament('adjfeedback-view-on-adjudicator', self.tournament, kwargs={'pk': adj.pk}) + } for adj in adjudicators] + self.add_column(link_head, link_cell) + + def add_feedback_misc_columns(self, adjudicators): + if self.tournament.pref('enable_adj_notes'): + note_head = { + 'key': 'NO', + 'icon': 'glyphicon-list-alt' + } + note_cell = [{ + 'text': 'Edit
Note', + 'class': 'edit-note', + 'modal': str(adj.id) + '===' + str(adj.notes) + } for adj in adjudicators] + self.add_column(note_head, note_cell) + + adjudications_head = { + 'key': 'DD', + 'icon': 'glyphicon-eye-open', + 'tooltip': 'Debates adjudicated' + } + adjudications_cell = [{'text': adj.debates} for adj in adjudicators] + self.add_column(adjudications_head, adjudications_cell) + + avgs_head = { + 'key': 'AVGS', + 'icon': 'glyphicon-resize-full', + 'tooltip': 'Average Margin (top) and Average Score (bottom)' + } + avgs_cell = [{ + 'text': "%0.1f
%0.1f" % (adj.avg_margin if adj.avg_margin else 0, adj.avg_score if adj.avg_margin else 0), + 'tooltip': 'Average Margin (top) and Average Score (bottom)' + } for adj in adjudicators] + self.add_column(avgs_head, avgs_cell) + + def add_feedback_progress_columns(self, progress_list, key="P"): + + def _owed_cell(progress): + owed = progress.num_unsubmitted() + cell = { + 'text': owed, + 'sort': owed, + 'class': 'text-danger strong' if owed > 0 else 'text-success' + } + return cell + + owed_header = { + 'key': 'Owed', + 'icon': 'glyphicon-remove', + 'tooltip': 'Unsubmitted feedback ballots', + } + owed_data = [_owed_cell(progress) for progress in progress_list] + self.add_column(owed_header, owed_data) + + if self._show_record_links: + + def _record_link(progress): + if isinstance(progress, FeedbackProgressForTeam): + url_name = 'participants-team-record' if self.admin else 'participants-public-team-record' + pk = progress.team.pk + elif isinstance(progress, FeedbackProgressForAdjudicator): + url_name = 'participants-adjudicator-record' if self.admin else 'participants-public-adjudicator-record' + pk = progress.adjudicator.pk + else: + logger.error("Unrecognised progress type: %s", progress.__class__.__name__) + return '' + return reverse_tournament(url_name, self.tournament, kwargs={'pk': pk}) + + owed_link_header = { + 'key': 'Submitted', + 'icon': 'glyphicon-question-sign', + } + owed_link_data = [{ + 'text': 'View Missing Feedback', + 'link': _record_link(progress) + } for progress in progress_list] + self.add_column(owed_link_header, owed_link_data) diff --git a/adjfeedback/templates/add_feedback.html b/tabbycat/adjfeedback/templates/add_feedback.html similarity index 65% rename from adjfeedback/templates/add_feedback.html rename to tabbycat/adjfeedback/templates/add_feedback.html index 5b22a678e33..c35011512c7 100644 --- a/adjfeedback/templates/add_feedback.html +++ b/tabbycat/adjfeedback/templates/add_feedback.html @@ -1,24 +1,16 @@ -{% extends "base.html" %} +{% extends "feedback_base.html" %} {% load debate_tags %} +{% load static %} {% block head-title %}Who is the feedback from?{% endblock %} {% block page-title %}Enter Feedback{% endblock %} -{% block page-subnav-sections %} - - {% include "tables/table_search.html" %} -{% endblock %} - {% block content %}
-