76d991c447
Auto Update PR / update-prs (push) Has been cancelled
CI / format-check (push) Has been cancelled
CI / test (3.10) (push) Has been cancelled
CI / test (3.11) (push) Has been cancelled
CI / test (3.12) (push) Has been cancelled
CI / live-api-tests (push) Has been cancelled
CI / plugin-integration-test (push) Has been cancelled
CI / ollama-integration-test (push) Has been cancelled
CI / test-fork-pr (push) Has been cancelled
128 lines
3.4 KiB
Bash
Executable File
128 lines
3.4 KiB
Bash
Executable File
#!/bin/bash
|
|
# Copyright 2025 Google LLC
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# Autoformat LangExtract codebase
|
|
#
|
|
# Usage: ./autoformat.sh [target_directory ...]
|
|
# If no target is specified, formats the current directory
|
|
#
|
|
# This script runs:
|
|
# 1. isort for import sorting
|
|
# 2. pyink (Google's Black fork) for code formatting
|
|
# 3. pre-commit hooks for additional formatting (trailing whitespace, end-of-file, etc.)
|
|
|
|
set -e
|
|
|
|
echo "LangExtract Auto-formatter"
|
|
echo "=========================="
|
|
echo
|
|
|
|
# Check for required tools
|
|
check_tool() {
|
|
if ! command -v "$1" &> /dev/null; then
|
|
echo "Error: $1 not found."
|
|
echo "Install the repo's pinned formatter versions with:"
|
|
echo " pip install -e \".[dev]\""
|
|
exit 1
|
|
fi
|
|
}
|
|
|
|
check_tool "isort"
|
|
check_tool "pyink"
|
|
check_tool "pre-commit"
|
|
|
|
# Parse command line arguments
|
|
show_usage() {
|
|
echo "Usage: $0 [target_directory ...]"
|
|
echo
|
|
echo "Formats Python code using isort and pyink according to Google style."
|
|
echo
|
|
echo "Arguments:"
|
|
echo " target_directory One or more directories to format (default: langextract tests)"
|
|
echo
|
|
echo "Examples:"
|
|
echo " $0 # Format langextract and tests directories"
|
|
echo " $0 langextract # Format only langextract directory"
|
|
echo " $0 src tests # Format multiple specific directories"
|
|
}
|
|
|
|
# Check for help flag
|
|
if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
|
|
show_usage
|
|
exit 0
|
|
fi
|
|
|
|
# Determine target directories
|
|
if [ $# -eq 0 ]; then
|
|
TARGETS="langextract tests"
|
|
echo "No target specified. Formatting default directories: langextract tests"
|
|
else
|
|
TARGETS="$@"
|
|
echo "Formatting targets: $TARGETS"
|
|
fi
|
|
|
|
# Find pyproject.toml relative to script location
|
|
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
|
CONFIG_FILE="${SCRIPT_DIR}/pyproject.toml"
|
|
|
|
if [ ! -f "$CONFIG_FILE" ]; then
|
|
echo "Warning: pyproject.toml not found at ${CONFIG_FILE}"
|
|
echo "Using default configuration."
|
|
CONFIG_ARG=""
|
|
else
|
|
CONFIG_ARG="--config $CONFIG_FILE"
|
|
fi
|
|
|
|
echo
|
|
|
|
# Run isort
|
|
echo "Running isort to organize imports..."
|
|
if isort $TARGETS; then
|
|
echo "Import sorting complete"
|
|
else
|
|
echo "Import sorting failed"
|
|
exit 1
|
|
fi
|
|
|
|
echo
|
|
|
|
# Run pyink
|
|
echo "Running pyink to format code (Google style, 80 chars)..."
|
|
if pyink $TARGETS $CONFIG_ARG; then
|
|
echo "Code formatting complete"
|
|
else
|
|
echo "Code formatting failed"
|
|
exit 1
|
|
fi
|
|
|
|
echo
|
|
|
|
# Run pre-commit hooks for additional formatting
|
|
echo "Running pre-commit hooks for additional formatting..."
|
|
if pre-commit run --all-files; then
|
|
echo "Pre-commit hooks passed"
|
|
else
|
|
echo "Pre-commit hooks made changes - please review"
|
|
# Exit with success since formatting was applied
|
|
exit 0
|
|
fi
|
|
|
|
echo
|
|
echo "All formatting complete!"
|
|
echo
|
|
echo "Next steps:"
|
|
echo " - Run: pylint --rcfile=${SCRIPT_DIR}/.pylintrc $TARGETS"
|
|
echo " - Commit your changes"
|