otree 6.0.0b32__tar.gz → 6.0.1__tar.gz

{otree-6.0.0b32/otree.egg-info → otree-6.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: otree
-Version: 6.0.0b32
+Version: 6.0.1
 Summary: Framework for multiplayer strategy games and complex surveys.
 Home-page: http://otree.org/
 Author: chris@otree.org

{otree-6.0.0b32 → otree-6.0.1}/otree/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '6.0.0b32'
+__version__ = '6.0.1'
 # don't import anything else here because setup.py imports this.

{otree-6.0.0b32 → otree-6.0.1}/otree/api.pyi

@@ -15,7 +15,7 @@ cu = Currency
 class DecimalUnit(Decimal):
     storage_places: int
     input_places: int
-    input_units_label: str
+    input_unit_label: str
     output_min_places: int
     output_max_places: int
 
@@ -136,7 +136,7 @@ class models:
         def __init__(
             self,
             *,
-            units: Type[DecimalUnit],
+            unit: Type[DecimalUnit],
             choices: Iterable | None = None,
             widget: Any | None = None,
             initial: AnyNumber | None = None,

{otree-6.0.0b32 → otree-6.0.1}/otree/currency.py

@@ -164,6 +164,15 @@ class BaseCurrency(Decimal):
 
 
 class Currency(BaseCurrency):
+    def __new__(cls, amount):
+        # If CURRENCY_UNIT is defined, create instance of custom unit instead
+        if settings.CURRENCY_UNIT_CLASS is not None:
+            return settings.CURRENCY_UNIT_CLASS(amount)
+        # Otherwise use normal Currency behavior
+        if amount is None:
+            raise ValueError('Cannot convert None to currency')
+        return Decimal.__new__(cls, cls._sanitize(amount))
+
     @classmethod
     def get_num_decimal_places(cls):
         if settings.USE_POINTS:
@@ -209,6 +218,15 @@ class Currency(BaseCurrency):
 class RealWorldCurrency(BaseCurrency):
     '''payment currency'''
 
+    def __new__(cls, amount):
+        # If CURRENCY_UNIT is defined, create instance of custom unit instead
+        if settings.CURRENCY_UNIT_CLASS is not None:
+            return settings.CURRENCY_UNIT_CLASS(amount)
+        # Otherwise use normal RealWorldCurrency behavior
+        if amount is None:
+            raise ValueError('Cannot convert None to currency')
+        return Decimal.__new__(cls, cls._sanitize(amount))
+
     def to_real_world_currency(self, session):
         return self
 
@@ -260,4 +278,3 @@ def currency_range(first, last, increment):
         values.append(current_value)
         current_value += increment
 
-

{otree-6.0.0b32 → otree-6.0.1}/otree/database.py

@@ -904,15 +904,21 @@ def IntegerField(**kwargs):
 
 
 def CurrencyField(**kwargs):
+    # If CURRENCY_UNIT is defined, CurrencyField is an alias for DecimalField
+    if settings.CURRENCY_UNIT_CLASS is not None:
+        return DecimalField(unit=settings.CURRENCY_UNIT_CLASS, **kwargs)
     return wrap_column(CurrencyType, **kwargs)
 
 
 def RealWorldCurrencyField(**kwargs):
+    # If CURRENCY_UNIT is defined, RealWorldCurrencyField is an alias for DecimalField
+    if settings.CURRENCY_UNIT_CLASS is not None:
+        return DecimalField(unit=settings.CURRENCY_UNIT_CLASS, **kwargs)
     return wrap_column(RealWorldCurrencyType, **kwargs)
 
 
-def DecimalField(*, units, **kwargs):
-    return wrap_column(DecimalFieldType(unit=units), **kwargs)
+def DecimalField(*, unit, **kwargs):
+    return wrap_column(DecimalFieldType(unit=unit), **kwargs)
 
 
 # aliases for compat

{otree-6.0.0b32 → otree-6.0.1}/otree/decimal.py

@@ -16,7 +16,7 @@ class DecimalUnit(Decimal):
     # Default class attributes (should be overridden by subclasses)
     storage_places = None
     input_places = None
-    input_units_label = ''
+    input_unit_label = ''
     output_min_places = None
     output_max_places = None
 
@@ -144,6 +144,14 @@ class DecimalUnit(Decimal):
         max_places = self.__class__.output_max_places
         return self._format_with_places(min_places, max_places)
 
+    def to_real_world_currency(self, session):
+        """
+        Compatibility method for when CurrencyField is aliased to DecimalField.
+        Since there's only one currency type when CURRENCY_UNIT is defined,
+        just return self (similar to Currency.to_real_world_currency when USE_POINTS=False)
+        """
+        return self
+
     def _make_result(self, result, other):
         """DRY helper for arithmetic operations"""
         if not isinstance(other, DecimalUnit):

{otree-6.0.0b32 → otree-6.0.1}/otree/export.py

@@ -27,6 +27,31 @@ from otree import settings
 logger = logging.getLogger(__name__)
 
 
+# Single source of truth for fixed columns in SessionData view
+# These columns always appear first, in this order
+DATA_TAB_FIXED_COLUMNS = [
+    {
+        'field': 'participant.label',
+        'display': 'label',
+        'prefix': 'pp.',
+        'getter': lambda p, g, s, participant_label: participant_label,
+    },
+    {
+        'field': 'group.id_in_subsession',
+        'display': 'group',
+        'prefix': '',
+        'getter': lambda p, g, s, participant_label: g['id_in_subsession'],
+    },
+]
+
+# Automatically derive the group column index
+GROUP_COL_INDEX = next(
+    i
+    for i, col in enumerate(DATA_TAB_FIXED_COLUMNS)
+    if col['field'] == 'group.id_in_subsession'
+)
+
+
 def get_fields_for_monitor():
     return _get_table_fields(Participant, for_export=False)
 
@@ -85,7 +110,8 @@ def _get_table_fields(Model, custom_fields=None, for_export=False):
 
     specs = [
         ('player', BasePlayer, ['id_in_group', 'role', 'payoff']),
-        ('group', BaseGroup, ['id_in_subsession']),
+        # group.id_in_subsession is in DATA_TAB_FIXED_COLUMNS, not here
+        ('group', BaseGroup, []),
         # don't need round_number because it's already in the SessionData navigation toolbar
         ('subsession', BaseSubsession, []),
     ]
@@ -502,7 +528,10 @@ def get_rows_for_data_tab_app(session, app_name):
             s = subsessions[p['subsession_id']]
             try:
                 row = (
-                    [participant_label]
+                    [
+                        col['getter'](p, g, s, participant_label)
+                        for col in DATA_TAB_FIXED_COLUMNS
+                    ]
                     + [p[fname] for fname in pfields]
                     + [g[fname] for fname in gfields]
                     + [s[fname] for fname in sfields]

{otree-6.0.0b32 → otree-6.0.1}/otree/forms/widgets.py

@@ -114,7 +114,7 @@ class DecimalWidget(BaseWidget):
 
     def __init__(self, unit):
         self.unit = unit
-        self.input_label = unit.input_units_label
+        self.input_label = unit.input_unit_label
         self.places = unit.input_places
 
     def get_html_fragments(self):

{otree-6.0.0b32 → otree-6.0.1}/otree/main.py

@@ -124,6 +124,32 @@ def setup():
 
     init_i18n(settings.LANGUAGE_CODE_ISO)
 
+    # Import CURRENCY_UNIT class if defined (delayed to avoid circular imports)
+    if settings.CURRENCY_UNIT_PATH:
+        import importlib
+        import sys
+        from otree.decimal import DecimalUnit
+
+        try:
+            module_path, class_name = settings.CURRENCY_UNIT_PATH.rsplit('.', 1)
+            module = importlib.import_module(module_path)
+            currency_unit_class = getattr(module, class_name)
+
+            # Validate it's a DecimalUnit subclass
+            if not issubclass(currency_unit_class, DecimalUnit):
+                msg = (
+                    f"CURRENCY_UNIT must be a subclass of DecimalUnit, "
+                    f"but {settings.CURRENCY_UNIT_PATH} is not."
+                )
+                sys.exit(msg)
+
+            # Set it globally - Currency/RealWorldCurrency __new__ will use this
+            settings.CURRENCY_UNIT_CLASS = currency_unit_class
+
+        except (ValueError, ImportError, AttributeError) as e:
+            msg = f"Failed to import CURRENCY_UNIT '{settings.CURRENCY_UNIT_PATH}': {e}"
+            sys.exit(msg)
+
     from otree.database import init_orm  # noqa
 
     check_for_sentry()

{otree-6.0.0b32 → otree-6.0.1}/otree/models/participant.py

@@ -31,7 +31,7 @@ class Participant(MixinVars, otree.database.SSPPGModel):
     payoff = Column(CurrencyType, default=0)
 
     # status could be 'finished', 'dropped out', etc. Empty string means active/in progress
-    status = Column(st.String(50), default='')
+    status = Column(st.String(50), default='', nullable=False)
 
     # better to use a string so that it doesn't become unofficial API
     time_started_utc = Column(st.String(50), nullable=True)

{otree-6.0.0b32 → otree-6.0.1}/otree/session.py

@@ -76,7 +76,12 @@ class SessionConfig(dict):
         return num_cases
 
     def clean(self):
-        for k in ['participation_fee', 'real_world_currency_per_point']:
+        required_keys = ['participation_fee']
+        # When CURRENCY_UNIT is defined, there's no currency conversion (like USE_POINTS=False)
+        if settings.CURRENCY_UNIT_CLASS is None:
+            required_keys.append('real_world_currency_per_point')
+
+        for k in required_keys:
             if k not in self:
                 msg = f'SESSION_CONFIG_DEFAULTS is missing {k}'
                 raise SessionConfigError(msg)
@@ -127,7 +132,8 @@ class SessionConfig(dict):
 
     def builtin_editable_fields(self):
         fields = ['participation_fee']
-        if settings.USE_POINTS:
+        # Only show real_world_currency_per_point when using old currency system with points
+        if settings.CURRENCY_UNIT_CLASS is None and settings.USE_POINTS:
             fields.append('real_world_currency_per_point')
         return fields
 

{otree-6.0.0b32 → otree-6.0.1}/otree/settings.py

@@ -53,6 +53,33 @@ def get_OTREE_APPS(SESSION_CONFIGS):
 
 
 OTREE_APPS = get_OTREE_APPS(settings.SESSION_CONFIGS)
+
+# Handle CURRENCY_UNIT if defined
+# Note: We don't import the class here to avoid circular imports
+# The actual import happens in otree/main.py:setup()
+CURRENCY_UNIT_CLASS = None
+CURRENCY_UNIT_PATH = None
+if hasattr(settings, 'CURRENCY_UNIT'):
+    # Check for incompatible old currency settings
+    old_currency_settings = [
+        'USE_POINTS',
+        'REAL_WORLD_CURRENCY_CODE',
+        'POINTS_DECIMAL_PLACES',
+        'POINTS_CUSTOM_NAME',
+        'REAL_WORLD_CURRENCY_DECIMAL_PLACES',
+    ]
+    found_old_settings = [s for s in old_currency_settings if hasattr(settings, s)]
+    if found_old_settings:
+        msg = (
+            f"CURRENCY_UNIT is defined, but the following deprecated currency settings "
+            f"are also defined: {', '.join(found_old_settings)}. "
+            f"Please remove these settings when using CURRENCY_UNIT."
+        )
+        sys.exit(msg)
+
+    # Store the path for later import (done in main.py:setup() to avoid circular imports)
+    CURRENCY_UNIT_PATH = settings.CURRENCY_UNIT
+
 if not hasattr(settings, 'REAL_WORLD_CURRENCY_DECIMAL_PLACES'):
     if REAL_WORLD_CURRENCY_CODE in [
         'KRW',

{otree-6.0.0b32 → otree-6.0.1}/otree/static/otree/js/session_data.js

@@ -45,10 +45,10 @@ function filterGroup(rowIdx) {
             let tbody = table.querySelector('tbody');
             let trs = tbody.querySelectorAll('tr');
 
-            let curGroup = data[rowIdx][1];  // Group column is now at index 1
+            let curGroup = data[rowIdx][GROUP_COL_INDEX];
             let rowsInSameGroup = [];
             for (let i = 0; i < data.length; i++) {
-                if (data[i][1] === curGroup)  // Group column is now at index 1
+                if (data[i][GROUP_COL_INDEX] === curGroup)
                     rowsInSameGroup.push(i);
             }
             for (let i = 0; i < trs.length; i++) {
@@ -71,8 +71,7 @@ function createTableRow(row, row_number) {
     for (let i = 0; i < row.length; i++) {
         let value = row[i];
         let td = document.createElement('td');
-        if (i === 1) {
-            // i === 1 is now the group column (participant.label is at i === 0)
+        if (i === GROUP_COL_INDEX) {
             td.innerHTML = `<a href="#" onclick="filterGroup(${row_number})">${value}</a>`;
         } else {
             td.innerHTML = makeCellDisplayValue(value);
@@ -106,7 +105,7 @@ function makeCellDisplayValue(value, fieldName) {
 
 
 
-function updateDataTable($table, new_json, old_json, field_headers) {
+function updateDataTable($table, new_json, old_json, headers) {
     let changeDescriptions = [];
     let $tbody = $table.find('tbody');
     // build table for the first time
@@ -121,7 +120,8 @@ function updateDataTable($table, new_json, old_json, field_headers) {
                 let new_value = makeCellDisplayValue(rawValue);
                 $cell.text(new_value);
                 flashGreen($cell);
-                let fieldName = field_headers[j];
+                let header = headers[j];
+                let fieldName = header.prefix ? header.prefix + header.name : header.name;
                 let newValueTrunc = truncateStringEllipsis(new_value, 7);
                 rowChanges.push(`${fieldName}=${newValueTrunc}`);
             }

{otree-6.0.0b32 → otree-6.0.1}/otree/templates/otree/SessionData.html

@@ -168,7 +168,8 @@
       let tables = document.getElementsByClassName('results-table');
       const round_numbers_by_subsession = {{ round_numbers_by_subsession|safe }};
       const app_names_by_subsession = {{ app_names_by_subsession|safe }};
-      const FIELD_HEADERS = {{ field_headers_json|safe }};
+      const TABLE_HEADERS = {{ tables|safe }}.map(t => t.headers);
+      const GROUP_COL_INDEX = {{ GROUP_COL_INDEX }};
       let populatedTables = new Set(); // Track which tables have been populated
       $(document).ready(function () {
           $('#btn-refresh').click(function () {
@@ -267,8 +268,7 @@
                       // REFRESH: Only update populated tables
                       for (let tableIdx of populatedTables) {
                           let table = tables[tableIdx];
-                          let appName = app_names_by_subsession[tableIdx];
-                          let headers = FIELD_HEADERS[appName];
+                          let headers = TABLE_HEADERS[tableIdx];
                           let data = new_json[tableIdx];
                           changeDescriptions = changeDescriptions.concat(updateDataTable($(table), data, old_json[tableIdx], headers));
                       }

{otree-6.0.0b32 → otree-6.0.1}/otree/views/admin.py

@@ -313,7 +313,6 @@ class SessionData(AdminSessionPage):
         session = self.session
 
         tables = []
-        field_headers = {}
         app_names_by_subsession = []
         round_numbers_by_subsession = []
         table_index = 0
@@ -323,7 +322,6 @@ class SessionData(AdminSessionPage):
                 session=session
             ).count()
             pfields, gfields, sfields = export.get_fields_for_data_tab(app_name)
-            field_headers[app_name] = pfields + gfields + sfields
 
             for round_number in range(1, num_rounds + 1):
                 # Build headers with indexes for sortability
@@ -331,7 +329,7 @@ class SessionData(AdminSessionPage):
                 field_index = 0
 
                 for field_name, prefix in [
-                    ('label', 'pp.'),
+                    *[(col['display'], col['prefix']) for col in export.DATA_TAB_FIXED_COLUMNS],
                     *[(f, '') for f in pfields],
                     *[(f, 'group.') for f in gfields],
                     *[(f, 'subsession.') for f in sfields],
@@ -353,9 +351,9 @@ class SessionData(AdminSessionPage):
                 table_index += 1
         return dict(
             tables=tables,
-            field_headers_json=json.dumps(field_headers),
             app_names_by_subsession=app_names_by_subsession,
             round_numbers_by_subsession=round_numbers_by_subsession,
+            GROUP_COL_INDEX=export.GROUP_COL_INDEX,
             DATA_EXPORT_HASH=otree.common.DATA_EXPORT_HASH,
         )
 

{otree-6.0.0b32 → otree-6.0.1/otree.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: otree
-Version: 6.0.0b32
+Version: 6.0.1
 Summary: Framework for multiplayer strategy games and complex surveys.
 Home-page: http://otree.org/
 Author: chris@otree.org