dbx-patch 0.1.0__tar.gz

dbx_patch-0.1.0/.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+_build/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# ruff
+.ruff_cache/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# default folders for storing artifacts excluded, but present for structure
+/data/
+/logs/
+/models/
+
+# Databricks
+/databricks/

dbx_patch-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 twsl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dbx_patch-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: dbx-patch
+Version: 0.1.0
+Summary: Patchception: A library to patch the Databricks patching of Python
+Project-URL: homepage, https://twsl.github.io/dbx-patch/
+Project-URL: repository, https://github.com/twsl/dbx-patch
+Project-URL: documentation, https://twsl.github.io/dbx-patch/
+Author-email: twsl <45483159+twsl@users.noreply.github.com>
+License: MIT
+License-File: LICENSE
+Keywords: dbx-patch
+Requires-Python: >=3.12
+Provides-Extra: extra
+Description-Content-Type: text/markdown
+
+# dbx-patch
+
+[![Build](https://github.com/twsl/dbx-patch/actions/workflows/build.yaml/badge.svg)](https://github.com/twsl/dbx-patch/actions/workflows/build.yaml)
+[![Documentation](https://github.com/twsl/dbx-patch/actions/workflows/docs.yaml/badge.svg)](https://github.com/twsl/dbx-patch/actions/workflows/docs.yaml)
+[![Docs with MkDocs](https://img.shields.io/badge/MkDocs-docs?style=flat&logo=materialformkdocs&logoColor=white&color=%23526CFE)](https://squidfunk.github.io/mkdocs-material/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![linting: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/twsl/dbx-patch/releases)
+[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-border.json)](https://github.com/copier-org/copier)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
+Patchception: A library to patch the Databricks patching of Python to enable editable package installs.
+
+## Features
+
+- ✅ Enables editable Python package installs (`pip install -e .`) in Databricks notebooks
+- ✅ Patches Databricks' custom import system to allow workspace directory imports
+- ✅ Automatic patch application via `sitecustomize.py` (recommended)
+- ✅ Manual patching via `patch_dbx()` for immediate use
+- ✅ Debug mode with `DBX_PATCH_DEBUG` environment variable for troubleshooting
+
+## Installation
+
+With `pip`:
+
+```bash
+python -m pip install dbx-patch
+```
+
+With [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv add dbx-patch
+```
+
+## Quick Start
+
+### 🚀 Recommended: One-Command Setup
+
+The simplest way to get started - patches current session AND installs automatic patching:
+
+```python
+from dbx_patch import patch_and_install
+patch_and_install()
+# Patches applied + sitecustomize.py installed
+# Python will restart automatically in Databricks!
+```
+
+### ⚡ Manual Patching (Current Session Only)
+
+If you only want to patch the current Python session without persistence:
+
+```python
+from dbx_patch import patch_dbx
+patch_dbx()
+# Editable installs now work in this session!
+```
+
+### 🔧 Automatic Patching (Persistent)
+
+For permanent solution that works across all Python restarts:
+
+```python
+# Run ONCE per cluster (e.g., in init script or setup notebook)
+from dbx_patch import install_sitecustomize
+install_sitecustomize()
+# Python will restart automatically in Databricks!
+# After restart, patches are applied automatically on every Python startup
+```
+
+- `sys_path_init.py` runs **during Python interpreter initialization**
+- Your notebook code runs **after initialization completes**
+- By the time you call `patch_dbx()`, the import system is already configured
+- Editable install paths have already been removed from `sys.path`
+- Import hooks are already installed and active
+
+#### The Solution: sitecustomize.py
+
+Python **automatically** imports `sitecustomize.py` during interpreter initialization, **before** any Databricks code runs:
+
+1. **Python interpreter starts**
+2. **`sitecustomize.py` runs** → ✅ Patches are applied **early**
+3. **Databricks code tries to run** → ✅ Already patched!
+4. **Your notebook code runs** → ✅ Editable installs work!
+
+```python
+# ✅ This WORKS - patches applied at startup
+from dbx_patch import install_sitecustomize
+install_sitecustomize()  # Installs sitecustomize.py + auto-restarts Python
+```
+
+**Implementation details:**
+
+- `sitecustomize.py` patches `sys_path_init` **before** it runs
+- Import hooks are modified **before** they're installed
+- Editable install paths are preserved in `sys.path`
+- All patches are applied silently during startup
+
+For detailed technical explanation, see [Technical Implementation](docs/docs/files/implementation.md#the-timing-problem)
+
+## Docs
+
+```bash
+uv run mkdocs build -f ./mkdocs.yml -d ./_build/
+```
+
+## Update template
+
+```bash
+copier update --trust -A --vcs-ref=HEAD
+```
+
+## Credits
+
+This project was generated with [![🚀 python project template.](https://img.shields.io/badge/python--project--template-%F0%9F%9A%80-brightgreen)](https://github.com/twsl/python-project-template)

dbx_patch-0.1.0/README.md

@@ -0,0 +1,118 @@
+# dbx-patch
+
+[![Build](https://github.com/twsl/dbx-patch/actions/workflows/build.yaml/badge.svg)](https://github.com/twsl/dbx-patch/actions/workflows/build.yaml)
+[![Documentation](https://github.com/twsl/dbx-patch/actions/workflows/docs.yaml/badge.svg)](https://github.com/twsl/dbx-patch/actions/workflows/docs.yaml)
+[![Docs with MkDocs](https://img.shields.io/badge/MkDocs-docs?style=flat&logo=materialformkdocs&logoColor=white&color=%23526CFE)](https://squidfunk.github.io/mkdocs-material/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![linting: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
+[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/twsl/dbx-patch/releases)
+[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-border.json)](https://github.com/copier-org/copier)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
+Patchception: A library to patch the Databricks patching of Python to enable editable package installs.
+
+## Features
+
+- ✅ Enables editable Python package installs (`pip install -e .`) in Databricks notebooks
+- ✅ Patches Databricks' custom import system to allow workspace directory imports
+- ✅ Automatic patch application via `sitecustomize.py` (recommended)
+- ✅ Manual patching via `patch_dbx()` for immediate use
+- ✅ Debug mode with `DBX_PATCH_DEBUG` environment variable for troubleshooting
+
+## Installation
+
+With `pip`:
+
+```bash
+python -m pip install dbx-patch
+```
+
+With [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv add dbx-patch
+```
+
+## Quick Start
+
+### 🚀 Recommended: One-Command Setup
+
+The simplest way to get started - patches current session AND installs automatic patching:
+
+```python
+from dbx_patch import patch_and_install
+patch_and_install()
+# Patches applied + sitecustomize.py installed
+# Python will restart automatically in Databricks!
+```
+
+### ⚡ Manual Patching (Current Session Only)
+
+If you only want to patch the current Python session without persistence:
+
+```python
+from dbx_patch import patch_dbx
+patch_dbx()
+# Editable installs now work in this session!
+```
+
+### 🔧 Automatic Patching (Persistent)
+
+For permanent solution that works across all Python restarts:
+
+```python
+# Run ONCE per cluster (e.g., in init script or setup notebook)
+from dbx_patch import install_sitecustomize
+install_sitecustomize()
+# Python will restart automatically in Databricks!
+# After restart, patches are applied automatically on every Python startup
+```
+
+- `sys_path_init.py` runs **during Python interpreter initialization**
+- Your notebook code runs **after initialization completes**
+- By the time you call `patch_dbx()`, the import system is already configured
+- Editable install paths have already been removed from `sys.path`
+- Import hooks are already installed and active
+
+#### The Solution: sitecustomize.py
+
+Python **automatically** imports `sitecustomize.py` during interpreter initialization, **before** any Databricks code runs:
+
+1. **Python interpreter starts**
+2. **`sitecustomize.py` runs** → ✅ Patches are applied **early**
+3. **Databricks code tries to run** → ✅ Already patched!
+4. **Your notebook code runs** → ✅ Editable installs work!
+
+```python
+# ✅ This WORKS - patches applied at startup
+from dbx_patch import install_sitecustomize
+install_sitecustomize()  # Installs sitecustomize.py + auto-restarts Python
+```
+
+**Implementation details:**
+
+- `sitecustomize.py` patches `sys_path_init` **before** it runs
+- Import hooks are modified **before** they're installed
+- Editable install paths are preserved in `sys.path`
+- All patches are applied silently during startup
+
+For detailed technical explanation, see [Technical Implementation](docs/docs/files/implementation.md#the-timing-problem)
+
+## Docs
+
+```bash
+uv run mkdocs build -f ./mkdocs.yml -d ./_build/
+```
+
+## Update template
+
+```bash
+copier update --trust -A --vcs-ref=HEAD
+```
+
+## Credits
+
+This project was generated with [![🚀 python project template.](https://img.shields.io/badge/python--project--template-%F0%9F%9A%80-brightgreen)](https://github.com/twsl/python-project-template)