khoj/src/utils/config.py

# System Packages
from enum import Enum
from dataclasses import dataclass


class SearchType(str, Enum):
    Notes = "notes"
    Ledger = "ledger"
    Music = "music"
    Image = "image"


@dataclass
class SearchSettings():
    notes_search_enabled: bool = False
    ledger_search_enabled: bool = False
    music_search_enabled: bool = False
    image_search_enabled: bool = False
Wrap search type enablement status in a search settings class - Cleaner, more idiomatic usage of a global variable - Simplifies mocking when testing client in pytest as setting wrapped in object rather than a simple type. So passed around by reference 2021-09-30 04:18:33 +02:00			`# System Packages`
Only allow supported search types to /search, /regenerate APIs - Use a SearchType to limit types that can be passed by user - FastAPI automatically validates type passed in query param - Available type options show up in Swagger UI, FastAPI docs - controller code looks neater instead of doing string comparisons for type - Test invalid, valid search types via pytest 2021-09-30 04:02:55 +02:00			`from enum import Enum`
Wrap search type enablement status in a search settings class - Cleaner, more idiomatic usage of a global variable - Simplifies mocking when testing client in pytest as setting wrapped in object rather than a simple type. So passed around by reference 2021-09-30 04:18:33 +02:00			`from dataclasses import dataclass`
Only allow supported search types to /search, /regenerate APIs - Use a SearchType to limit types that can be passed by user - FastAPI automatically validates type passed in query param - Available type options show up in Swagger UI, FastAPI docs - controller code looks neater instead of doing string comparisons for type - Test invalid, valid search types via pytest 2021-09-30 04:02:55 +02:00

			`class SearchType(str, Enum):`
			`Notes = "notes"`
			`Ledger = "ledger"`
			`Music = "music"`
			`Image = "image"`

Wrap search type enablement status in a search settings class - Cleaner, more idiomatic usage of a global variable - Simplifies mocking when testing client in pytest as setting wrapped in object rather than a simple type. So passed around by reference 2021-09-30 04:18:33 +02:00
			`@dataclass`
			`class SearchSettings():`
			`notes_search_enabled: bool = False`
			`ledger_search_enabled: bool = False`
			`music_search_enabled: bool = False`
			`image_search_enabled: bool = False`