missionpanel 1.0.1__tar.gz → 1.0.2__tar.gz

{missionpanel-1.0.1 → missionpanel-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: missionpanel
-Version: 1.0.1
+Version: 1.0.2
 Summary: A mission panel
 Home-page: https://github.com/yindaheng98/missionpanel
 Author: yindaheng98

missionpanel-1.0.2/missionpanel/handler/__init__.py

@@ -0,0 +1,2 @@
+from .handler import Handler
+from .handler import AsyncHandler

missionpanel-1.0.2/missionpanel/handler/handler.py

@@ -0,0 +1,109 @@
+import abc
+import datetime
+from typing import List, Optional, Tuple, Union
+from sqlalchemy.orm import Session, Query
+from sqlalchemy.ext.asyncio import AsyncSession
+from missionpanel.orm import Mission, Tag, MissionTag, Attempt
+from sqlalchemy import select, func, distinct, case, Select
+
+
+class HandlerInterface(abc.ABC):
+
+    @staticmethod
+    def query_missions_by_tag(tags: List[str]) -> Select[Tuple[Mission]]:
+        return (
+            select(Mission)
+            .join(MissionTag)
+            .join(Tag)
+            .filter(Tag.name.in_(tags))
+            .group_by(Mission.id)
+            .having(func.count(distinct(Tag.name)) == len(tags))
+        )
+
+    @staticmethod
+    def query_todo_missions(tags: List[str]) -> Select[Tuple[Mission]]:
+        return (
+            HandlerInterface.query_missions_by_tag(tags)
+            .outerjoin(Attempt)
+            .group_by(Mission.id)
+            .having(func.count(
+                case(((  # see if Attempt is finished or working on the Mission
+                    Attempt.success.is_(True) |  # have finished handler
+                    (Attempt.last_update_time + Attempt.max_time_interval >= datetime.datetime.now())  # have working handler
+                ), 0), else_=None)) <= 0)  # get those Missions that have no finished or working Attempt
+        )
+
+    @staticmethod
+    def create_attempt(session: Union[Session | AsyncSession], mission: Mission, name: str, max_time_interval: datetime.timedelta = datetime.timedelta(seconds=1)) -> Attempt:
+        attempt = Attempt(
+            handler=name,
+            max_time_interval=max_time_interval,
+            content=mission.content,
+            mission=mission)
+        session.add(attempt)
+        return attempt
+
+
+class Handler(HandlerInterface, abc.ABC):
+    def __init__(self, session: Session, name: str, max_time_interval: datetime.timedelta = datetime.timedelta(seconds=1)):
+        self.session = session
+        self.name = name
+        self.max_time_interval = max_time_interval
+
+    @abc.abstractmethod
+    def select_mission(self, missions: Query[Mission]) -> Optional[Mission]:
+        return missions[0] if missions else None
+
+    def report_attempt(self, mission: Mission, attempt: Attempt):
+        attempt.success = False
+        attempt.last_update_time = datetime.datetime.now()
+        self.session.commit()
+
+    @abc.abstractmethod
+    def execute_mission(self, mission: Mission, attempt: Attempt) -> bool:
+        pass
+
+    def run_once(self, tags: List[str]):
+        missions = self.session.execute(HandlerInterface.query_todo_missions(tags)).scalars().all()
+        mission = self.select_mission(missions)
+        if mission is None:
+            return
+        attempt = HandlerInterface.create_attempt(self.session, mission, self.name, self.max_time_interval)
+        self.report_attempt(mission, attempt)
+        if self.execute_mission(mission, attempt):
+            attempt.success = True
+        self.report_attempt(mission, attempt)
+        return attempt
+
+
+class AsyncHandler(HandlerInterface, abc.ABC):
+    def __init__(self, session: AsyncSession, name: str, max_time_interval: datetime.timedelta = datetime.timedelta(seconds=1)):
+        self.session = session
+        self.name = name
+        self.max_time_interval = max_time_interval
+
+    @abc.abstractmethod
+    async def select_mission(self, missions: Query[Mission]) -> Optional[Mission]:
+        return missions[0] if missions else None
+
+    async def report_attempt(self, mission: Mission, attempt: Attempt):
+        attempt.last_update_time = datetime.datetime.now()
+        await self.session.commit()
+        await self.session.refresh(attempt)
+        await self.session.refresh(mission)
+
+    @abc.abstractmethod
+    async def execute_mission(self, mission: Mission, attempt: Attempt) -> bool:
+        pass
+
+    async def run_once(self, tags: List[str]):
+        missions = (await self.session.execute(HandlerInterface.query_todo_missions(tags))).scalars().all()
+        mission = await self.select_mission(missions)
+        if mission is None:
+            return
+        attempt = HandlerInterface.create_attempt(self.session, mission, self.name, self.max_time_interval)
+        await self.report_attempt(mission, attempt)
+        if await self.execute_mission(mission, attempt):
+            attempt.success = True
+        await self.report_attempt(mission, attempt)
+        return attempt

missionpanel-1.0.2/missionpanel/orm/__init__.py

@@ -0,0 +1,2 @@
+from .core import Base, Mission, Tag, MissionTag, Matcher
+from .handler import Attempt

missionpanel-1.0.2/missionpanel/orm/core.py

@@ -0,0 +1,69 @@
+import datetime
+from typing import List
+from sqlalchemy import (
+    Column,
+    Integer,
+    Text,
+    JSON,
+    DateTime,
+    ForeignKey
+)
+from sqlalchemy.orm import relationship, DeclarativeBase, Mapped
+from sqlalchemy.ext.asyncio import AsyncAttrs
+
+
+class Base(AsyncAttrs, DeclarativeBase):
+    pass
+
+
+class Mission(Base):
+    __tablename__ = "mission"
+    id = Column(Integer, primary_key=True, autoincrement=True, comment="Mission ID")
+    content = Column(JSON, default={}, comment="Mission Content")
+    create_time = Column(DateTime, default=datetime.datetime.now, comment="Mission Create Time")
+    last_update_time = Column(DateTime, default=datetime.datetime.now, onupdate=datetime.datetime.now, comment="Mission Update Time")
+
+    # back populate relationships
+    matchers: Mapped[List['Matcher']] = relationship(back_populates="mission")
+    tags: Mapped[List['MissionTag']] = relationship(back_populates="mission")
+
+    def __repr__(self):
+        return f"Mission(id={self.id}, content={self.content.__repr__()}, create_time={self.create_time.__repr__()}, last_update_time={self.last_update_time.__repr__()})"
+
+
+class Matcher(Base):
+    __tablename__ = "matcher"
+    pattern = Column(Text, primary_key=True, comment="Matcher Content")
+
+    # relationship
+    mission_id = Column(Integer, ForeignKey("mission.id"), index=True, comment="Mission ID")
+    mission: Mapped['Mission'] = relationship(Mission, back_populates="matchers")
+
+    def __repr__(self):
+        return f"Matcher(pattern={self.pattern.__repr__()}, mission_id={self.mission_id})"
+
+
+class Tag(Base):
+    __tablename__ = "tag"
+    name = Column(Text, primary_key=True, comment="Tag Name")
+
+    # back populate relationships
+    missions: Mapped[List['MissionTag']] = relationship(back_populates="tag")
+
+    def __repr__(self):
+        return f"Tag(name={self.name.__repr__()})"
+
+
+class MissionTag(Base):
+    __tablename__ = "missiontag"
+
+    # relationship
+    tag_name = Column(Text, ForeignKey("tag.name"), primary_key=True, comment="Tag")
+    tag: Mapped['Tag'] = relationship(Tag, back_populates="missions")
+
+    # relationship
+    mission_id = Column(Integer, ForeignKey("mission.id"), primary_key=True, comment="Mission ID")
+    mission: Mapped['Mission'] = relationship(Mission, back_populates="tags")
+
+    def __repr__(self):
+        return f"MissionTag(tag_name={self.tag_name.__repr__()}, mission_id={self.mission_id})"

missionpanel-1.0.2/missionpanel/orm/handler.py

@@ -0,0 +1,31 @@
+import datetime
+from sqlalchemy import (
+    Column,
+    Integer,
+    Text,
+    JSON,
+    Boolean,
+    DateTime,
+    Interval,
+    ForeignKey
+)
+from sqlalchemy.orm import relationship, Mapped
+from .core import Base, Mission
+
+
+class Attempt(Base):
+    __tablename__ = "attempt"
+    id = Column(Integer, primary_key=True, autoincrement=True, comment="Mission ID")
+    handler = Column(Text, comment="Handler Name")
+    create_time = Column(DateTime, default=datetime.datetime.now, comment="Attempt Start Time")
+    last_update_time = Column(DateTime, default=datetime.datetime.now, onupdate=datetime.datetime.now, comment="Attempt Last Update Time")
+    max_time_interval = Column(Interval, default=datetime.timedelta(seconds=1), comment="Attempt Update Time Interval")
+    content = Column(JSON, default={}, comment="Mission Content at that time")
+    success = Column(Boolean, default=False, comment="If this Attempt has succeed")
+
+    # relationship
+    mission_id = Column(Integer, ForeignKey("mission.id"), comment="Mission ID")
+    mission: Mapped['Mission'] = relationship(Mission, backref="attempts")
+
+    def __repr__(self):
+        return f"Attempt(id={self.id}, handler={self.handler.__repr__()}, create_time={self.create_time.__repr__()}, last_update_time={self.last_update_time.__repr__()}, max_time_interval={self.max_time_interval.__repr__()}, content={self.content.__repr__()}, success={self.success}, mission_id={self.mission_id})"

missionpanel-1.0.2/missionpanel/submitter/__init__.py

@@ -0,0 +1,2 @@
+from .submitter import Submitter
+from .asynchronous import AsyncSubmitter

missionpanel-1.0.2/missionpanel/submitter/abc.py

@@ -0,0 +1,45 @@
+from typing import List, Union, Tuple
+from sqlalchemy.orm import Session
+from sqlalchemy.ext.asyncio import AsyncSession
+from missionpanel.orm import Mission, Tag, Matcher, MissionTag
+from sqlalchemy import select, Select
+
+
+class SubmitterInterface:
+    '''
+    SubmitterInterface is an interface for Submitter and AsyncSubmitter to implement the common methods.
+    There is no anything about session.execute in this class.
+    '''
+    @staticmethod
+    def query_matcher(match_patterns: List[str]) -> Select[Tuple[Matcher]]:
+        return select(Matcher).where(Matcher.pattern.in_(match_patterns)).limit(1).with_for_update()
+
+    @staticmethod
+    def add_mission_matchers(session: Union[Session | AsyncSession], mission: Mission, match_patterns: List[str], existing_matchers: List[Matcher] = []) -> Mission:
+        exist_patterns = [matcher.pattern for matcher in existing_matchers]
+        session.add_all([Matcher(pattern=pattern, mission=mission) for pattern in match_patterns if pattern not in exist_patterns])
+
+    @staticmethod
+    def create_mission(session: Union[Session | AsyncSession], content: str, match_patterns: List[str], existing_mission: Union[Mission | None] = None) -> Mission:
+        if existing_mission is None:
+            mission = Mission(
+                content=content,
+                matchers=[Matcher(pattern=pattern) for pattern in match_patterns],
+            )
+            session.add(mission)
+        else:
+            mission = existing_mission
+            if mission.content != content:
+                mission.content = content
+        return mission
+
+    @staticmethod
+    def query_tag(tags_name: List[str]) -> Select[Tuple[Matcher]]:
+        return select(Tag).where(Tag.name.in_(tags_name)).with_for_update()
+
+    @staticmethod
+    def add_mission_tags(session: Union[Session | AsyncSession], mission: Mission, tags_name: List[str], exist_tags: List[Tag] = [], exist_mission_tags: List[MissionTag] = []):
+        exist_tags_name = [tag.name for tag in exist_tags]
+        session.add_all([Tag(name=tag_name) for tag_name in tags_name if tag_name not in exist_tags_name])
+        exist_mission_tags_name = [tag.tag_name for tag in exist_mission_tags]
+        session.add_all([MissionTag(mission=mission, tag_name=tag_name) for tag_name in tags_name if tag_name not in exist_mission_tags_name])

missionpanel-1.0.2/missionpanel/submitter/asynchronous.py

@@ -0,0 +1,60 @@
+from typing import List, Union
+from sqlalchemy.ext.asyncio import AsyncSession
+from missionpanel.orm import Mission
+from .abc import SubmitterInterface
+
+
+class AsyncSubmitterInterface(SubmitterInterface):
+
+    @staticmethod
+    async def _query_mission(session: AsyncSession, match_patterns: List[str]) -> Mission:
+        matcher = (await session.execute(SubmitterInterface.query_matcher(match_patterns))).scalars().first()
+        if matcher is None:
+            return None
+        mission = await matcher.awaitable_attrs.mission
+        existing_matchers = await mission.awaitable_attrs.matchers
+        SubmitterInterface.add_mission_matchers(session, mission, match_patterns, existing_matchers)
+        return mission
+
+    @staticmethod
+    async def _add_tags(session: AsyncSession, mission: Union[Mission | None] = None, tags: List[str] = []):
+        exist_tags = (await session.execute(SubmitterInterface.query_tag(tags))).scalars().all() if len(tags) > 0 else []
+        exist_mission_tags = await mission.awaitable_attrs.tags
+        SubmitterInterface.add_mission_tags(session, mission, tags, exist_tags, exist_mission_tags)
+
+    @staticmethod
+    async def match_mission(session: AsyncSession, match_patterns: List[str]) -> Mission:
+        mission = await AsyncSubmitterInterface._query_mission(session, match_patterns)
+        await session.commit()
+        return mission
+
+    @staticmethod
+    async def create_mission(session: AsyncSession, content: str, match_patterns: List[str], tags: List[str] = []):
+        mission = await AsyncSubmitterInterface._query_mission(session, match_patterns)
+        mission = SubmitterInterface.create_mission(session, content, match_patterns, mission)
+        await AsyncSubmitterInterface._add_tags(session, mission, tags)
+        await session.commit()
+        await session.refresh(mission)
+        return mission
+
+    @staticmethod
+    async def add_tags(session: AsyncSession, match_patterns: List[str], tags: List[str]):
+        mission = await AsyncSubmitterInterface._query_mission(session, match_patterns)
+        if mission is None:
+            raise ValueError("Mission not found")
+        await AsyncSubmitterInterface._add_tags(session, mission, tags)
+        await session.commit()
+
+
+class AsyncSubmitter(AsyncSubmitterInterface):
+    def __init__(self, session: AsyncSession):
+        self.session = session
+
+    async def match_mission(self, match_patterns: List[str]) -> Mission:
+        return await AsyncSubmitterInterface.match_mission(self.session, match_patterns)
+
+    async def create_mission(self, content: str, match_patterns: List[str]):
+        return await AsyncSubmitterInterface.create_mission(self.session, content, match_patterns)
+
+    async def add_tags(self, matchers: List[str], tags: List[str]):
+        return await AsyncSubmitterInterface.add_tags(self.session, matchers, tags)

missionpanel-1.0.2/missionpanel/submitter/submitter.py

@@ -0,0 +1,56 @@
+from typing import List, Union
+from sqlalchemy.orm import Session
+from missionpanel.orm import Mission
+from .abc import SubmitterInterface
+
+
+class SyncSubmitterInterface(SubmitterInterface):
+
+    @staticmethod
+    def _query_mission(session: Session, match_patterns: List[str]) -> Mission:
+        matcher = session.execute(SubmitterInterface.query_matcher(match_patterns)).scalars().first()
+        if matcher is None:
+            return None
+        SubmitterInterface.add_mission_matchers(session, matcher.mission, match_patterns, matcher.mission.matchers)
+        return matcher.mission
+
+    @staticmethod
+    def _add_tags(session: Session, mission: Union[Mission | None] = None, tags: List[str] = []):
+        exist_tags = session.execute(SubmitterInterface.query_tag(tags)).scalars().all()
+        tags = SubmitterInterface.add_mission_tags(session, mission, tags, exist_tags, mission.tags)
+
+    @staticmethod
+    def match_mission(session: Session, match_patterns: List[str]) -> Mission:
+        mission = SyncSubmitterInterface._query_mission(session, match_patterns)
+        session.commit()
+        return mission
+
+    @staticmethod
+    def create_mission(session: Session, content: str, match_patterns: List[str], tags: List[str] = []):
+        mission = SyncSubmitterInterface._query_mission(session, match_patterns)
+        mission = SubmitterInterface.create_mission(session, content, match_patterns, mission)
+        SyncSubmitterInterface._add_tags(session, mission, tags)
+        session.commit()
+        return mission
+
+    @staticmethod
+    def add_tags(session: Session, match_patterns: List[str], tags: List[str]):
+        mission = SyncSubmitterInterface._query_mission(session, match_patterns)
+        if mission is None:
+            raise ValueError("Mission not found")
+        SyncSubmitterInterface._add_tags(session, mission, tags)
+        session.commit()
+
+
+class Submitter(SyncSubmitterInterface):
+    def __init__(self, session: Session):
+        self.session = session
+
+    def match_mission(self, match_patterns: List[str]) -> Mission:
+        return SyncSubmitterInterface.match_mission(self.session, match_patterns)
+
+    def create_mission(self, content: str, match_patterns: List[str], tags: List[str] = []):
+        return SyncSubmitterInterface.create_mission(self.session, content, match_patterns, tags)
+
+    def add_tags(self, match_patterns: List[str], tags: List[str]):
+        return SyncSubmitterInterface.add_tags(self.session, match_patterns, tags)

{missionpanel-1.0.1 → missionpanel-1.0.2}/missionpanel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: missionpanel
-Version: 1.0.1
+Version: 1.0.2
 Summary: A mission panel
 Home-page: https://github.com/yindaheng98/missionpanel
 Author: yindaheng98

missionpanel-1.0.2/missionpanel.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+LICENSE
+README.md
+setup.py
+missionpanel/__init__.py
+missionpanel.egg-info/PKG-INFO
+missionpanel.egg-info/SOURCES.txt
+missionpanel.egg-info/dependency_links.txt
+missionpanel.egg-info/requires.txt
+missionpanel.egg-info/top_level.txt
+missionpanel/handler/__init__.py
+missionpanel/handler/handler.py
+missionpanel/orm/__init__.py
+missionpanel/orm/core.py
+missionpanel/orm/handler.py
+missionpanel/submitter/__init__.py
+missionpanel/submitter/abc.py
+missionpanel/submitter/asynchronous.py
+missionpanel/submitter/submitter.py

{missionpanel-1.0.1 → missionpanel-1.0.2}/setup.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-from setuptools import setup
+from setuptools import find_packages, setup
 
 with open("README.md", "r", encoding='utf8') as fh:
     long_description = fh.read()
@@ -12,15 +12,15 @@ package_dir = {
 
 setup(
     name='missionpanel',
-    version='1.0.1',
+    version='1.0.2',
     author='yindaheng98',
     author_email='yindaheng98@gmail.com',
     url='https://github.com/yindaheng98/missionpanel',
     description=u'A mission panel',
     long_description=long_description,
     long_description_content_type="text/markdown",
-    package_dir=package_dir,
-    packages=[key for key in package_dir],
+    package_dir={'missionpanel': 'missionpanel'},
+    packages=['missionpanel'] + ["missionpanel." + package for package in find_packages(where="missionpanel")],
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",

missionpanel-1.0.1/missionpanel.egg-info/SOURCES.txt

@@ -1,9 +0,0 @@
-LICENSE
-README.md
-setup.py
-missionpanel/__init__.py
-missionpanel.egg-info/PKG-INFO
-missionpanel.egg-info/SOURCES.txt
-missionpanel.egg-info/dependency_links.txt
-missionpanel.egg-info/requires.txt
-missionpanel.egg-info/top_level.txt