Panic’s documentation

• Codebase
  • panic
    • appengine
      • apps.py
        • AppEngineConfig
      • urls.py
      • views.py
        • WarmUp
          • WarmUp.get()
    • config
      • environments
        • settings_admin.py
        • settings_local.py
        • settings_prod.py
        • settings_stage.py
      • settings.py
      • settings_apps.py
      • settings_database.py
      • settings_email.py
      • settings_jwt.py
      • settings_registration.py
      • settings_restframework.py
    • kitchen
      • admin
        • item_modeladmin.py
          • ItemModelAdmin
            • ItemModelAdmin.expired()
            • ItemModelAdmin.form
            • ItemModelAdmin.next_expiry_datetime()
            • ItemModelAdmin.next_expiry_quantity()
        • item_modeladmin_form.py
          • ItemAdminForm
            • ItemAdminForm.clean_user()
            • ItemAdminForm.media
        • preferred_store_modeladmin.py
          • PreferredStoreInline
            • PreferredStoreInline.formset
            • PreferredStoreInline.model
        • preferred_store_modeladmin_form.py
          • PreferredStoreAdminFormSet
            • PreferredStoreAdminFormSet.clean()
      • exceptions
        • ConfirmationRequired
        • ProcessingError
        • ResourceIsRequired
        • ValidationPermissionError
        • validation_exception_handler.py
          • ValidationExceptionHandler
            • ValidationExceptionHandler.__init__()
            • ValidationExceptionHandler.process()
      • management
        • commands
          • load_testdata.py
            • Command
              • Command.add_arguments()
              • Command.handle()
          • rebuild_inventory.py
            • Command
              • Command.handle()
            • Confirmation
          • rebuild_item_quantities.py
            • Command
              • Command.handle()
            • Confirmation
      • models
        • managers
          • inventory
            • InventoryManager
            • adjustment.py
              • AdjustmentManager
                • AdjustmentManager.adjust()
                • AdjustmentManager.select_inventory_by_item()
            • expiration.py
              • ExpirationManager
                • ExpirationManager.get_expired()
                • ExpirationManager.get_inventory_expiration_datetime()
                • ExpirationManager.get_next_expiry_datetime()
                • ExpirationManager.get_next_expiry_quantity()
            • quantity.py
              • QuantityManager
                • QuantityManager.get_quantity()
          • item
            • ItemManager
            • maintenance.py
              • MaintenanceManager
                • MaintenanceManager.rebuild_quantities_from_inventory()
          • transaction
            • TransactionManager
            • activity.py
              • ActivityManager
                • ActivityManager.get_activity_first()
                • ActivityManager.get_activity_last_two_weeks()
                • ActivityManager.get_usage_current_month()
                • ActivityManager.get_usage_current_week()
                • ActivityManager.get_usage_total()
            • maintenance.py
              • MaintenanceManager
                • MaintenanceManager.rebuild_inventory_table()
        • validators
          • transaction.py
            • TransactionQuantityValidator
              • TransactionQuantityValidator.compare()
              • TransactionQuantityValidator.deconstruct()
            • related_item_quantity_validator()
        • constants.py
        • inventory.py
          • Inventory
            • Inventory.DoesNotExist
            • Inventory.MultipleObjectsReturned
            • Inventory.clean()
        • item.py
          • Item
            • Item.DoesNotExist
            • Item.MultipleObjectsReturned
            • Item.activity_first
            • Item.activity_last_two_weeks
            • Item.clean()
            • Item.invalidate_caches()
            • Item.next_expiry_date
            • Item.next_expiry_datetime
            • Item.usage_avg_month
            • Item.usage_avg_week
            • Item.usage_current_month
            • Item.usage_current_week
            • Item.usage_total
        • mixins.py
          • FullCleanMixin
            • FullCleanMixin.save()
          • RelatedFieldEnforcementMixin
            • RelatedFieldEnforcementMixin.related_validator()
          • UniqueNameConstraintMixin
            • UniqueNameConstraintMixin.clean()
        • preferred_store.py
          • PreferredStore
            • PreferredStore.DoesNotExist
            • PreferredStore.MultipleObjectsReturned
        • shelf.py
          • Shelf
            • Shelf.DoesNotExist
            • Shelf.MultipleObjectsReturned
        • store.py
          • Store
            • Store.DoesNotExist
            • Store.MultipleObjectsReturned
        • suggested.py
          • SuggestedItem
            • SuggestedItem.DoesNotExist
            • SuggestedItem.MultipleObjectsReturned
        • transaction.py
          • Transaction
            • Transaction.DoesNotExist
            • Transaction.MultipleObjectsReturned
            • Transaction.apply_transaction_to_item()
            • Transaction.clean()
            • Transaction.operation
            • Transaction.save()
      • serializers
        • fields
          • preferred_stores.py
            • PreferredStoreSerializerField
              • PreferredStoreSerializerField.__init__()
        • reports
          • item_activity
            • ItemActivityReportSerializer
              • ItemActivityReportSerializer.get_recent_activity()
            • item_activity_last_two_weeks.py
              • LastTwoWeeksActivitySerializer
                • LastTwoWeeksActivitySerializer.create()
                • LastTwoWeeksActivitySerializer.update()
            • item_activity_recent.py
              • RecentActivitySerializer
                • RecentActivitySerializer.get_user_timezone()
        • bases.py
          • KitchenBaseModelSerializer
            • KitchenBaseModelSerializer.case_unique_validator()
            • KitchenBaseModelSerializer.related_validator()
        • constants.py
        • item.py
          • ItemSerializer
            • ItemSerializer.validate_name()
            • ItemSerializer.validate_preferred_stores()
            • ItemSerializer.validate_shelf()
        • shelf.py
          • ShelfSerializer
            • ShelfSerializer.validate_name()
        • store.py
          • StoreSerializer
            • StoreSerializer.validate_name()
        • suggested.py
          • SuggestedItemSerializer
        • transaction.py
          • TransactionSerializer
            • TransactionSerializer.validate_item()
      • signals
        • item.py
          • item_preferred_stores_validator()
        • transaction.py
          • transaction_post_save_handler()
      • versions
        • v1.py
      • views
        • bases.py
          • KitchenBaseView
        • item.py
          • ItemBaseViewSet
            • ItemBaseViewSet.serializer_class
          • ItemListCreateViewSet
            • ItemListCreateViewSet.filterset_class
            • ItemListCreateViewSet.get_queryset()
            • ItemListCreateViewSet.pagination_class
            • ItemListCreateViewSet.perform_create()
          • ItemViewSet
            • ItemViewSet.activity()
            • ItemViewSet.perform_update()
        • mixins.py
          • ProtectedResourceMixin
            • ProtectedResourceMixin.perform_destroy()
        • shelf.py
          • BaseShelfView
            • BaseShelfView.serializer_class
          • ShelfListCreateViewSet
            • ShelfListCreateViewSet.get_queryset()
            • ShelfListCreateViewSet.pagination_class
            • ShelfListCreateViewSet.perform_create()
          • ShelfViewSet
        • store.py
          • StoreBaseView
            • StoreBaseView.serializer_class
          • StoreListCreateViewSet
            • StoreListCreateViewSet.get_queryset()
            • StoreListCreateViewSet.pagination_class
            • StoreListCreateViewSet.perform_create()
          • StoreViewSet
        • suggested.py
          • SuggestedBaseView
            • SuggestedBaseView.serializer_class
          • SuggestedItemListViewSet
            • SuggestedItemListViewSet.get_queryset()
            • SuggestedItemListViewSet.pagination_class
        • transaction.py
          • BaseTransactionView
            • BaseTransactionView.serializer_class
          • TransactionViewSet
      • apps.py
        • KitchenConfig
          • KitchenConfig.ready()
      • filters.py
        • ItemFilter
        • TransactionFilter
      • pagination.py
        • BasePagePagination
        • LegacyTransactionPagination
        • PagePaginationWithOverride
          • PagePaginationWithOverride.paginate_queryset()
      • permissions.py
        • IsOwner
          • IsOwner.has_object_permission()
      • swagger.py
        • openapi_ready()
    • legal
      • apps.py
        • LegalConfig
      • urls.py
      • views.py
        • PrivacyPolicyView
        • TOSView
    • naturalsortfield
      • fields.py
        • NaturalSortField
          • NaturalSortField.__init__()
          • NaturalSortField.deconstruct()
          • NaturalSortField.naturalize()
          • NaturalSortField.pre_save()
    • patches
      • patched_access_token.py
        • PatchedAccessToken
          • PatchedAccessToken.for_user()
    • root
      • exceptions
        • root_exception_handler()
      • toctree
      • urls
        • api
          • v1.py
        • openapi.py
      • asgi.py
      • wsgi.py
    • social_accounts
      • management
        • commands
          • autoadmin.py
            • Command
              • Command.handle()
          • autosocial.py
            • Command
              • Command.add_arguments()
              • Command.handle()
      • signals
        • presocial_login.py
          • EmailAddressQuery
            • EmailAddressQuery.__init__()
          • PreSocialConnector
            • PreSocialConnector.__init__()
            • PreSocialConnector.get_user_for_connection()
            • PreSocialConnector.search_for_user()
          • pre_social_login_handler()
          • process_social_connect()
      • utilities
        • social_app.py
          • create_social_app()
      • apps.py
        • SocialAccountsConfig
          • SocialAccountsConfig.ready()
      • urls.py
      • views.py
        • FacebookLogin
        • GoogleLogin
    • spa_security
      • mixins
        • csrf.py
          • CSRFMixin
            • CSRFMixin.dispatch()
      • views
        • csrf_error.py
          • csrf_error_view()
          • csrf_json_error_view()
        • csrf_token.py
          • CSRFTokenView
            • CSRFTokenView.get()
      • apps.py
        • SecurityConfig
      • fields.py
        • BlondeCharField
          • BlondeCharField.pre_save()
      • urls.py
    • user
      • admin
        • user_modeladmin.py
          • UserModelAdmin
      • models
        • validators
          • user.py
            • validate_language()
        • user.py
          • User
            • User.DoesNotExist
            • User.MultipleObjectsReturned
            • User.save()
      • serializers
        • validators
          • user.py
            • validate_language()
        • bases.py
          • UserBase
            • UserBase.create()
            • UserBase.update()
        • details.py
          • UserDetailsSerializer
        • timezones.py
          • TimezoneSerializer
            • TimezoneSerializer.create()
            • TimezoneSerializer.update()
      • signals
        • signup.py
          • user_signed_up_event()
          • user_signed_up_handler()
      • utilities
        • timezones.py
          • generate_timezones()
      • apps.py
        • UserConfig
          • UserConfig.ready()
      • urls.py
      • views.py
        • TimeZones
          • TimeZones.get()
    • utilities
      • config
        • module_cache.py
          • warm_module_cache()
      • database
        • connection.py
          • wait_for_database_connection()
      • debugger
        • vsc
          • Debugger
            • Debugger.debug()
            • Debugger.has_debug_enabled()
            • Debugger.is_main_process()
            • Debugger.is_run_server_command()
      • filesystem
        • paths.py
      • management
        • commands
          • toctree.py
            • Command
              • Command.add_arguments()
              • Command.handle()
            • Confirmation
          • wait_for_db.py
            • Command
              • Command.handle()
        • shared
          • confirmation.py
            • ManagementConfirmation
              • ManagementConfirmation.are_you_sure()
      • models
        • decorators
          • caching.py
            • PersistentCachedProperty
              • PersistentCachedProperty.__init__()
        • generators
          • superuser.py
            • create_superuser()
        • validators
          • m2m.py
            • ManyToManyRelatedValidator
              • ManyToManyRelatedValidator.__init__()
              • ManyToManyRelatedValidator.get_instance_value()
              • ManyToManyRelatedValidator.get_related_value()
              • ManyToManyRelatedValidator.validate()
      • serializers
        • fields
          • m2m.py
            • M2MThroughSerializerField
              • M2MThroughSerializerField.to_internal_value()
              • M2MThroughSerializerField.to_representation()
      • toctree
        • TocTree
          • TocTree.__init__()
          • TocTree.validate()
          • TocTree.write()
        • components
          • content.py
            • TocTreeContent
              • TocTreeContent.__init__()
              • TocTreeContent.accept()
              • TocTreeContent.generate()
          • logging.py
          • pruner.py
            • TocTreePruner
              • TocTreePruner.__init__()
              • TocTreePruner.accept()
              • TocTreePruner.prune()
          • validator.py
            • TocTreeValidator
              • TocTreeValidator.__init__()
              • TocTreeValidator.accept()
              • TocTreeValidator.check_content()
              • TocTreeValidator.check_file_exists()
              • TocTreeValidator.generate_content_error_message()
              • TocTreeValidator.generate_missing_file_error_message()
              • TocTreeValidator.validate()
          • writer.py
            • TocTreeWriter
              • TocTreeWriter.__init__()
              • TocTreeWriter.accept()
              • TocTreeWriter.write()
        • bases.py
          • AbstractContentGenerator
            • AbstractContentGenerator.__init__()
            • AbstractContentGenerator.generate()
          • AbstractPruner
            • AbstractPruner.__init__()
            • AbstractPruner.prune()
          • AbstractTocTreeFactorySettings
          • AbstractValidator
            • AbstractValidator.__init__()
            • AbstractValidator.validate()
          • AbstractVisitor
            • AbstractVisitor.accept()
          • AbstractWriter
            • AbstractWriter.__init__()
            • AbstractWriter.write()
        • factory.py
          • TocTreeFactory
            • TocTreeFactory.__init__()
            • TocTreeFactory.build()
        • settings.py
          • TocTreeFactorySettings
            • TocTreeFactorySettings.content
            • TocTreeFactorySettings.pruner
            • TocTreeFactorySettings.validator
            • TocTreeFactorySettings.writer
          • load_settings()
      • urls
        • include.py
          • selective_include()
      • views
        • deprecation.py
          • deprecated_response()
          • deprecated_warning()
      • apps.py
        • UtilitiesConfig
• License
• Repository README.md

Indices and tables

• Index

• Module Index

• Search Page