__package__ = 'archivebox.plugantic' from typing import Optional, List, Literal from pathlib import Path from pydantic import BaseModel, Field, ConfigDict, computed_field from .base_hook import BaseHook, HookType ConfigSectionName = Literal[ 'GENERAL_CONFIG', 'ARCHIVE_METHOD_TOGGLES', 'ARCHIVE_METHOD_OPTIONS', 'DEPENDENCY_CONFIG', ] ConfigSectionNames: List[ConfigSectionName] = [ 'GENERAL_CONFIG', 'ARCHIVE_METHOD_TOGGLES', 'ARCHIVE_METHOD_OPTIONS', 'DEPENDENCY_CONFIG', ] class BaseConfigSet(BaseHook): model_config = ConfigDict(arbitrary_types_allowed=True, extra='allow', populate_by_name=True) hook_type: HookType = 'CONFIG' section: ConfigSectionName = 'GENERAL_CONFIG' def register(self, settings, parent_plugin=None): """Installs the ConfigSet into Django settings.CONFIGS (and settings.HOOKS).""" if settings is None: from django.conf import settings as django_settings settings = django_settings self._plugin = parent_plugin # for debugging only, never rely on this! # install hook into settings.CONFIGS settings.CONFIGS[self.name] = self # record installed hook in settings.HOOKS super().register(settings, parent_plugin=parent_plugin) # class WgetToggleConfig(ConfigSet): # section: ConfigSectionName = 'ARCHIVE_METHOD_TOGGLES' # SAVE_WGET: bool = True # SAVE_WARC: bool = True # class WgetDependencyConfig(ConfigSet): # section: ConfigSectionName = 'DEPENDENCY_CONFIG' # WGET_BINARY: str = Field(default='wget') # WGET_ARGS: Optional[List[str]] = Field(default=None) # WGET_EXTRA_ARGS: List[str] = [] # WGET_DEFAULT_ARGS: List[str] = ['--timeout={TIMEOUT-10}'] # class WgetOptionsConfig(ConfigSet): # section: ConfigSectionName = 'ARCHIVE_METHOD_OPTIONS' # # loaded from shared config # WGET_AUTO_COMPRESSION: bool = Field(default=True) # SAVE_WGET_REQUISITES: bool = Field(default=True) # WGET_USER_AGENT: str = Field(default='', alias='USER_AGENT') # WGET_TIMEOUT: int = Field(default=60, alias='TIMEOUT') # WGET_CHECK_SSL_VALIDITY: bool = Field(default=True, alias='CHECK_SSL_VALIDITY') # WGET_RESTRICT_FILE_NAMES: str = Field(default='windows', alias='RESTRICT_FILE_NAMES') # WGET_COOKIES_FILE: Optional[Path] = Field(default=None, alias='COOKIES_FILE') # CONFIG = { # 'CHECK_SSL_VALIDITY': False, # 'SAVE_WARC': False, # 'TIMEOUT': 999, # } # WGET_CONFIG = [ # WgetToggleConfig(**CONFIG), # WgetDependencyConfig(**CONFIG), # WgetOptionsConfig(**CONFIG), # ]