new vastly simplified plugin spec without pydantic

archivebox/plugins_pkg/pip/__init__.py

@@ -0,0 +1,51 @@
+__package__ = 'plugins_pkg.pip'
+__label__ = 'pip'
+__version__ = '2024.10.14'
+__author__ = 'Nick Sweeting'
+__homepage__ = 'https://github.com/pypa/pip'
+
+import abx
+
+
+@abx.hookimpl
+def get_PLUGIN():
+    return {
+        'pip': {
+            'PACKAGE': __package__,
+            'LABEL': __label__,
+            'VERSION': __version__,
+            'AUTHOR': __author__,
+            'HOMEPAGE': __homepage__,
+        }
+    }
+
+@abx.hookimpl
+def get_CONFIG():
+    from .config import PIP_CONFIG
+    
+    return {
+        'pip': PIP_CONFIG
+    }
+
+@abx.hookimpl
+def get_BINARIES():
+    from .binaries import ARCHIVEBOX_BINARY, PYTHON_BINARY, DJANGO_BINARY, SQLITE_BINARY, PIP_BINARY, PIPX_BINARY
+    
+    return {
+        'archivebox': ARCHIVEBOX_BINARY,
+        'python': PYTHON_BINARY,
+        'django': DJANGO_BINARY,
+        'sqlite': SQLITE_BINARY,
+        'pip': PIP_BINARY,
+        'pipx': PIPX_BINARY,
+    }
+
+@abx.hookimpl
+def get_BINPROVIDERS():
+    from .binproviders import SYS_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER, LIB_PIP_BINPROVIDER
+    
+    return {
+        'sys_pip': SYS_PIP_BINPROVIDER,
+        'venv_pip': VENV_PIP_BINPROVIDER,
+        'lib_pip': LIB_PIP_BINPROVIDER,
+    }

archivebox/plugins_pkg/pip/binaries.py

@@ -1,105 +1,27 @@
-__package__ = 'archivebox.plugins_pkg.pip'
+__package__ = 'plugins_pkg.pip'
 
-import os
 import sys
-import site
 from pathlib import Path
-from typing import List, Optional
-from pydantic import InstanceOf, Field, model_validator, validate_call
+from typing import List
+from pydantic import InstanceOf, Field, model_validator
 
 
 import django
 import django.db.backends.sqlite3.base
 from django.db.backends.sqlite3.base import Database as django_sqlite3     # type: ignore[import-type]
-from pydantic_pkgr import BinProvider, PipProvider, BinName, BinProviderName, BinaryOverrides, SemVer
+from pydantic_pkgr import BinProvider, BinName, BinaryOverrides, SemVer
 
-from archivebox.config import CONSTANTS, VERSION
+from archivebox import VERSION
 
-from abx.archivebox.base_plugin import BasePlugin
-from abx.archivebox.base_configset import BaseConfigSet
 from abx.archivebox.base_binary import BaseBinary, BaseBinProvider, env, apt, brew
-from abx.archivebox.base_hook import BaseHook
 
-from ...misc.logging import hint
+from archivebox.misc.logging import hint
 
+from .binproviders import LIB_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER, SYS_PIP_BINPROVIDER
 
 ###################### Config ##########################
 
 
-class PipDependencyConfigs(BaseConfigSet):
-    USE_PIP: bool = True
-    PIP_BINARY: str = Field(default='pip')
-    PIP_ARGS: Optional[List[str]] = Field(default=None)
-    PIP_EXTRA_ARGS: List[str] = []
-    PIP_DEFAULT_ARGS: List[str] = []
-    
-PIP_CONFIG = PipDependencyConfigs()
-
-
-class SystemPipBinProvider(PipProvider, BaseBinProvider):
-    name: BinProviderName = "sys_pip"
-    INSTALLER_BIN: BinName = "pip"
-    
-    pip_venv: Optional[Path] = None        # global pip scope
-    
-    def on_install(self, bin_name: str, **kwargs):
-        # never modify system pip packages
-        return 'refusing to install packages globally with system pip, use a venv instead'
-
-class SystemPipxBinProvider(PipProvider, BaseBinProvider):
-    name: BinProviderName = "pipx"
-    INSTALLER_BIN: BinName = "pipx"
-    
-    pip_venv: Optional[Path] = None        # global pipx scope
-
-
-IS_INSIDE_VENV = sys.prefix != sys.base_prefix
-
-class VenvPipBinProvider(PipProvider, BaseBinProvider):
-    name: BinProviderName = "venv_pip"
-    INSTALLER_BIN: BinName = "pip"
-
-    pip_venv: Optional[Path] = Path(sys.prefix if IS_INSIDE_VENV else os.environ.get("VIRTUAL_ENV", '/tmp/NotInsideAVenv/lib'))
-    
-    def setup(self):
-        """never attempt to create a venv here, this is just used to detect if we are inside an existing one"""
-        return None
-    
-
-class LibPipBinProvider(PipProvider, BaseBinProvider):
-    name: BinProviderName = "lib_pip"
-    INSTALLER_BIN: BinName = "pip"
-    
-    pip_venv: Optional[Path] = CONSTANTS.LIB_PIP_DIR / 'venv'
-
-SYS_PIP_BINPROVIDER = SystemPipBinProvider()
-PIPX_PIP_BINPROVIDER = SystemPipxBinProvider()
-VENV_PIP_BINPROVIDER = VenvPipBinProvider()
-LIB_PIP_BINPROVIDER = LibPipBinProvider()
-pip = LIB_PIP_BINPROVIDER
-
-# ensure python libraries are importable from these locations (if archivebox wasnt executed from one of these then they wont already be in sys.path)
-assert VENV_PIP_BINPROVIDER.pip_venv is not None
-assert LIB_PIP_BINPROVIDER.pip_venv is not None
-
-major, minor, patch = sys.version_info[:3]
-site_packages_dir = f'lib/python{major}.{minor}/site-packages'
-
-LIB_SITE_PACKAGES = (LIB_PIP_BINPROVIDER.pip_venv / site_packages_dir,)
-VENV_SITE_PACKAGES = (VENV_PIP_BINPROVIDER.pip_venv / site_packages_dir,)
-USER_SITE_PACKAGES = site.getusersitepackages()
-SYS_SITE_PACKAGES = site.getsitepackages()
-
-ALL_SITE_PACKAGES = (
-    *LIB_SITE_PACKAGES,
-    *VENV_SITE_PACKAGES,
-    *USER_SITE_PACKAGES,
-    *SYS_SITE_PACKAGES,
-)
-for site_packages_dir in ALL_SITE_PACKAGES:
-    if site_packages_dir not in sys.path:
-        sys.path.append(str(site_packages_dir))
-
 
 class ArchiveboxBinary(BaseBinary):
     name: BinName = 'archivebox'
@@ -237,27 +159,3 @@ class PipxBinary(BaseBinary):
     binproviders_supported: List[InstanceOf[BinProvider]] = [LIB_PIP_BINPROVIDER, VENV_PIP_BINPROVIDER, SYS_PIP_BINPROVIDER, apt, brew, env]
 
 PIPX_BINARY = PipxBinary()
-
-
-class PipPlugin(BasePlugin):
-    app_label: str = 'pip'
-    verbose_name: str = 'PIP'
-
-    hooks: List[InstanceOf[BaseHook]] = [
-        PIP_CONFIG,
-        SYS_PIP_BINPROVIDER,
-        PIPX_PIP_BINPROVIDER,
-        VENV_PIP_BINPROVIDER,
-        LIB_PIP_BINPROVIDER,
-        PIP_BINARY,
-        PIPX_BINARY,
-        ARCHIVEBOX_BINARY,
-        PYTHON_BINARY,
-        SQLITE_BINARY,
-        DJANGO_BINARY,
-    ]
-
-
-PLUGIN = PipPlugin()
-# PLUGIN.register(settings)
-DJANGO_APP = PLUGIN.AppConfig

archivebox/plugins_pkg/pip/binproviders.py

@@ -0,0 +1,80 @@
+__package__ = 'plugins_pkg.pip'
+
+import os
+import sys
+import site
+from pathlib import Path
+from typing import Optional
+
+from pydantic_pkgr import PipProvider, BinName, BinProviderName
+
+from archivebox.config import CONSTANTS
+
+from abx.archivebox.base_binary import BaseBinProvider
+
+
+###################### Config ##########################
+
+class SystemPipBinProvider(PipProvider, BaseBinProvider):
+    name: BinProviderName = "sys_pip"
+    INSTALLER_BIN: BinName = "pip"
+    
+    pip_venv: Optional[Path] = None        # global pip scope
+    
+    def on_install(self, bin_name: str, **kwargs):
+        # never modify system pip packages
+        return 'refusing to install packages globally with system pip, use a venv instead'
+
+class SystemPipxBinProvider(PipProvider, BaseBinProvider):
+    name: BinProviderName = "pipx"
+    INSTALLER_BIN: BinName = "pipx"
+    
+    pip_venv: Optional[Path] = None        # global pipx scope
+
+
+IS_INSIDE_VENV = sys.prefix != sys.base_prefix
+
+class VenvPipBinProvider(PipProvider, BaseBinProvider):
+    name: BinProviderName = "venv_pip"
+    INSTALLER_BIN: BinName = "pip"
+
+    pip_venv: Optional[Path] = Path(sys.prefix if IS_INSIDE_VENV else os.environ.get("VIRTUAL_ENV", '/tmp/NotInsideAVenv/lib'))
+    
+    def setup(self):
+        """never attempt to create a venv here, this is just used to detect if we are inside an existing one"""
+        return None
+    
+
+class LibPipBinProvider(PipProvider, BaseBinProvider):
+    name: BinProviderName = "lib_pip"
+    INSTALLER_BIN: BinName = "pip"
+    
+    pip_venv: Optional[Path] = CONSTANTS.LIB_PIP_DIR / 'venv'
+
+SYS_PIP_BINPROVIDER = SystemPipBinProvider()
+PIPX_PIP_BINPROVIDER = SystemPipxBinProvider()
+VENV_PIP_BINPROVIDER = VenvPipBinProvider()
+LIB_PIP_BINPROVIDER = LibPipBinProvider()
+pip = LIB_PIP_BINPROVIDER
+
+# ensure python libraries are importable from these locations (if archivebox wasnt executed from one of these then they wont already be in sys.path)
+assert VENV_PIP_BINPROVIDER.pip_venv is not None
+assert LIB_PIP_BINPROVIDER.pip_venv is not None
+
+major, minor, patch = sys.version_info[:3]
+site_packages_dir = f'lib/python{major}.{minor}/site-packages'
+
+LIB_SITE_PACKAGES = (LIB_PIP_BINPROVIDER.pip_venv / site_packages_dir,)
+VENV_SITE_PACKAGES = (VENV_PIP_BINPROVIDER.pip_venv / site_packages_dir,)
+USER_SITE_PACKAGES = site.getusersitepackages()
+SYS_SITE_PACKAGES = site.getsitepackages()
+
+ALL_SITE_PACKAGES = (
+    *LIB_SITE_PACKAGES,
+    *VENV_SITE_PACKAGES,
+    *USER_SITE_PACKAGES,
+    *SYS_SITE_PACKAGES,
+)
+for site_packages_dir in ALL_SITE_PACKAGES:
+    if site_packages_dir not in sys.path:
+        sys.path.append(str(site_packages_dir))

archivebox/plugins_pkg/pip/config.py

@@ -0,0 +1,16 @@
+__package__ = 'pip'
+
+from typing import List, Optional
+from pydantic import Field
+
+from abx.archivebox.base_configset import BaseConfigSet
+
+
+class PipDependencyConfigs(BaseConfigSet):
+    USE_PIP: bool = True
+    PIP_BINARY: str = Field(default='pip')
+    PIP_ARGS: Optional[List[str]] = Field(default=None)
+    PIP_EXTRA_ARGS: List[str] = []
+    PIP_DEFAULT_ARGS: List[str] = []
+    
+PIP_CONFIG = PipDependencyConfigs()