roboherd 0.1.7__tar.gz → 0.1.8__tar.gz

{roboherd-0.1.7 → roboherd-0.1.8}/CHANGES.md

@@ -1,5 +1,10 @@
 # Changes to roboherd
 
+## 0.1.8 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/11129))
+
+- Add ConfigOverrides model [roboherd#43](https://codeberg.org/bovine/roboherd/issues/43)
+- Allow to skip startup [roboherd#41](https://codeberg.org/bovine/roboherd/issues/41)
+
 ## 0.1.7 ([Milestone](https://codeberg.org/bovine/roboherd/milestone/10741))
 
 - Repair docker file [roboherd#38](https://codeberg.org/bovine/roboherd/issues/38)

{roboherd-0.1.7 → roboherd-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: roboherd
-Version: 0.1.7
+Version: 0.1.8
 Summary: A Fediverse bot framework
 Project-URL: Documentation, https://bovine.codeberg.page/roboherd/
 Project-URL: Repository, https://codeberg.org/bovine/roboherd

{roboherd-0.1.7 → roboherd-0.1.8}/docs/index.md

@@ -122,7 +122,7 @@ handle = "nothingness"
 ```
 
 one would instead create a bot with the handle `acct:nothingness@dev.bovine.social`.
-Similarly, one can override the name and the `base_url` to use.
+The full list of options can be found in [roboherd.herd.manager.config.ConfigOverrides][].
 
 ### Posting on startup
 

{roboherd-0.1.7 → roboherd-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "roboherd"
-version = "0.1.7"
+version = "0.1.8"
 description = "A Fediverse bot framework"
 readme = "README.md"
 requires-python = ">=3.11"

{roboherd-0.1.7 → roboherd-0.1.8}/roboherd/cow/__init__.py

@@ -76,6 +76,13 @@ class RoboCow:
         ),
     )
 
+    skip_profile_update: bool = field(
+        default=False,
+        metadata=dict(
+            description="When set to True the profile is not updated automatically. Useful when managing a cow from multiple scripts."
+        ),
+    )
+
     internals: RoboCowInternals = field(
         default_factory=RoboCowInternals,
         metadata=dict(description="Internal data for the cow"),
@@ -166,19 +173,6 @@ class RoboCow:
 
         self.internals.startup_routine = func
 
-    def needs_update(self):
-        """Checks if the cow needs to be updated"""
-        if self.internals.profile is None:
-            return True
-
-        if self.information.name != self.internals.profile.get("name"):
-            return True
-
-        if self.information.description != self.internals.profile.get("summary"):
-            return True
-
-        return False
-
     async def run_startup(self, connection: Almabtrieb):
         """Runs when the cow is birthed"""
 
@@ -198,12 +192,8 @@ class RoboCow:
             )
             self.information.frequency = frequency
 
-        update = determine_profile_update(self.information, self.internals.profile)
-
-        if update:
-            logger.info("Updating profile for %s", self.information.handle)
-
-            await connection.trigger("update_actor", update)
+        if not self.skip_profile_update:
+            await self._run_profile_update(connection)
 
         if self.internals.startup_routine:
             await inject(self.internals.startup_routine)(
@@ -211,3 +201,14 @@ class RoboCow:
                 connection=connection,  # type:ignore
                 actor_id=self.internals.actor_id,  # type:ignore
             )  # type:ignore
+
+    async def _run_profile_update(self, connection: Almabtrieb):
+        if self.internals.profile is None:
+            raise ValueError("Profile is not set")
+
+        update = determine_profile_update(self.information, self.internals.profile)
+
+        if update:
+            logger.info("Updating profile for %s", self.information.handle)
+
+            await connection.trigger("update_actor", update)

roboherd-0.1.8/roboherd/cow/test_init.py

@@ -0,0 +1,41 @@
+from unittest.mock import AsyncMock
+
+from . import RoboCow
+from .types import Information
+
+
+def test_cron():
+    info = Information(handle="testcow")
+    cow = RoboCow(information=info)
+
+    @cow.cron("* * * * *")
+    async def test_func():
+        pass
+
+    assert len(cow.internals.cron_entries) == 1
+
+
+async def test_startup():
+    info = Information(handle="testcow")
+    cow = RoboCow(information=info)
+    cow.internals.profile = {"id": "http://host.test/actor/cow"}
+    mock = AsyncMock()
+    connection = AsyncMock()
+
+    cow.startup(mock)
+
+    await cow.run_startup(connection=connection)
+
+    mock.assert_called_once()
+    connection.trigger.assert_awaited_once()
+
+
+async def test_skip_startup():
+    info = Information(handle="testcow")
+    cow = RoboCow(information=info, skip_profile_update=True)
+    cow.internals.profile = {"id": "http://host.test/actor/cow"}
+
+    connection = AsyncMock()
+    await cow.run_startup(connection=connection)
+
+    connection.trigger.assert_not_awaited()

{roboherd-0.1.7 → roboherd-0.1.8}/roboherd/herd/manager/config.py

@@ -1,9 +1,32 @@
+from pydantic import BaseModel, Field
+
 from dataclasses import dataclass, field
 
 from roboherd.cow import RoboCow
 from .load import load_cow
 
 
+class ConfigOverrides(BaseModel):
+    """Values used in `roboherd.toml` to overide the default
+    values in the imported cow. This class is meant as a
+    reference, and not meant to be directly used."""
+
+    name: str | None = Field(
+        default=None, description="set to override the name", examples=["New name"]
+    )
+    handle: str | None = Field(
+        default=None, description="set to override the handle", examples=["new-handle"]
+    )
+    base_url: str | None = Field(
+        default=None,
+        description="set to override the base url",
+        examples=["https://other.example"],
+    )
+    skip_profile_update: bool | None = Field(
+        default=None, description="set to skip updating the profile", examples=[True]
+    )
+
+
 @dataclass
 class CowConfig:
     name: str = field(metadata={"description": "Name of the cow, must be unique"})
@@ -20,13 +43,14 @@ class CowConfig:
     def load(self) -> RoboCow:
         cow = load_cow(self.module, self.attribute)
 
-        if "name" in self.config:
-            cow.information.name = self.config["name"]
-        if "handle" in self.config:
-            cow.information.handle = self.config["handle"]
+        overrides = ConfigOverrides(**self.config)
+
+        for value in ["name", "handle", "base_url"]:
+            if getattr(overrides, value):
+                setattr(cow.information, value, getattr(overrides, value))
 
-        if "base_url" in self.config:
-            cow.internals.base_url = self.config["base_url"]
+        if overrides.skip_profile_update:
+            cow.skip_profile_update = overrides.skip_profile_update
 
         return cow
 

{roboherd-0.1.7 → roboherd-0.1.8}/roboherd/herd/manager/test_config.py

@@ -44,6 +44,7 @@ def test_from_name_and_dict_with_new_name():
         "bot": "roboherd.examples.moocow:moocow",
         "handle": "new_handle",
         "name": "new name",
+        "skip_profile_update": True,
     }
 
     config = CowConfig.from_name_and_dict(name, value)
@@ -52,6 +53,7 @@ def test_from_name_and_dict_with_new_name():
 
     assert cow.information.name == "new name"
     assert cow.information.handle == "new_handle"
+    assert cow.skip_profile_update is True
 
 
 def test_load_config(test_config):

{roboherd-0.1.7 → roboherd-0.1.8}/uv.lock

@@ -1363,7 +1363,7 @@ wheels = [
 
 [[package]]
 name = "roboherd"
-version = "0.1.6"
+version = "0.1.8"
 source = { editable = "." }
 dependencies = [
     { name = "aiohttp" },

roboherd-0.1.7/roboherd/cow/test_init.py

@@ -1,57 +0,0 @@
-import pytest
-from unittest.mock import AsyncMock
-
-from . import RoboCow
-from .types import Information
-
-
-@pytest.mark.parametrize(
-    "name,summary,profile,expected",
-    [
-        ("moocow", None, None, True),
-        ("moocow", None, {"id": "123"}, True),
-        ("moocow", None, {"id": "123", "name": "moocow"}, False),
-        ("moocow", None, {"id": "123", "name": "other"}, True),
-        ("moocow", "description", {"id": "123", "name": "moocow"}, True),
-        (
-            "moocow",
-            "description",
-            {"id": "123", "name": "moocow", "summary": "description"},
-            False,
-        ),
-    ],
-)
-def test_needs_update(name, summary, profile, expected):
-    info = Information(
-        handle="testcow",
-        name=name,
-        description=summary,
-    )
-    cow = RoboCow(information=info)
-    cow.internals.profile = profile
-
-    assert cow.needs_update() == expected
-
-
-def test_cron():
-    info = Information(handle="testcow")
-    cow = RoboCow(information=info)
-
-    @cow.cron("* * * * *")
-    async def test_func():
-        pass
-
-    assert len(cow.internals.cron_entries) == 1
-
-
-async def test_startup():
-    info = Information(handle="testcow")
-    cow = RoboCow(information=info)
-    cow.internals.profile = {"id": "http://host.test/actor/cow"}
-    mock = AsyncMock()
-
-    cow.startup(mock)
-
-    await cow.run_startup(AsyncMock())
-
-    mock.assert_called_once()