bluer-ugv 7.262.1__py3-none-any.whl → 7.291.1__py3-none-any.whl

bluer_ugv/README/build.py

@@ -15,37 +15,43 @@ from bluer_ugv.README import (
     shield,
     arzhang,
     rangin,
+    releases,
     swallow,
 )
 from bluer_ugv.README.ugvs import docs as ugvs
+from bluer_ugv.README.ugvs.comparison.build import build as build_comparison
 
 
 def build() -> bool:
-    return all(
-        README.build(
-            items=readme.get("items", []),
-            path=os.path.join(file.path(__file__), readme["path"]),
-            cols=readme.get("cols", 3),
-            ICON=ICON,
-            NAME=NAME,
-            VERSION=VERSION,
-            REPO_NAME=REPO_NAME,
-            help_function=lambda tokens: get_help(
-                tokens,
-                help_functions,
-                mono=True,
-            ),
-            macros=readme.get("macros", {}),
+    return (
+        all(
+            README.build(
+                items=readme.get("items", []),
+                path=os.path.join(file.path(__file__), readme["path"]),
+                cols=readme.get("cols", 3),
+                ICON=ICON,
+                NAME=NAME,
+                VERSION=VERSION,
+                REPO_NAME=REPO_NAME,
+                help_function=lambda tokens: get_help(
+                    tokens,
+                    help_functions,
+                    mono=True,
+                ),
+                macros=readme.get("macros", {}),
+            )
+            for readme in root.docs
+            + alias.docs
+            + arzhang.docs
+            + beast.docs
+            + eagle.docs
+            + fire.docs
+            + rangin.docs
+            + ravin.docs
+            + releases.docs
+            + shield.docs
+            + ugvs.docs
+            + swallow.docs
         )
-        for readme in root.docs
-        + beast.docs
-        + eagle.docs
-        + fire.docs
-        + ravin.docs
-        + shield.docs
-        + arzhang.docs
-        + swallow.docs
-        + alias.docs
-        + ugvs.docs
-        + rangin.docs
+        and build_comparison()
     )

bluer_ugv/README/releases.py

@@ -0,0 +1,8 @@
+docs = [
+    {
+        "path": "../docs/releases",
+    },
+    {
+        "path": "../docs/releases/one.md",
+    },
+]

bluer_ugv/README/ugvs/comparison/build.py

@@ -0,0 +1,135 @@
+import os
+from typing import List, Union
+from functools import reduce
+
+from blueness import module
+from bluer_objects import file
+
+from bluer_ugv import NAME
+from bluer_ugv.README.ugvs.comparison.ugvs.db import list_of_ugvs
+from bluer_ugv.README.ugvs.comparison.references.db import list_of_references
+from bluer_ugv.logger import logger
+
+
+NAME = module.name(__file__, NAME)
+
+
+def build(
+    log: bool = True,
+    reference_ugv_name: str = "arzhang",
+) -> bool:
+    reference_ugv = list_of_ugvs.get(reference_ugv_name)
+    if reference_ugv is None:
+        logger.error(f"{reference_ugv_name}: reference ugv not found.")
+        return False
+
+    logger.info(f"{NAME}.build")
+
+    success, contents = file.load_text(
+        file.absolute(
+            "../../../assets/comparison.html",
+            reference_path=file.path(__file__),
+        ),
+        log=log,
+    )
+    if not success:
+        return success
+
+    try:
+        content_index = [line.strip() for line in contents].index("contents:::")
+    except Exception as e:
+        logger.error(f"contents::: not found: {e}")
+        return False
+
+    contents = (
+        contents[:content_index]
+        + row_of(
+            [
+                "رديف",
+                "نام محصول مشابه",
+                "مشابهت و تفاوت ها محصول شما با آنها ",
+            ],
+            header=True,
+        )
+        + reduce(
+            lambda x, y: x + y,
+            [
+                row_of(
+                    [
+                        str(index + 1),
+                        ugv.description,
+                        reference_ugv.compare(ugv),
+                    ]
+                )
+                for index, ugv in enumerate(
+                    [
+                        ugv_
+                        for ugv_ in reversed(
+                            sorted(
+                                list_of_ugvs.db,
+                                key=lambda ugv: ugv.name,
+                            )
+                        )
+                        if ugv_.nickname not in [reference_ugv_name, "template"]
+                    ]
+                )
+            ],
+            [],
+        )
+        + contents[content_index + 1 :]
+        + ['<ol dir="rtl" style="text-align:right;">']
+        + [
+            '<li dir="rtl" style="text-align:{};"><a href="{}">{} - {}</a></li>'.format(
+                "right" if reference.is_in_farsi else "left",
+                reference.url,
+                reference.title,
+                reference.url,
+            )
+            for reference in reversed(
+                sorted(
+                    list_of_references.db,
+                    key=lambda reference: reference.title,
+                )
+            )
+            if reference.title != "template"
+        ]
+        + ['</ol dir="rtl" style="text-align:right;">']
+    )
+
+    return file.save_text(
+        file.absolute(
+            "../../../docs/UGVs/comparison.html",
+            reference_path=file.path(__file__),
+        ),
+        contents,
+        log=log,
+    )
+
+
+def row_of(
+    row: Union[List[str], List[List[str]]],
+    header: bool = False,
+) -> List[str]:
+    return (
+        ["{}<tr>".format(8 * "")]
+        + reduce(
+            lambda x, y: x + y,
+            [
+                [
+                    "{}<{}>".format(
+                        12 * " ",
+                        "th" if header else "td",
+                    )
+                ]
+                + ([item] if isinstance(item, str) else list(item))
+                + [
+                    "</{}>".format(
+                        "th" if header else "td",
+                    )
+                ]
+                for item in row
+            ],
+            [],
+        )
+        + ["{}</tr>".format(8 * "")]
+    )

bluer_ugv/README/ugvs/comparison/features/DYI.py

@@ -0,0 +1,8 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class DYIFeature(Feature):
+    nickname = "DYI"
+    long_name = "سادگی ساخت "
+
+    comparison_as_str = {}

bluer_ugv/README/ugvs/comparison/features/classes.py

@@ -0,0 +1,138 @@
+from typing import List, Any, Union, Tuple, Dict
+from enum import Enum, auto
+
+from bluer_ugv.logger import logger
+
+
+class Feature_Enum(Enum):
+    @property
+    def as_str(self):
+        return self.name
+
+
+class Feature_Comparison(Feature_Enum):
+    SIMILAR = auto()
+    HIGHER = auto()
+    LOWER = auto()
+
+    UNKNOWN = auto()
+
+
+class Feature:
+    nickname: str
+    long_name: str
+
+    comparison_as_str: Dict[Feature_Comparison, str] = {
+        Feature_Comparison.HIGHER: "بیشتر",
+        Feature_Comparison.LOWER: "کمتر",
+        Feature_Comparison.SIMILAR: "مشابه",
+    }
+
+    def __init__(
+        self,
+        score: Any,
+    ):
+        self.score = score
+
+    def compare(
+        self,
+        feature: Union["Feature", None],
+        ugv_name: str,
+        log: bool = False,
+    ) -> Tuple[Feature_Comparison, str]:
+        comparison: Feature_Comparison = Feature_Comparison.HIGHER
+        if feature is None:
+            if isinstance(self.score, bool):
+                comparison = (
+                    Feature_Comparison.HIGHER
+                    if self.score
+                    else Feature_Comparison.LOWER
+                )
+            else:
+                comparison = Feature_Comparison.UNKNOWN
+        elif feature.score is Ellipsis:
+            comparison = Feature_Comparison.UNKNOWN
+        elif self.score_index == feature.score_index:
+            comparison = Feature_Comparison.SIMILAR
+        elif self.score_index < feature.score_index:
+            comparison = Feature_Comparison.LOWER
+
+        if log:
+            logger.info(
+                "{}: {} ({}) vs. {} ({}): {}".format(
+                    self.__class__.__name__,
+                    self.score,
+                    self.score_index,
+                    "-" if feature is None else feature.score,
+                    "-" if feature is None else feature.score_index,
+                    comparison.name,
+                )
+            )
+
+        return comparison, self.describe_status(
+            comparison,
+            ugv_name,
+        )
+
+    def describe_status(
+        self,
+        comparison: Feature_Comparison,
+        ugv_name: str,
+    ) -> str:
+        return "{} {}{}{}".format(
+            self.long_name,
+            self.__class__.comparison_as_str.get(comparison, ""),
+            (
+                " در {} ".format(ugv_name)
+                if comparison != Feature_Comparison.SIMILAR
+                else ""
+            ),
+            (lambda info: f" ({info})" if info else "")(self.score_as_str()),
+        )
+
+    @property
+    def description(self) -> str:
+        return "{} {}".format(
+            self.long_name,
+            self.score_as_str(force=True),
+        )
+
+    def score_as_str(
+        self,
+        force: bool = False,
+    ) -> str:
+        return (
+            self.score.as_str
+            if isinstance(self.score, Feature_Enum) and force
+            else self.score_as_str_
+        )
+
+    @property
+    def score_as_str_(self) -> str:
+        return ""
+
+    @property
+    def score_index(self):
+        return (
+            int(self.score)
+            if isinstance(self.score, bool)
+            else self.score.value if isinstance(self.score, Enum) else self.score
+        )
+
+
+class FeatureList:
+    def __init__(self):
+        self.db: List[Feature] = []
+
+    def add(self, feature: Feature):
+        self.db.append(feature)
+
+    def get(
+        self,
+        feature_name: str,
+    ) -> Union[Feature, None]:
+        for feature in self.db:
+            if feature_name == feature.nickname:
+                return feature
+
+        return None

bluer_ugv/README/ugvs/comparison/features/concealment.py

@@ -0,0 +1,8 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class ConcealmentFeature(Feature):
+    nickname = "concealment"
+    long_name = "قابلیت استتار و کمین درازمدت"
+
+    comparison_as_str = {}

bluer_ugv/README/ugvs/comparison/features/control.py

@@ -0,0 +1,30 @@
+from enum import Enum
+
+from bluer_ugv.README.ugvs.comparison.features.classes import (
+    Feature,
+    Feature_Enum,
+    Feature_Comparison,
+)
+
+
+class UGV_Control(Feature_Enum):
+    AI = 2
+    RC = 1
+
+    @property
+    def as_str(self):
+        return {
+            UGV_Control.AI: "هوش مصنوعی",
+            UGV_Control.RC: "رادیویی",
+        }[self]
+
+
+class ControlFeature(Feature):
+    nickname = "control"
+    long_name = "سامانه‌ی کنترلی"
+
+    comparison_as_str = {
+        Feature_Comparison.HIGHER: "هوش مصنوعی",
+        Feature_Comparison.LOWER: "رادیویی",
+        Feature_Comparison.SIMILAR: "مشابه",
+    }

bluer_ugv/README/ugvs/comparison/features/cost.py

@@ -0,0 +1,30 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import (
+    Feature,
+    Feature_Comparison,
+    Feature_Enum,
+)
+
+
+class UGV_Cost(Feature_Enum):
+    LOW = 100  # < 100 mT ~= $100
+    MEDIUM = 10  # < 1 MT ~= $10k
+    HIGH = 1  #
+
+    @property
+    def as_str(self):
+        return {
+            UGV_Cost.LOW: "کم",
+            UGV_Cost.MEDIUM: "متوسط",
+            UGV_Cost.HIGH: "زیاد",
+        }[self]
+
+
+class CostFeature(Feature):
+    nickname = "cost"
+    long_name = "هزینه"
+
+    comparison_as_str = {
+        Feature_Comparison.HIGHER: "پایین‌تر",
+        Feature_Comparison.LOWER: "بالاتر",
+        Feature_Comparison.SIMILAR: "مشابه",
+    }

bluer_ugv/README/ugvs/comparison/features/db.py

@@ -0,0 +1,36 @@
+from typing import Dict, Type, List
+
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+from bluer_ugv.README.ugvs.comparison.features.concealment import ConcealmentFeature
+from bluer_ugv.README.ugvs.comparison.features.control import ControlFeature
+from bluer_ugv.README.ugvs.comparison.features.cost import CostFeature
+from bluer_ugv.README.ugvs.comparison.features.DYI import DYIFeature
+from bluer_ugv.README.ugvs.comparison.features.payload import PayloadFeature
+from bluer_ugv.README.ugvs.comparison.features.ps import PSFeature
+from bluer_ugv.README.ugvs.comparison.features.range import RangeFeature
+from bluer_ugv.README.ugvs.comparison.features.sanction_proof import (
+    SanctionProofFeature,
+)
+from bluer_ugv.README.ugvs.comparison.features.size import SizeFeature
+from bluer_ugv.README.ugvs.comparison.features.speed import SpeedFeature
+from bluer_ugv.README.ugvs.comparison.features.swarm import SwarmFeature
+from bluer_ugv.README.ugvs.comparison.features.uv_delivery import UVDeliveryFeature
+
+list_of_feature_classes: List[Type[Feature]] = [
+    ConcealmentFeature,
+    ControlFeature,
+    CostFeature,
+    DYIFeature,
+    PayloadFeature,
+    PSFeature,
+    RangeFeature,
+    SanctionProofFeature,
+    SizeFeature,
+    SpeedFeature,
+    SwarmFeature,
+    UVDeliveryFeature,
+]
+
+dict_of_feature_classes: Dict[str, Type[Feature]] = {
+    feature_class.nickname: feature_class for feature_class in list_of_feature_classes
+}

bluer_ugv/README/ugvs/comparison/features/payload.py

@@ -0,0 +1,21 @@
+from typing import Any
+
+from bluer_ugv.README.ugvs.comparison.features.classes import (
+    Feature,
+    Feature_Comparison,
+)
+
+
+class PayloadFeature(Feature):
+    nickname = "payload"
+    long_name = "توان حمل بار"
+
+    comparison_as_str = {
+        Feature_Comparison.HIGHER: "بیشتر",
+        Feature_Comparison.LOWER: "کمتر",
+        Feature_Comparison.SIMILAR: "مشابه",
+    }
+
+    @property
+    def score_as_str_(self) -> str:
+        return f"{self.score} کیلوگرم"

bluer_ugv/README/ugvs/comparison/features/ps.py

@@ -0,0 +1,8 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class PSFeature(Feature):
+    nickname = "ps"
+    long_name = "سامانه‌ی مکان‌یابی محلی"
+
+    comparison_as_str = {}

bluer_ugv/README/ugvs/comparison/features/range.py

@@ -0,0 +1,14 @@
+from typing import Any
+
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+unlimited_range: int = 999
+
+
+class RangeFeature(Feature):
+    nickname = "range"
+    long_name = "شعاع عملکرد عملیاتی"
+
+    @property
+    def score_as_str_(self) -> str:
+        return f"{self.score} کیلومتر" if self.score != unlimited_range else "نامحدود"

bluer_ugv/README/ugvs/comparison/features/sanction_proof.py

@@ -0,0 +1,8 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class SanctionProofFeature(Feature):
+    nickname = "sanction_proof"
+    long_name = "تحریم گریزی"
+
+    comparison_as_str = {}

bluer_ugv/README/ugvs/comparison/features/size.py

@@ -0,0 +1,32 @@
+from enum import Enum
+
+from bluer_ugv.README.ugvs.comparison.features.classes import (
+    Feature,
+    Feature_Comparison,
+    Feature_Enum,
+)
+
+
+class UGV_Size(Feature_Enum):
+    SMALL = 100  # < 5 kg
+    MEDIUM = 10  # < 50 kg
+    LARGE = 1
+
+    @property
+    def as_str(self):
+        return {
+            UGV_Size.SMALL: "کوچک",
+            UGV_Size.MEDIUM: "متوسط",
+            UGV_Size.LARGE: "بزرگ",
+        }[self]
+
+
+class SizeFeature(Feature):
+    nickname = "size"
+    long_name = "اندازه"
+
+    comparison_as_str = {
+        Feature_Comparison.HIGHER: "کوچکتر",
+        Feature_Comparison.LOWER: "بزرگتر",
+        Feature_Comparison.SIMILAR: "مشابه",
+    }

bluer_ugv/README/ugvs/comparison/features/speed.py

@@ -0,0 +1,10 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class SpeedFeature(Feature):
+    nickname = "speed"
+    long_name = "سرعت"
+
+    @property
+    def score_as_str_(self) -> str:
+        return f"{self.score} کیلومتر بر ساعت"

bluer_ugv/README/ugvs/comparison/features/swarm.py

@@ -0,0 +1,8 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class SwarmFeature(Feature):
+    nickname = "swarm"
+    long_name = "فعالیت گروهی "
+
+    comparison_as_str = {}

bluer_ugv/README/ugvs/comparison/features/uv_delivery.py

@@ -0,0 +1,8 @@
+from bluer_ugv.README.ugvs.comparison.features.classes import Feature
+
+
+class UVDeliveryFeature(Feature):
+    nickname = "uv_delivery"
+    long_name = "حمل پهپاد و رهپاد"
+
+    comparison_as_str = {}

bluer_ugv/README/ugvs/comparison/references/__init__.py

@@ -0,0 +1 @@
+

bluer_ugv/README/ugvs/comparison/references/classes.py

@@ -0,0 +1,27 @@
+from typing import List
+
+
+class Reference:
+    def __init__(
+        self,
+        title: str,
+        url: str,
+        list_of_ugvs: List[str] = [],
+        is_in_farsi: bool = False,
+    ):
+        self.title = title
+        self.url = url
+        self.list_of_ugvs = list_of_ugvs
+        self.is_in_farsi = is_in_farsi
+
+
+class List_of_References:
+    def __init__(self):
+        self.db: List[Reference] = []
+
+    def add(
+        self,
+        **kw_args,
+    ):
+        ugv = Reference(**kw_args)
+        self.db.append(ugv)