sarmat 1.2.3__tar.gz

sarmat-1.2.3/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sarmat-1.2.3/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.1
+Name: sarmat
+Version: 1.2.3
+Summary: Sarmat
+Home-page: 
+Author: Artel
+Author-email: Artel <artel61@gmail.com>
+License: Copyright (c) 2018 The Python Packaging Authority
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Sarmat.
+
+Библиотека для построения решений в сфере пассажирского транспорта.
+
+Основу работы библиотеки составляют объекты для построения рейсов
+и шаблонов для них, выполнения диспетчерских операций,
+и управления автотранспортом.
+
+## Состав библиотеки
+
+Библиотека состоит из набора тематических модулей, у каждого из которых своя область
+применения:
+
+* Сущности для описания справочников
+* Сущности для построения рейсов и маршрутов
+* Сущности для описания работы транспортной компании.
+
+## Композиция объектов
+
+Каждый из тематических объектов представлен в виде композиции классов.
+
+### Модели и контейнеры
+
+Модель содержит набор атрибутов, присущих объекту класса, 
+а также методы создания модели на основе контейнера. Реализована вложенность
+моделей. В том числе для описания иерархической модели справочников. Каждая модель
+является фабрикой для создания объектов своего типа. Фабричный метод принимает
+на вход аргумент, который имеет тип соответствующего контейнера.
+Контейнеры также могут быть вложенными.
+
+Контейнеры повторяют набор атрибутов, описанных в модели. Контейнеры предназначены
+для получения атрибутов извне и правильного создания модели 
+на основе полученных данных. Контейнеры написаны на основе классов `pydantic`.
+
+### Верификация объектов
+
+Основные правила верификации объектов описаны в контейнерах. Все случаи проверки,
+которые являются частью бизнес-логики, описаны в специальных классах верификаторах.
+Эти классы задействуются перед созданием модели из контейнера. Верификацию
+проходят **контейнеры**. Объекты верификации содержат рбязательный метод `verify`,
+в котором реализована логика проверки. Верификаторы могут быть вложенными. В этом
+случае процесс проверки будет идти от дочернего верификатора к родительскому.
+Метод верификации не возвращает значений, но возбуздает исключения 
+в случае нарушения правил проверки.
+
+Базовый верификатор проверяет на непустоту указанных атрибутов. Есть возможность
+создать верификатор на основе кастомного класса. В нем проверка происходит
+на основе встроенного словаря. Ключами словаря могут выступать строковые константы,
+а значениями - вызываемые объекты.
+
+### Поведение объектов
+
+Поведение объектов описано в поведенческих классах. Там реализован набор
+простейших операций, упрощающих процесс прикладной разработки. Поведенческие
+классы позволяют проводить сравнение двух объектов между собой (`==`, `!=`),
+выполнять операции проверки на неравенство (`>`, `<`, `>=`, `<=`).
+Для объектов, содержащих другие объекты, реализована проверка на вхождение
+во множество (`in`). За это ответственны поведенческие классы сравнения. Базовым
+поведенческим классом является класс `BhNoAction`, который можно использовать
+для переопределения или дополнения модели поведения для того или иного класса
+в рамках той или иной роли приложения.
+К примеру, сотрудник с правами оператора системы может создавать рейсы и 
+проводить с ними прочие операции редактирования. Другой сотрудник с правами
+диспетчера может обрабатывать созданные рейсы, но не может их создавать. Для
+описания этих различных моделей поведения необходимо создать два поведенческих класса
+`Actor` и `Dispatcher`, первый из которых будет содержать методы CRUD для работы
+с объектом, а втрой будет иметь набор методов работы с созданныим рейсами. Оба класса
+регистрируются в фабрике классов под своими псевдонимами. Потом нужный псевдоним
+указывается при вызове фабрики, и для каждой модели ищется соответствующий класс.
+Если необходимо совместить для пользователя полномочия, то соответствующие
+псевдонимы склеиваются. В качестве разделителя используется точка.
+
+### Действия с объектами
+
+Для объектов реализованы простейшие операции. Такие, как, например, копирование
+объекта. Реализованы специфические операции для конкретных объектов.
+
+## Сборка объектов
+
+Сборкой объектов занимаются фабрики классов. Каждая тематическая фабрика обладает
+набором методов, каждый из которых создает объект своего типа. Сборка объектов
+производится вызовом `type` с последующей инициализацией полученного класса при
+помощи данных, которые передаются в контейнере. В фабрике перечисляются
+родительские классы, а также указываются дополнительные атрибуты для будущего
+объекта: в атрибуте `controller` передается экземпляр фабрики для последующего
+использования при создании объектов во время выполнения бизнесс процессов.
+Также передается набор тегов доступа, которые были определены пользователю
+изначально.

sarmat-1.2.3/README.md

@@ -0,0 +1,88 @@
+# Sarmat.
+
+Библиотека для построения решений в сфере пассажирского транспорта.
+
+Основу работы библиотеки составляют объекты для построения рейсов
+и шаблонов для них, выполнения диспетчерских операций,
+и управления автотранспортом.
+
+## Состав библиотеки
+
+Библиотека состоит из набора тематических модулей, у каждого из которых своя область
+применения:
+
+* Сущности для описания справочников
+* Сущности для построения рейсов и маршрутов
+* Сущности для описания работы транспортной компании.
+
+## Композиция объектов
+
+Каждый из тематических объектов представлен в виде композиции классов.
+
+### Модели и контейнеры
+
+Модель содержит набор атрибутов, присущих объекту класса, 
+а также методы создания модели на основе контейнера. Реализована вложенность
+моделей. В том числе для описания иерархической модели справочников. Каждая модель
+является фабрикой для создания объектов своего типа. Фабричный метод принимает
+на вход аргумент, который имеет тип соответствующего контейнера.
+Контейнеры также могут быть вложенными.
+
+Контейнеры повторяют набор атрибутов, описанных в модели. Контейнеры предназначены
+для получения атрибутов извне и правильного создания модели 
+на основе полученных данных. Контейнеры написаны на основе классов `pydantic`.
+
+### Верификация объектов
+
+Основные правила верификации объектов описаны в контейнерах. Все случаи проверки,
+которые являются частью бизнес-логики, описаны в специальных классах верификаторах.
+Эти классы задействуются перед созданием модели из контейнера. Верификацию
+проходят **контейнеры**. Объекты верификации содержат рбязательный метод `verify`,
+в котором реализована логика проверки. Верификаторы могут быть вложенными. В этом
+случае процесс проверки будет идти от дочернего верификатора к родительскому.
+Метод верификации не возвращает значений, но возбуздает исключения 
+в случае нарушения правил проверки.
+
+Базовый верификатор проверяет на непустоту указанных атрибутов. Есть возможность
+создать верификатор на основе кастомного класса. В нем проверка происходит
+на основе встроенного словаря. Ключами словаря могут выступать строковые константы,
+а значениями - вызываемые объекты.
+
+### Поведение объектов
+
+Поведение объектов описано в поведенческих классах. Там реализован набор
+простейших операций, упрощающих процесс прикладной разработки. Поведенческие
+классы позволяют проводить сравнение двух объектов между собой (`==`, `!=`),
+выполнять операции проверки на неравенство (`>`, `<`, `>=`, `<=`).
+Для объектов, содержащих другие объекты, реализована проверка на вхождение
+во множество (`in`). За это ответственны поведенческие классы сравнения. Базовым
+поведенческим классом является класс `BhNoAction`, который можно использовать
+для переопределения или дополнения модели поведения для того или иного класса
+в рамках той или иной роли приложения.
+К примеру, сотрудник с правами оператора системы может создавать рейсы и 
+проводить с ними прочие операции редактирования. Другой сотрудник с правами
+диспетчера может обрабатывать созданные рейсы, но не может их создавать. Для
+описания этих различных моделей поведения необходимо создать два поведенческих класса
+`Actor` и `Dispatcher`, первый из которых будет содержать методы CRUD для работы
+с объектом, а втрой будет иметь набор методов работы с созданныим рейсами. Оба класса
+регистрируются в фабрике классов под своими псевдонимами. Потом нужный псевдоним
+указывается при вызове фабрики, и для каждой модели ищется соответствующий класс.
+Если необходимо совместить для пользователя полномочия, то соответствующие
+псевдонимы склеиваются. В качестве разделителя используется точка.
+
+### Действия с объектами
+
+Для объектов реализованы простейшие операции. Такие, как, например, копирование
+объекта. Реализованы специфические операции для конкретных объектов.
+
+## Сборка объектов
+
+Сборкой объектов занимаются фабрики классов. Каждая тематическая фабрика обладает
+набором методов, каждый из которых создает объект своего типа. Сборка объектов
+производится вызовом `type` с последующей инициализацией полученного класса при
+помощи данных, которые передаются в контейнере. В фабрике перечисляются
+родительские классы, а также указываются дополнительные атрибуты для будущего
+объекта: в атрибуте `controller` передается экземпляр фабрики для последующего
+использования при создании объектов во время выполнения бизнесс процессов.
+Также передается набор тегов доступа, которые были определены пользователю
+изначально.

sarmat-1.2.3/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0", "pydantic"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sarmat"
+version = "1.2.3"
+authors = [
+  { name="Artel", email="artel61@gmail.com" },
+]
+description = "Sarmat"
+readme = "README.md"
+license = { file="LICENSE" }
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = [
+    "tests",
+]

sarmat-1.2.3/sarmat/__init__.py

@@ -0,0 +1,3 @@
+VERSION = "1.2.3"
+
+__version__ = VERSION

sarmat-1.2.3/sarmat/core/__init__.py

@@ -0,0 +1,5 @@
+"""
+Sarmat.
+
+Ядро пакета.
+"""

sarmat-1.2.3/sarmat/core/actions/__init__.py

@@ -0,0 +1,20 @@
+"""
+Sarmat.
+
+Описание действий с объектами.
+"""
+__all__ = (
+    "AGeoLocationMixin", "ADestinationPointMixin", "AStationMixin", "ARouteMixin", "AJourneyMixin",
+    "AJourneyBunchMixin",
+)
+
+from .geo_locations import (
+    ADestinationPointMixin,
+    AGeoLocationMixin,
+)
+from .traffic_management import (
+    AJourneyMixin,
+    AJourneyBunchMixin,
+    ARouteMixin,
+    AStationMixin,
+)

sarmat-1.2.3/sarmat/core/actions/bases.py

@@ -0,0 +1,17 @@
+"""
+Sarmat.
+
+Описание действий с объектами.
+
+Базовые классы.
+"""
+
+
+class ActionMixin:
+    """Базовый класс-примесь для описания работы с объектами"""
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    def copy(self):
+        raise NotImplementedError

sarmat-1.2.3/sarmat/core/actions/dispatcher.py

@@ -0,0 +1,205 @@
+"""
+Sarmat.
+
+Описание поведения объектов.
+
+Поведение объектов в режиме работы диспетчера.
+"""
+from abc import ABC, abstractmethod
+from datetime import date, datetime, tzinfo
+from typing import Dict, Optional, List, Union
+from uuid import uuid4
+
+from sarmat.core.constants import JourneyClass, JourneyState
+from sarmat.core.context.models import (
+    PermitModel,
+    RouteItemModel,
+    StationModel,
+    JourneyProgressModel,
+    JourneyScheduleModel,
+    JourneyModel,
+)
+from sarmat.core.exceptions.sarmat_exceptions import ImpossibleOperationError
+
+from sarmat.core.behavior.traffic_management import BhJourney
+
+
+class Journey(BhJourney):
+    """Поведение объекта Рейс"""
+
+    def activate(
+        self,
+        start_date: date,
+        permit: PermitModel,
+    ) -> Dict[str, Union[JourneyProgressModel, List[JourneyScheduleModel]]]:
+        """
+        Активизация рейса (выписка рейсовой ведомости, создание расписания по рейсу)
+        Args:
+            start_date: дата начала выполнения рейса (отправление из начальной точки)
+            permit: путевой лист
+
+        Returns:
+            рейсовая ведомость
+            список активных пунктов маршрута
+
+        """
+        # атрибуты текущего рейса и список активных станций, через которые проходит рейс
+        this_journey = JourneyModel.from_container(self.raw())      # type: ignore
+        journey_stations = [item for item in self.get_journey_schedule(start_date) if item.station is not None]
+        first_station, *middleware_stations, last_station = journey_stations
+
+        journey_progress = JourneyProgressModel(  # Атрибуты рейсовой ведомости
+            uid=str(uuid4()),                     # идентификатор ведомости
+            depart_date=start_date,               # дата отправления в рейс
+            journey=this_journey,                 # рейс
+            permit=permit,                        # путевой лист
+        )
+
+        journey_schedule = [
+            JourneyScheduleModel(
+                uid=str(uuid4()),                      # идентификатор строки
+                journey_progress=journey_progress,     # рейсовая ведомость
+                journey_class=JourneyClass.BASE,       # класс рейса (формирующийся)
+                station=first_station.station,         # станция
+                point=first_station.point,             # пункт прохождения маршрута
+                state=JourneyState.READY,              # состояние рейса
+                plan_depart=first_station.depart,      # плановое время отправления
+                platform='',                           # платформа
+                comment='',                            # комментарий к текущему пункту
+            )
+        ]
+
+        journey_schedule += [
+            JourneyScheduleModel(
+                uid=str(uuid4()),                       # идентификатор строки
+                journey_progress=journey_progress,      # рейсовая ведомость
+                journey_class=JourneyClass.TRANSIT,     # класс рейса (формирующийся)
+                station=item.station,                   # станция
+                point=item.point,                       # пункт прохождения маршрута
+                state=JourneyState.READY,               # состояние рейса
+                plan_arrive=item.arrive,                # плановое время прибытия
+                plan_depart=item.depart,                # плановое время отправления
+                platform='',                            # платформа
+                comment='',                             # комментарий к текущему пункту
+            )
+            for item in middleware_stations
+        ]
+
+        journey_schedule.append(
+            JourneyScheduleModel(
+                uid=str(uuid4()),                           # идентификатор строки
+                journey_progress=journey_progress,          # рейсовая ведомость
+                journey_class=JourneyClass.ARRIVING,        # класс рейса (формирующийся)
+                station=last_station.station,               # станция
+                point=last_station.point,                   # пункт прохождения маршрута
+                state=JourneyState.READY,                   # состояние рейса
+                plan_arrive=last_station.arrive,            # плановое время прибытия
+                platform='',                                # платформа
+                comment='',                                 # комментарий к текущему пункту
+            )
+        )
+
+        for idx, item in enumerate(journey_schedule):
+            journey_schedule[idx].last_items = journey_schedule[idx+1:]
+
+        return {
+            'JourneyProgress': journey_progress,
+            'JourneyScheduleStructure': journey_schedule,
+        }
+
+
+class JourneySchedule:
+    """Поведение объекта Рейсовая ведомость в активном расписании"""
+
+    journey_class: JourneyClass
+    state: JourneyState
+    fact_arrive: datetime
+    fact_depart: datetime
+    permit: Optional[PermitModel]
+    platform: str
+    comment: str
+    last_items: List['JourneySchedule']
+    current_item: RouteItemModel
+
+    def make_departure(self, time_zone: Optional[tzinfo] = None) -> None:
+        """Операция отправления на текущем пункте"""
+
+        if self.journey_class == JourneyClass.ARRIVING:
+            raise ImpossibleOperationError("На последнем пункте маршрута операция отправления не выполняется")
+
+        self.state = JourneyState.DEPARTED
+        self.fact_depart = datetime.now(time_zone)
+
+    def make_registration(self,
+                          permit: Optional[PermitModel] = None,
+                          platform: Optional[str] = None,
+                          comments: Optional[str] = None) -> None:
+        """
+        Операция по регистрации рейса. Заполнение реквизитов
+        Args:
+            permit: путевой лист
+            platform: номер платформы
+            comments: комментарии диспетчера
+        """
+
+        if permit and (permit != self.permit):
+            self.permit = permit
+
+        if platform and platform != self.platform:
+            self.platform = platform
+
+        # NOTE: комментарий дозволяется затереть
+        if comments != self.comment:
+            self.comment = comments or ''
+
+    def make_arrival(self, time_zone: Optional[tzinfo] = None) -> None:
+        """Операция прибытия на текущем пункте"""
+        is_last = self.journey_class == JourneyClass.ARRIVING
+        operational_time = datetime.now(time_zone)
+
+        new_state = JourneyState.ARRIVED if is_last else JourneyState.ON_REGISTRATION
+        self.state = new_state
+        self.fact_arrive = operational_time
+
+    def cancel_journey(self) -> None:
+        """Отмена рейса"""
+        self._set_state_for_items_chain(JourneyState.CANCELLED)
+
+    def close_journey(self) -> None:
+        """Закрытие рейса"""
+        self._set_state_for_items_chain(JourneyState.CLOSED)
+
+    def break_journey(self) -> None:
+        """Отметка о срыве"""
+        self._set_state_for_items_chain(JourneyState.DISRUPTED)
+
+    @property
+    def current_station(self) -> Optional[StationModel]:
+        """Текущий пункт прохождения рейса"""
+        return self.current_item.station if self.current_item else None
+
+    def _set_state_for_items_chain(self, state: JourneyState) -> None:
+        """Назначение состояния текущему элементу и всем последующим"""
+        self.state = state
+        for item in self.last_items:
+            item.state = state
+
+
+class JourneyHook(ABC):
+    """Поведение объекта Рейсовая Ведомость"""
+
+    @abstractmethod
+    def lock_register(self):
+        """Блокировка ведомости"""
+
+    @abstractmethod
+    def unlock_register(self):
+        """Снятие блокировки с ведомости"""
+
+    @abstractmethod
+    def register_place(self):
+        """Регистрация места на ведомости"""
+
+    @abstractmethod
+    def unregister_place(self):
+        """Отмена регистрации места на ведомости"""

sarmat-1.2.3/sarmat/core/actions/geo_locations.py

@@ -0,0 +1,48 @@
+"""
+Sarmat.
+
+Описание действий с объектами.
+
+Классы для работы с объектами гео локации.
+"""
+from sarmat.core.constants import LocationType, SettlementType
+
+from .bases import ActionMixin
+
+
+class AGeoLocationMixin(ActionMixin):
+    """Действия с объектами гео локации"""
+
+    name: str
+    latin_name: str
+    mapping_data: dict
+    tags: str
+    location_type: LocationType
+    parent: object
+
+    def copy(self):
+        return self.__class__(
+            id=0,
+            name=f"Копия {self.name}",
+            location_type=self.location_type,
+            latin_name=f"Copy of {self.latin_name}" if self.latin_name else "",
+            mapping_data=self.mapping_data,
+            tags=self.tags,
+            parent=self.parent,
+        )
+
+
+class ADestinationPointMixin(ActionMixin):
+    """Действия с пунктами назначения"""
+
+    name: str
+    state: object
+    point_type: SettlementType
+
+    def copy(self):
+        return self.__class__(
+            id=0,
+            name=f"Копия {self.name}",
+            state=self.state,
+            point_type=self.point_type,
+        )