Jmaa/favro-sync
1
0
Fork 0
Code Actions Packages

Ruff

Browse Source
This commit is contained in:
Jon Michael Aanes 2024-11-28 23:27:15 +01:00
parent fb7c53b3ae
commit 81dd0d19df
Signed by: Jmaa
SSH Key Fingerprint: SHA256:Ab0GfHGCblESJx7JRE4fj4bFy/KRpeLhi41y4pF3sNA
5 changed files with 56 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
favro_sync/favro_client.py
View File

@ -117,7 +117,7 @@ class FavroClient:
seq_id: SeqId | None = None,
todo_list=False,
) -> Iterator[Card]:
request = self._get_cards_request(seq_id=seq_id,todo_list=todo_list)
request = self._get_cards_request(seq_id=seq_id, todo_list=todo_list)
yield from self._get_paginated(request, Card.from_json)
def get_collections(self) -> Iterator[Collection]:
@ -125,9 +125,10 @@ class FavroClient:
yield from self._get_paginated(request, Collection.from_json)
def _get_cards_prepared_request(
self, **kwargs,
self,
**kwargs,
) -> requests.PreparedRequest:
request = self._get_cards_request(**kwargs)
request = self._get_cards_request(**kwargs)
return self.session.prepare_request(request)
def _get_cards_request(
@ -228,7 +229,9 @@ class FavroClient:
self._invalidate_cache(card_id)
return self.update_card_contents_locally(card_id, card_contents)
def _get_paginated(self, base_request: requests.Request, entity_from_json) -> Iterator:
def _get_paginated(
self, base_request: requests.Request, entity_from_json,
) -> Iterator:
page = 0
request_id = None
num_pages = 1

40
favro_sync/favro_data_model.py
View File

@ -136,8 +136,8 @@ class CustomFieldItem:
@staticmethod
def from_json(json: dict[str, Any]) -> 'CustomFieldItem':
return CustomFieldItem(
custom_field_item_id=CustomFieldItemId(json['customFieldItemId']),
name=json['name'],
custom_field_item_id=CustomFieldItemId(json['customFieldItemId']),
name=json['name'],
)
@ -163,7 +163,9 @@ class CustomFieldInfo:
enabled: bool
custom_field_items: list[CustomFieldItem]
def get_field_item(self, field_item_id: CustomFieldItemId) -> CustomFieldItem | None:
def get_field_item(
self, field_item_id: CustomFieldItemId,
) -> CustomFieldItem | None:
for item in self.custom_field_items:
if item.custom_field_item_id == field_item_id:
return item
@ -174,11 +176,13 @@ class CustomFieldInfo:
return CustomFieldInfo(
organization_id=OrganizationId(json['organizationId']),
custom_field_id=CustomFieldId(json['customFieldId']),
widget_common_id=map_opt(WidgetCommonId,json.get('widgetCommonId')),
widget_common_id=map_opt(WidgetCommonId, json.get('widgetCommonId')),
type=json['type'],
name=json['name'],
enabled=json['enabled'],
custom_field_items=[CustomFieldItem.from_json(f) for f in json.get('customFieldItems', [])],
custom_field_items=[
CustomFieldItem.from_json(f) for f in json.get('customFieldItems', [])
],
)
@ -198,9 +202,9 @@ class CustomField:
else:
typed_value = [CustomFieldItemId(v) for v in value]
return CustomField(
custom_field_id = CustomFieldId(json['customFieldId']),
value = typed_value,
color = json.get('color'),
custom_field_id=CustomFieldId(json['customFieldId']),
value=typed_value,
color=json.get('color'),
)
@ -243,12 +247,13 @@ class Task:
position=json['position'],
)
@dataclasses.dataclass(frozen=True)
class Collection:
collection_id: CollectionId
organization_id: OrganizationId
name: str
shared_to_users: list[dict[str,str]] # TODO
shared_to_users: list[dict[str, str]] # TODO
public_sharing: str
background: str
is_archived: bool
@ -257,16 +262,17 @@ class Collection:
@staticmethod
def from_json(json: dict[str, Any]) -> 'Collection':
return Collection(
collection_id=CollectionId(json['collectionId']),
organization_id=OrganizationId(json['collectionId']),
name=json['name'],
shared_to_users=json['sharedToUsers'],
public_sharing=json['publicSharing'],
background=json['background'],
is_archived=json['archived'],
widget_common_id=map_opt(WidgetCommonId,json.get('widgetCommonId')),
collection_id=CollectionId(json['collectionId']),
organization_id=OrganizationId(json['collectionId']),
name=json['name'],
shared_to_users=json['sharedToUsers'],
public_sharing=json['publicSharing'],
background=json['background'],
is_archived=json['archived'],
widget_common_id=map_opt(WidgetCommonId, json.get('widgetCommonId')),
)
@dataclasses.dataclass(frozen=True)
class Card:
card_id: CardId

28
favro_sync/favro_fuse.py
View File

@ -8,7 +8,13 @@ from logging import getLogger
import fuse
from .favro_client import FavroClient
from .favro_data_model import Card, SeqId, CustomFieldInfo, CustomFieldItemId, CustomField
from .favro_data_model import (
Card,
CustomField,
CustomFieldInfo,
CustomFieldItemId,
SeqId,
)
from .favro_markdown import CardContents, CardFileFormatter
################################################################################
@ -26,9 +32,10 @@ CARD_FILENAME_REGEX = r'^PAR\-(\d+)\.md$'
################################################################################
# Formatting
def to_custom_field_value(custom_field: CustomField, field_def: CustomFieldInfo) -> str:
value: CustomFieldItemId | list[CustomFieldItemId] = custom_field.value
if field_def.type in {'Single select','Multiple select'}:
if field_def.type in {'Single select', 'Multiple select'}:
items = [field_def.get_field_item(item_id) for item_id in value]
items = [i for i in items if i]
return items[0].name
@ -36,14 +43,18 @@ def to_custom_field_value(custom_field: CustomField, field_def: CustomFieldInfo)
return custom_field.color
assert False, 'Unknown type: ' + field_def.type
def to_custom_fields(card: Card, favro_client: FavroClient) -> dict[str,str]:
def to_custom_fields(card: Card, favro_client: FavroClient) -> dict[str, str]:
custom_fields = {}
for field_assignment in card.custom_fields:
field_def = favro_client.get_custom_field(field_assignment.custom_field_id)
custom_fields[field_def.name] = to_custom_field_value(field_assignment, field_def)
custom_fields[field_def.name] = to_custom_field_value(
field_assignment, field_def,
)
del field_assignment
return custom_fields
def to_card_contents(card: Card, favro_client: FavroClient) -> str:
tags = [favro_client.get_tag(tag_id).name for tag_id in card.tags]
assignments = [
@ -78,6 +89,7 @@ def to_card_contents(card: Card, favro_client: FavroClient) -> str:
################################################################################
# FUSE
class FavroStat(fuse.Stat):
def __init__(self):
self.st_mode = 0
@ -99,11 +111,11 @@ class FileSystemItem:
@dataclasses.dataclass(frozen=True)
class RootFileSystemItem(FileSystemItem):
@staticmethod
def from_path_segment(segment: str) -> 'RootFileSystemItem':
return RootFileSystemItem()
@dataclasses.dataclass(frozen=True)
class OrganizationFileSystemItem(FileSystemItem):
name: str
@ -124,7 +136,9 @@ class CardFileSystemItem(FileSystemItem):
return None
def path_to_file_system_item(path_str: str, path_components: list[type[FileSystemItem]]) -> FileSystemItem | None:
def path_to_file_system_item(
path_str: str, path_components: list[type[FileSystemItem]],
) -> FileSystemItem | None:
path = re.findall(r'[^/]+', path_str)
component = path_components[len(path)]
return component.from_path_segment(path[-1] if path else None)
@ -142,7 +156,7 @@ class FavroFuse(fuse.Fuse):
self.favro_client = favro_client
self.formatter = formatter
self.wiped_cards = set()
#self.path_components = [RootFileSystemItem, OrganizationFileSystemItem, CardFileSystemItem]
# self.path_components = [RootFileSystemItem, OrganizationFileSystemItem, CardFileSystemItem]
self.path_components = [RootFileSystemItem, CardFileSystemItem]
super().__init__(**kwargs)

4
favro_sync/favro_markdown.py
View File

@ -35,7 +35,7 @@ class CardContents:
is_archived: bool
start_date: datetime.date | None
due_date: datetime.date | None
custom_fields: dict[str,str]
custom_fields: dict[str, str]
def format_obsidian_link(text: str) -> str:
@ -173,5 +173,5 @@ class CardFileFormatter:
is_archived=is_archived,
start_date=start_date,
due_date=due_date,
custom_fields={}, # TODO
custom_fields={}, # TODO
)

4
test/test_client.py
View File

@ -1,6 +1,6 @@
import pytest
import requests_cache
from favro_sync import secrets
from favro_sync.favro_client import FavroClient, OrganizationId, SeqId
@ -50,6 +50,7 @@ def test_get_cards():
for card in client.get_cards(todo_list=True):
assert_valid_card(card)
@needs_secrets
def test_get_collections():
client = create_client()
@ -62,6 +63,7 @@ def test_get_collections():
assert collection.is_archived is not None
assert collection.widget_common_id is None
def create_client():
session = requests_cache.CachedSession('output/test-http-cache.sqlite')
return FavroClient(