spent_processing

Общее описание

Проект предусматривает интеграцию данных о времени, затраченном на выполнение задач, из Google Календаря в систему учета задач (таск-трекер). Основная цель - автоматизация процесса передачи информации о временных затратах для упрощения учета и анализа рабочего времени сотрудников.

Описание модулей проекта

1. Модуль обработки данных (processing.py): Обрабатывает информацию о времени, проведенном на задачах, и подготавливает ее к экспорту.
2. Модуль форм (forms.py): Управляет формами для ввода данных пользователями.
3. Модуль моделей (models.py): Содержит модели данных, используемые для хранения информации о задачах и времени.
4. Модуль управления правами доступа (migrations): Отвечает за настройку и управление правами доступа к функционалу проекта.

Общая логика работы системы

Система автоматически собирает данные из Google Календаря о времени, затраченном сотрудниками на задачи. Эти данные обрабатываются, преобразуются и загружаются в таск-трекер. Автоматизация процесса снижает риск ошибок при ручном вводе данных и ускоряет процесс учета рабочего времени.

Интеграция с внешними системами

1. Google Календарь: Используется для извлечения данных о временных затратах на задачи.
2. Система учета задач (таск-трекер): Принимает обработанные данные из Google Календаря для учета рабочего времени.

Действия в системе

1. tracker_spent_processing: Обработка данных о времени, затраченном на задачи, в системе учета задач для конкретного пользователя.
2. spent_processing: Обработка данных о времени, затраченном на задачи, для всех активных пользователей.
3. user_spent_processing: Обработка данных о времени, затраченном на задачи, для отдельно взятого пользователя.
4. process_calendar_spent: Обработка данных из календаря для определенного пользователя и трекера.
5. get_calendar_key: Получение ключа календаря на основе данных пользователя и трекера.
6. is_need_to_notify: Определение необходимости отправки уведомления о результатах обработки данных.

Сценарий использования

Представьте ситуацию в IT-компании, где сотрудники занимаются множеством задач и используют Google Календарь для планирования своего рабочего времени. В конце дня (или недели) им нужно перенести данные о затраченном времени в таск-трекер для учета рабочего времени и анализа производительности.

Используя этот проект, сотрудник запускает функцию spent_processing, которая автоматически собирает данные из Google Календаря всех активных пользователей. Система обрабатывает эту информацию, сопоставляет с задачами в таск-трекере и обновляет данные о времени, затраченном на каждую задачу. В случае обнаружения расхождений или ошибок, система отправляет уведомления соответствующим пользователям.

Таким образом, процесс учета рабочего времени становится автоматизированным, снижается риск ошибок при ручном вводе данных, и улучшается анализ эффективности работы сотрудников.

Модель данных

На основе предоставленного кода проекта можно выделить следующие сущности и их поля:

1. RightsSupport

   • id: Уникальный идентификатор. Автоматически создаваемый идентификатор записи.
   • permissions: Права доступа. Определяют разрешения, которые необходимы для выполнения различных действий в системе.

2. CalendarSpent

   • calendarId: Идентификатор календаря. Уникальный идентификатор календаря Google.
   • trackerUser: Пользователь трекера. Ссылка на пользователя системы учета задач.
   • process: Флаг обработки. Указывает, должны ли события из этого календаря обрабатываться.

3. TrackerUser

   • user: Пользователь. Ссылка на пользователя системы.
   • tracker: Трекер. Ссылка на систему учета задач, с которой связан пользователь.
   • api_key: API ключ. Ключ для доступа к API трекера.

4. User (Django standard model)

   • username: Имя пользователя. Логин пользователя.
   • email: Электронная почта. Адрес электронной почты пользователя.
   • is_active: Активность пользователя. Флаг, указывающий, активен ли пользователь.

Эти сущности и поля представляют основные элементы, используемые в проекте для учета времени, затраченного на задачи, и их обработки.

Диаграмма состояний

Воспользуемся синтаксисом Mermaid для создания диаграммы состояний. В ней будет отражено, какие действия возможны в каждом состоянии:

На диаграмме представлены основные этапы обработки данных в проекте: начиная с начального этапа обработки (SpentProcessing), через обработку каждого пользователя (UserSpentProcessing) и обработку данных календаря (CalendarSpentProcessing), до обновления и сохранения результатов в системе (DataUpdate).

Анализ кода проекта

Проведя анализ предоставленного кода проекта, можно выделить несколько моментов для улучшения:

1. Дублирование кода: В функциях tracker_spent_processing_impl и process_calendar_spent наблюдается дублирование логики обработки событий календаря. Рекомендуется вынести общий код в отдельный метод для уменьшения дублирования и упрощения поддержки кода.

2. Комплексность функций: Некоторые функции, например, process_calendar_spent, содержат многоуровневые условные операторы и циклы, что усложняет чтение и понимание кода. Стоит разбить такие функции на более мелкие, каждая из которых будет выполнять одну конкретную задачу.

3. Обработка исключений: В функции supress_calendar_spent_processing_errors имеется сложная логика обработки исключений. Предлагается упростить ее, разделив на несколько более мелких и специализированных блоков обработки исключений.

4. Улучшение читаемости: В функциях, таких как tracker_spent_processing_internal, использование множественных вложенных циклов и условий затрудняет чтение кода. Рекомендуется использовать вспомогательные функции и методы для улучшения структурирования и читаемости кода.

Оценка проекта по 10-балльной шкале: 6/10. Проект выполнен с учетом основных требований, но имеет потенциал для улучшения читаемости и структурирования кода.

Оценочное время разработки для опытной команды: 40-60 часов