bovine_store.actor.bovine_store_actor
BovineStoreActor
Bases: BovineActor
Represents an actor controlled by bovine and stored in the database. This class should be used to perform actions as this actor. In particular, instances of this class are passed to bovine_process when performing side effects.
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
|
add_to_followers(object_id)
async
add_to_following(object_id)
async
add_to_interaction(interaction, object_id, remote_id)
async
Adds to an interaction collection
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
str
|
The interaction either replies, shares, or likes |
required |
object_id
|
str
|
id of the object being interacted with |
required |
remote_id
|
str
|
id of the interaction, e.g. of the Like or Dislike |
required |
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
from_database(stored_actor, session)
async
staticmethod
Creates BovineStoreAction from database object
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stored_actor
|
The BovineActor object from the database |
required | |
session
|
An aiohttp.ClientSession |
required |
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
generate_new_object_id()
Creates a new object id
This contains a hard coded path; probably should replace with something better.
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
remove_from_followers(object_id)
async
remove_from_following(object_id)
async
remove_from_interaction(interaction, object_id, remote_id)
async
Removes an interaction from the corresponding collection
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interaction
|
str
|
The interaction either replies, shares, or likes |
required |
object_id
|
str
|
id of the object being interacted with |
required |
remote_id
|
str
|
id of the interaction, e.g. of the Like or Dislike |
required |
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
remove_references(remote_id)
async
Remove remote_id from replies collections
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
retrieve(object_id, include=[], skip_fetch=False, only_own=False)
async
Retrieves the object with identified by object_id. The logic is as follows:
- If object is in database and either local or remote and last updated in the last day, the object is returned from the database
- Otherwise the object is fetched (as the actor) unless skip_fetch is set
- Finally if include lists properties to be resolved, these objects are obtained using the above logic, and then added to the Object
Parameters:
Name | Type | Description | Default |
---|---|---|---|
object_id
|
str
|
The object id to fetch |
required |
include
|
List[str]
|
list of keys, who should be resolved against the database |
[]
|
skip_fetch
|
bool
|
set to true to not attempt to fetch remote object |
False
|
only_own
|
bool
|
Only returns if object is owned by actor |
False
|
Returns:
Type | Description |
---|---|
dict | None
|
The resulting object as a dictionary if successful otherwise |
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
retrieve_own_object(object_id)
async
Deprecated in favor of retrieve(..., only_own=True)
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
store(item, as_public=False, visible_to=[])
async
Stores object in database
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
store_for(owner, item, as_public=False, visible_to=[])
async
Stores a remote object
Parameters:
Name | Type | Description | Default |
---|---|---|---|
owner
|
str
|
The actor who has submitted the object |
required |
item
|
dict
|
The object to store |
required |
Source code in bovine_store/bovine_store/actor/bovine_store_actor.py
update(item)
async
update_profile(data)
async
Updates the Actor profile