CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-06 15:24:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added python3.5-style type annotations to pretix.base

Browse Source
This commit is contained in:
Raphael Michel
2015-10-25 21:26:04 +01:00
parent ecebe481d7
commit 79ad8b40ed
28 changed files with 142 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
src/pretix/base/services/cart.py
View File

@@ -1,9 +1,10 @@
from datetime import timedelta
from datetime import datetime, timedelta
from django.conf import settings
from django.db.models import Q
from django.utils.timezone import now
from django.utils.translation import ugettext_lazy as _
from typing import List, Optional, Tuple
from pretix.base.models import (
CartPosition, Event, EventLock, Item, ItemVariation, Quota,
@@ -29,7 +30,7 @@ error_messages = {
}
def _extend_existing(event, cart_id, expiry):
def _extend_existing(event: Event, cart_id: str, expiry: datetime) -> None:
# Extend this user's cart session to 30 minutes from now to ensure all items in the
# cart expire at the same time
# We can extend the reservation of items which are not yet expired without risk
@@ -38,7 +39,7 @@ def _extend_existing(event, cart_id, expiry):
).update(expires=expiry)
def _re_add_expired_positions(items, event, cart_id):
def _re_add_expired_positions(items: List[CartPosition], event: Event, cart_id: str) -> List[CartPosition]:
positions = set()
# For items that are already expired, we have to delete and re-add them, as they might
# be no longer available or prices might have changed. Sorry!
@@ -51,20 +52,21 @@ def _re_add_expired_positions(items, event, cart_id):
return positions
def _delete_expired(expired):
def _delete_expired(expired: List[CartPosition]) -> None:
for cp in expired:
if cp.version_end_date is None:
cp.delete()
def _check_date(event):
def _check_date(event: Event) -> None:
if event.presale_start and now() < event.presale_start:
raise CartError(error_messages['not_started'])
if event.presale_end and now() > event.presale_end:
raise CartError(error_messages['ended'])
def _add_items(event, items, cart_id, expiry):
def _add_items(event: Event, items: List[Tuple[str, Optional[str], int]],
cart_id: str, expiry: datetime) -> Optional[str]:
err = None
# Fetch items from the database
@@ -129,7 +131,7 @@ def _add_items(event, items, cart_id, expiry):
return err
def _add_items_to_cart(event: Event, items: list, cart_id: str=None):
def _add_items_to_cart(event: Event, items: List[Tuple[str, Optional[str], int]], cart_id: str=None) -> None:
with event.lock():
_check_date(event)
existing = CartPosition.objects.current.filter(Q(cart_id=cart_id) & Q(event=event)).count()
@@ -150,7 +152,7 @@ def _add_items_to_cart(event: Event, items: list, cart_id: str=None):
raise CartError(err)
def add_items_to_cart(event: str, items: list, cart_id: str=None):
def add_items_to_cart(event: str, items: List[Tuple[str, Optional[str], int]], cart_id: str=None) -> None:
"""
Adds a list of items to a user's cart.
:param event: The event ID in question
@@ -160,12 +162,12 @@ def add_items_to_cart(event: str, items: list, cart_id: str=None):
"""
event = Event.objects.current.get(identity=event)
try:
return _add_items_to_cart(event, items, cart_id)
_add_items_to_cart(event, items, cart_id)
except EventLock.LockTimeoutException:
raise CartError(error_messages['busy'])
def remove_items_from_cart(event: str, items: list, cart_id: str=None):
def remove_items_from_cart(event: str, items: List[Tuple[str, Optional[str], int]], cart_id: str=None) -> None:
"""
Removes a list of items from a user's cart.
:param event: The event ID in question
@@ -188,10 +190,10 @@ if settings.HAS_CELERY:
from pretix.celery import app
@app.task(bind=True, max_retries=5, default_retry_delay=2)
def add_items_to_cart_task(self, event: str, items: list, cart_id: str):
def add_items_to_cart_task(self, event: str, items: List[Tuple[str, Optional[str], int]], cart_id: str):
event = Event.objects.current.get(identity=event)
try:
return _add_items_to_cart(event, items, cart_id)
_add_items_to_cart(event, items, cart_id)
except EventLock.LockTimeoutException:
self.retry(exc=CartError(error_messages['busy']))

3
src/pretix/base/services/export.py
View File

@@ -1,11 +1,12 @@
from django.conf import settings
from django.core.files.base import ContentFile
from typing import Any, Dict
from pretix.base.models import CachedFile, Event, cachedfile_name
from pretix.base.signals import register_data_exporters
def export(event, fileid, provider, form_data):
def export(event: str, fileid: str, provider: str, form_data: Dict[str, Any]) -> None:
event = Event.objects.current.get(identity=event)
file = CachedFile.objects.get(id=fileid)
responses = register_data_exporters.send(event)

6
src/pretix/base/services/mail.py
View File

@@ -5,6 +5,7 @@ from django.core.mail import EmailMessage
from django.template.loader import get_template
from django.utils import translation
from django.utils.translation import ugettext as _
from typing import Any, Dict
from pretix.base.i18n import LazyI18nString
from pretix.base.models import Event
@@ -12,7 +13,8 @@ from pretix.base.models import Event
logger = logging.getLogger('pretix.base.mail')
def mail(email: str, subject: str, template: str, context: dict=None, event: Event=None, locale: str=None):
def mail(email: str, subject: str, template: str,
context: Dict[str, Any]=None, event: Event=None, locale: str=None):
"""
Sends out an email to a user.
@@ -58,7 +60,7 @@ def mail(email: str, subject: str, template: str, context: dict=None, event: Eve
translation.activate(_lng)
def mail_send(to, subject, body, sender):
def mail_send(to: str, subject: str, body: str, sender: str) -> bool:
email = EmailMessage(subject, body, sender, to=to)
try:

15
src/pretix/base/services/orders.py
View File

@@ -4,6 +4,7 @@ from django.conf import settings
from django.db import transaction
from django.utils.timezone import now
from django.utils.translation import ugettext_lazy as _
from typing import List
from pretix.base.models import (
CartPosition, Event, EventLock, Order, OrderPosition, Quota,
@@ -30,7 +31,7 @@ error_messages = {
def mark_order_paid(order: Order, provider: str=None, info: str=None, date: datetime=None, manual: bool=None,
force: bool=False):
force: bool=False) -> Order:
"""
Marks an order as paid. This clones the order object, sets the payment provider,
info and date and returns the cloned order object.
@@ -82,14 +83,14 @@ class OrderError(Exception):
pass
def _check_date(event):
def _check_date(event: Event):
if event.presale_start and now() < event.presale_start:
raise OrderError(error_messages['not_started'])
if event.presale_end and now() > event.presale_end:
raise OrderError(error_messages['ended'])
def _check_positions(event: Event, dt: datetime, positions: list):
def _check_positions(event: Event, dt: datetime, positions: List[CartPosition]):
err = None
_check_date(event)
@@ -135,7 +136,7 @@ def _check_positions(event: Event, dt: datetime, positions: list):
@transaction.atomic()
def _create_order(event: Event, email: str, positions: list, dt: datetime,
def _create_order(event: Event, email: str, positions: List[CartPosition], dt: datetime,
payment_provider: BasePaymentProvider, locale: str=None):
total = sum([c.price for c in positions])
payment_fee = payment_provider.calculate_fee(total)
@@ -159,7 +160,7 @@ def _create_order(event: Event, email: str, positions: list, dt: datetime,
return order
def _perform_order(event: str, payment_provider: str, position_ids: list,
def _perform_order(event: str, payment_provider: str, position_ids: List[str],
email: str, locale: str):
event = Event.objects.current.get(identity=event)
responses = register_payment_providers.send(event)
@@ -197,7 +198,7 @@ def _perform_order(event: str, payment_provider: str, position_ids: list,
return order.identity
def perform_order(event: str, payment_provider: str, positions: list,
def perform_order(event: str, payment_provider: str, positions: List[str],
email: str=None, locale: str=None):
try:
return _perform_order(event, payment_provider, positions, email, locale)
@@ -211,7 +212,7 @@ if settings.HAS_CELERY:
from pretix.celery import app
@app.task(bind=True, max_retries=5, default_retry_delay=2)
def perform_order_task(self, event: str, payment_provider: str, positions: list,
def perform_order_task(self, event: str, payment_provider: str, positions: List[str],
email: str=None, locale: str=None):
try:
return _perform_order(event, payment_provider, positions, email, locale)

13
src/pretix/base/services/stats.py
View File

@@ -1,7 +1,10 @@
from decimal import Decimal
from django.db.models import Count, Sum
from django.utils.translation import ugettext_lazy as _
from typing import Any, Dict, Iterable, List, Tuple
from pretix.base.models import ItemCategory, Order, OrderPosition
from pretix.base.models import Event, Item, ItemCategory, Order, OrderPosition
from pretix.base.signals import register_payment_providers
@@ -10,14 +13,14 @@ class DummyObject:
class Dontsum:
def __init__(self, value):
def __init__(self, value: Any):
self.value = value
def __str__(self):
def __str__(self) -> str:
return str(self.value)
def tuplesum(tuples):
def tuplesum(tuples: Iterable[Tuple]) -> Tuple:
def mysum(it):
sit = [i for i in it if not isinstance(i, Dontsum)]
return sum(sit)
@@ -25,7 +28,7 @@ def tuplesum(tuples):
return tuple(map(mysum, zip(*list(tuples))))
def order_overview(event):
def order_overview(event: Event) -> Tuple[List[Tuple[ItemCategory, List[Item]]], Dict[str, Tuple[Decimal, Decimal]]]:
items = event.items.all().select_related(
'category', # for re-grouping
).prefetch_related(

2
src/pretix/base/services/tickets.py
View File

@@ -8,7 +8,7 @@ from pretix.base.models import CachedFile, CachedTicket, Order, cachedfile_name
from pretix.base.signals import register_ticket_outputs
def generate(order, provider):
def generate(order: str, provider: str):
order = Order.objects.current.select_related('event').get(identity=order)
ct = CachedTicket.objects.get_or_create(order=order, provider=provider)[0]
if not ct.cachedfile: