dycw-pre-commit-hooks 0.10.12__py3-none-any.whl → 0.14.26__py3-none-any.whl

dycw_pre_commit_hooks-0.14.26.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.3
+Name: dycw-pre-commit-hooks
+Version: 0.14.26
+Summary: Pre-commit hooks
+Author: Derek Wan
+Author-email: Derek Wan <d.wan@icloud.com>
+Requires-Dist: click>=8.3.1
+Requires-Dist: dycw-utilities>=0.184.4
+Requires-Dist: libcst>=1.8.6
+Requires-Dist: orjson>=3.11.5
+Requires-Dist: packaging>=25.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: tomlkit>=0.14.0
+Requires-Dist: xdg-base-dirs>=6.0.2
+Requires-Dist: click==8.3.1 ; extra == 'cli'
+Requires-Dist: dycw-utilities==0.184.4 ; extra == 'cli'
+Requires-Dist: libcst==1.8.6 ; extra == 'cli'
+Requires-Dist: orjson==3.11.5 ; extra == 'cli'
+Requires-Dist: packaging==25.0 ; extra == 'cli'
+Requires-Dist: pyyaml==6.0.3 ; extra == 'cli'
+Requires-Dist: tomlkit==0.14.0 ; extra == 'cli'
+Requires-Dist: xdg-base-dirs==6.0.2 ; extra == 'cli'
+Requires-Python: >=3.12
+Provides-Extra: cli
+Description-Content-Type: text/markdown
+
+# pre-commit-hooks
+
+## Overview
+
+My [`pre-commit`](https://pre-commit.com/) hooks.
+
+## Installation
+
+1. Install `pre-commit`.
+
+1. Add the following to your `.pre-commit-config.yaml`:
+
+   ```yaml
+   repos:
+     - repo: https://github.com/dycw/pre-commit-hooks
+       rev: master
+       hooks:
+         - id: check-submodules-updated
+         - id: check-version-bumped
+         - id: format-requirements
+         - id: mirror-files
+         - id: replace-sequence-str
+         - id: run-version-bump
+         - id: tag-commits
+   ```
+
+1. Update your `.pre-commit-config.yaml`:
+
+   ```bash
+   pre-commit autoupdate
+   ```

dycw_pre_commit_hooks-0.14.26.dist-info/RECORD

@@ -0,0 +1,23 @@
+pre_commit_hooks/__init__.py,sha256=wC4VQm-toN3GxegASlI_2t9iCebEI0dtkRlXIjALVfE,60
+pre_commit_hooks/configs/gitignore,sha256=pIcfamKg40Tg2aWiMyY4pxHkSGNITRFD-ByA2wWGHQI,5062
+pre_commit_hooks/constants.py,sha256=Qao_jiJhW9M10hfqlr0bMtPubdg3ksCGsDNXY7jxZC4,3553
+pre_commit_hooks/hooks/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+pre_commit_hooks/hooks/add_future_import_annotations.py,sha256=vUVaQIMrfPssrP0keiau-o8Jel2rpaXLi6pyT_d-QsU,1701
+pre_commit_hooks/hooks/add_hooks.py,sha256=7Ow5pN-XGMUe3h3kWtVkXqFcZgdw_wHvUffV7ZNvmus,10457
+pre_commit_hooks/hooks/check_versions_consistent.py,sha256=vg7fsrJ4-_dVzyKCgw4KI_QSC2eam7vFjjYbmtM8RjM,996
+pre_commit_hooks/hooks/format_pre_commit_config.py,sha256=Vml8Mq5gFunOigs6l3FkTTMBaImYxtKfIehdMuYMO2E,1984
+pre_commit_hooks/hooks/format_requirements.py,sha256=R_FnEUx7jU3W5rWshLBKO2bX-cReHteF4iqm_mCnyCk,1474
+pre_commit_hooks/hooks/replace_sequence_str.py,sha256=G7JQ4n-hSjW5asM4C77ps8JYv5eV31rvFmmcxQYty1o,1816
+pre_commit_hooks/hooks/run_prek_autoupdate.py,sha256=SItY4GPTde7HXOaNy3zXsfFQFFZsc4hZzGzf380F0aI,1556
+pre_commit_hooks/hooks/run_version_bump.py,sha256=ZvRYfx0E_aFg0T95f5p2mL_8PdJZ7BQuLngKAqrZvaM,1469
+pre_commit_hooks/hooks/setup_git.py,sha256=nB87iKOuCPpc52RvLMRKzP-HZO53NluaX12k1JgxjfE,1193
+pre_commit_hooks/hooks/setup_pyright.py,sha256=DW9QdVE18aMzue8gLXxM4pnCIIooWm4DN-HDwM3A4RM,2565
+pre_commit_hooks/hooks/setup_ruff.py,sha256=GZlEtnc4mj4hAIjHxHQRoi9LQYDYCS4zPcZL8nWFKfg,4651
+pre_commit_hooks/hooks/update_requirements.py,sha256=2AypcOpCnZFhsBFHsHHYbUMBi9P-qtMWrrXlKWcM6B8,5303
+pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pre_commit_hooks/types.py,sha256=ObWi-OEEyZHlSYZA3iiJHGMDJ3jADntS_OpR0jXpkDk,515
+pre_commit_hooks/utilities.py,sha256=qwlFv4ffbTBBHrl_Uq7AQLfOM8J4yIvXS94Ix0_IqNQ,17842
+dycw_pre_commit_hooks-0.14.26.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+dycw_pre_commit_hooks-0.14.26.dist-info/entry_points.txt,sha256=QaLSZP2kUPAi9OWYnq9aPpKFcMW6q4lVgh12txUNKKA,839
+dycw_pre_commit_hooks-0.14.26.dist-info/METADATA,sha256=yqLok615QKWky2VZIhap9f1L4WFM4PBL7qNTeH9Hx6o,1501
+dycw_pre_commit_hooks-0.14.26.dist-info/RECORD,,

{dycw_pre_commit_hooks-0.10.12.dist-info → dycw_pre_commit_hooks-0.14.26.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: uv 0.9.26
 Root-Is-Purelib: true
 Tag: py3-none-any

dycw_pre_commit_hooks-0.14.26.dist-info/entry_points.txt

@@ -0,0 +1,14 @@
+[console_scripts]
+add-future-import-annotations = pre_commit_hooks.hooks.add_future_import_annotations:_main
+add-hooks = pre_commit_hooks.hooks.add_hooks:_main
+check-versions-consistent = pre_commit_hooks.hooks.check_versions_consistent:_main
+format-pre-commit-config = pre_commit_hooks.hooks.format_pre_commit_config:_main
+format-requirements = pre_commit_hooks.hooks.format_requirements:_main
+replace-sequence-str = pre_commit_hooks.hooks.replace_sequence_str:_main
+run-prek-autoupdate = pre_commit_hooks.hooks.run_prek_autoupdate:_main
+run-version-bump = pre_commit_hooks.hooks.run_version_bump:_main
+setup-git = pre_commit_hooks.hooks.setup_git:_main
+setup-pyright = pre_commit_hooks.hooks.setup_pyright:_main
+setup-ruff = pre_commit_hooks.hooks.setup_ruff:_main
+update-requirements = pre_commit_hooks.hooks.update_requirements:_main
+

pre_commit_hooks/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__version__ = "0.14.26"

pre_commit_hooks/configs/gitignore

@@ -0,0 +1,243 @@
+#### STANDARD GITIGNORE #######################################################
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# 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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+#### END OF STANDARD GITIGNORE ################################################
+
+#### CUSTOM GITIGNORE #########################################################
+
+**/*.csv
+**/*.db
+**/*.gz
+**/*.html
+**/*.ipc
+**/*.ipynb
+**/*.pdf
+**/*.pickle
+**/*.shelf
+**/*.sqlite
+**/*.tar.gz
+**/*.tar.lz
+**/*.tmp
+.direnv/
+.logs/
+htmls/
+ipcs/
+pdfs/
+pickles/
+shelves/
+tmp/
+
+#### END OF CUSTOM GITIGNORE ##################################################

pre_commit_hooks/constants.py

@@ -0,0 +1,149 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+import utilities.click
+from click import argument, option
+from utilities.constants import HOUR
+from xdg_base_dirs import xdg_cache_home
+
+BUILTIN = "builtin"
+DOCKERFMT_URL = "https://github.com/reteps/dockerfmt"
+DYCW_PRE_COMMIT_HOOKS_URL = "https://github.com/dycw/pre-commit-hooks"
+RUFF_URL = "https://github.com/astral-sh/ruff-pre-commit"
+SHELLCHECK_URL = "https://github.com/koalaman/shellcheck-precommit"
+SHFMT_URL = "https://github.com/scop/pre-commit-shfmt"
+STD_PRE_COMMIT_HOOKS_URL = "https://github.com/pre-commit/pre-commit-hooks"
+TAPLO_URL = "https://github.com/compwa/taplo-pre-commit"
+UV_URL = "https://github.com/astral-sh/uv-pre-commit"
+
+
+BUMPVERSION_TOML = Path(".bumpversion.toml")
+COVERAGERC_TOML = Path(".coveragerc.toml")
+ENVRC = Path(".envrc")
+GITEA = Path(".gitea")
+GITHUB = Path(".github")
+GITIGNORE = Path(".gitignore")
+PRE_COMMIT_CONFIG_YAML = Path(".pre-commit-config.yaml")
+PYPROJECT_TOML = Path("pyproject.toml")
+PYRIGHTCONFIG_JSON = Path("pyrightconfig.json")
+PYTEST_TOML = Path("pytest.toml")
+README_MD = Path("README.md")
+SSH = Path.home() / ".ssh"
+RUFF_TOML = Path("ruff.toml")
+
+
+DEFAULT_PYTHON_VERSION = "3.12"
+MAX_PYTHON_VERSION = "3.14"
+
+
+FORMATTER_PRIORITY = 10
+LINTER_PRIORITY = 20
+
+
+GITHUB_WORKFLOWS, GITEA_WORKFLOWS = [g / "workflows" for g in [GITHUB, GITEA]]
+GITHUB_PULL_REQUEST_YAML, GITEA_PULL_REQUEST_YAML = [
+    w / "pull-request.yaml" for w in [GITHUB_WORKFLOWS, GITEA_WORKFLOWS]
+]
+GITHUB_PUSH_YAML, GITEA_PUSH_YAML = [
+    w / "push.yaml" for w in [GITHUB_WORKFLOWS, GITEA_WORKFLOWS]
+]
+
+
+PATH_CACHE = xdg_cache_home() / "pre-commit-hooks"
+
+
+PRE_COMMIT_CONFIG_REPO_KEYS = ["repo", "rev", "hooks"]
+PRE_COMMIT_CONFIG_HOOK_KEYS = [
+    "id",
+    "alias",
+    "name",
+    "language_version",
+    "files",
+    "exclude",
+    "types",
+    "types_or",
+    "exclude_types",
+    "args",
+    "stages",
+    "additional_dependencies",
+    "always_run",
+    "verbose",
+    "log_file",
+    "priority",  # prek
+]
+PRE_COMMIT_HOOKS_HOOK_KEYS = [
+    "id",
+    "name",
+    "entry",
+    "language",
+    "files",
+    "exclude",
+    "types",
+    "types_or",
+    "exclude_types",
+    "always_run",
+    "fail_fast",
+    "verbose",
+    "pass_filenames",
+    "require_serial",
+    "description",
+    "language_version",
+    "minimum_pre_commit_version",
+    "args",
+    "stages",
+    "priority",  # prek
+]
+
+
+THROTTLE_DURATION = 12 * HOUR
+
+
+paths_argument = argument("paths", nargs=-1, type=utilities.click.Path())
+python_version_option = option(
+    "--python-version", type=str, default=DEFAULT_PYTHON_VERSION
+)
+throttle_option = option("--throttle", is_flag=True, default=True)
+
+
+__all__ = [
+    "BUILTIN",
+    "BUMPVERSION_TOML",
+    "COVERAGERC_TOML",
+    "DEFAULT_PYTHON_VERSION",
+    "DOCKERFMT_URL",
+    "DYCW_PRE_COMMIT_HOOKS_URL",
+    "ENVRC",
+    "FORMATTER_PRIORITY",
+    "GITEA",
+    "GITEA_PUSH_YAML",
+    "GITEA_WORKFLOWS",
+    "GITHUB",
+    "GITHUB_PULL_REQUEST_YAML",
+    "GITHUB_PUSH_YAML",
+    "GITHUB_WORKFLOWS",
+    "GITHUB_WORKFLOWS",
+    "GITIGNORE",
+    "LINTER_PRIORITY",
+    "MAX_PYTHON_VERSION",
+    "PATH_CACHE",
+    "PRE_COMMIT_CONFIG_HOOK_KEYS",
+    "PRE_COMMIT_CONFIG_REPO_KEYS",
+    "PRE_COMMIT_CONFIG_YAML",
+    "PYPROJECT_TOML",
+    "PYRIGHTCONFIG_JSON",
+    "PYTEST_TOML",
+    "README_MD",
+    "RUFF_TOML",
+    "RUFF_URL",
+    "SHELLCHECK_URL",
+    "SHFMT_URL",
+    "SSH",
+    "STD_PRE_COMMIT_HOOKS_URL",
+    "TAPLO_URL",
+    "THROTTLE_DURATION",
+    "UV_URL",
+    "paths_argument",
+    "python_version_option",
+    "throttle_option",
+]

pre_commit_hooks/hooks/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

pre_commit_hooks/hooks/add_future_import_annotations.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click import command
+from libcst import parse_statement
+from utilities.click import CONTEXT_SETTINGS
+from utilities.os import is_pytest
+from utilities.throttle import throttle
+
+from pre_commit_hooks.constants import (
+    THROTTLE_DURATION,
+    paths_argument,
+    throttle_option,
+)
+from pre_commit_hooks.utilities import (
+    path_throttle_cache,
+    run_all_maybe_raise,
+    yield_python_file,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import MutableSet
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+@throttle_option
+def _main(*, paths: tuple[Path, ...], throttle: bool = True) -> None:
+    if is_pytest():
+        return
+    run_all_maybe_raise(*(partial(_run, p, throttle=throttle) for p in paths))
+
+
+def _run(path: PathLike, /, *, throttle: bool = True) -> bool:
+    modifications: set[Path] = set()
+    func = _run_throttled if throttle else _run_unthrottled
+    func(path, modifications=modifications)
+    return len(modifications) == 0
+
+
+def _run_unthrottled(
+    path: PathLike, /, *, modifications: MutableSet[Path] | None = None
+) -> None:
+    with yield_python_file(path, modifications=modifications) as context:
+        if len(context.input.body) == 0:
+            body = [parse_statement("from __future__ import annotations")]
+            context.output = context.input.with_changes(body=body)
+
+
+_run_throttled = throttle(
+    duration=THROTTLE_DURATION,
+    path=path_throttle_cache("add-future-import-annotations"),
+)(_run_unthrottled)
+
+
+if __name__ == "__main__":
+    _main()