Update Makefile (#302)

# Issue or Problem Addressed

For a new Developer who is starting with the development, list of
commands to learn in `make` can be exhausting.

# Description

- This PR simplifies the setup of a new developer environment by listing
all the targets that `Makefile`.
- Adding a new target with inline help ensures that the developer can
document this without requiring to add in a separate `help` section of
Makefile.
- This PR runs formatting and spell check fixes and corrects some
scripts.

# Type of change

Please delete options that are not relevant.

- [X] Bug fix (non-breaking change which fixes an issue)
- [X] New feature (non-breaking change which adds functionality)

# How Has This Been Tested?

This as tested on my Laptop. 

## List of Tests Added

N/A

## Test Procedure

- [ ] `make` now lists all help targets

<img width="1518" alt="Screenshot 2024-12-10 at 2 58 52 PM"
src="https://github.com/user-attachments/assets/ad6cf3b7-8a79-43e9-af35-e598e45671c9">


## Test Configuration

- Python Version: `3.12.4`
- OS/Distribution: `Darwin 23.6.0 Darwin Kernel Version 23.6.0`

# Review Checklist:

- [X] My code follows the style guidelines of this project
- [X] I have performed a self-review of my own code
- [X] I have commented my code, particularly in hard-to-understand areas
- [X] I have no changes that break existing user workflows. If so, I am
providing a deprecation path
- [X] I have added tests that prove my fix is effective or that my
feature works
- [X] New and existing unit tests pass locally with my changes

Co-authored-by: Piyush Jain <[email protected]>

.gitignore

@@ -1,6 +1,7 @@
 .vs/
 .vscode/
 .idea/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -59,6 +60,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+.mypy_cache_test/
 
 # Translations
 *.mo

libs/aws/Makefile

@@ -1,16 +1,38 @@
+######################
+# NON FILE TARGETS
+######################
 .PHONY: all format lint test tests integration_tests docker_tests help extended_tests
 
-# Default target executed when no arguments are given to make.
-all: help
+######################
+# ALL TARGETS
+######################
+
+all: help ## Default target = help
+
+######################
+# TEST CASES
+######################
 
 # Define a variable for the test file path.
-TEST_FILE ?= tests/unit_tests/
+test test_watch tests: TEST_FILE ?= tests/unit_tests/
 integration_test integration_tests: TEST_FILE = tests/integration_tests/
 
-test tests integration_test integration_tests:
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+
+tests: ## Run all unit tests
+	poetry run pytest $(TEST_FILE)
+
+test:  ## Run individual unit test: make test TEST_FILE=tests/unit_test/test.py
 	poetry run pytest $(TEST_FILE)
 
-test_watch:
+integration_tests: ## Run all integration tests
+	poetry run pytest $(TEST_FILE)
+
+integration_test: ## Run individual integration test: make integration_test TEST_FILE=tests/integration_tests/integ_test.py
+	poetry run pytest $(TEST_FILE)
+
+test_watch: ## Run and interactively watch unit tests
 	poetry run ptw --snapshot-update --now . -- -vv $(TEST_FILE)
 
 ######################
@@ -26,34 +48,44 @@ lint_package: PYTHON_FILES=langchain_aws
 lint_tests: PYTHON_FILES=tests
 lint_tests: MYPY_CACHE=.mypy_cache_test
 
-lint lint_diff lint_package lint_tests:
-	poetry run ruff .
+lint: ## Run linter
+	poetry run ruff check
+
+lint_diff: ## Run linter
 	poetry run ruff format $(PYTHON_FILES) --diff
-	poetry run ruff --select I $(PYTHON_FILES)
+
+lint_package: ## Run linter on package
+	poetry run ruff check --select I $(PYTHON_FILES)
+
+lint_tests: ## Run linter tests
 	mkdir -p $(MYPY_CACHE); poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
 
-format format_diff:
+format: ## Run code formatter
 	poetry run ruff format $(PYTHON_FILES)
-	poetry run ruff --select I --fix $(PYTHON_FILES)
 
-spell_check:
+format_diff: ## Run code formatter and show differences
+	poetry run ruff check --select I --fix $(PYTHON_FILES)
+
+spell_check: ## Run code spell check
 	poetry run codespell --toml pyproject.toml
 
-spell_fix:
+spell_fix: ## Run code spell fix
 	poetry run codespell --toml pyproject.toml -w
 
-check_imports: $(shell find langchain_aws -name '*.py')
-	poetry run python ./scripts/check_imports.py $^
+######################
+# DEPENDENCIES
+######################
+
+install_dev: ## Install development environment
+	@pip install --no-cache -U poetry
+	@poetry install --with dev,test,codespell,lint,typing
+
+check_imports: $(shell find langchain_aws -name '*.py') ## Check missing imports
+	@poetry run python ./scripts/check_imports.py $^
 
 ######################
 # HELP
 ######################
 
-help:
-	@echo '----'
-	@echo 'check_imports				- check imports'
-	@echo 'format                       - run code formatters'
-	@echo 'lint                         - run linters'
-	@echo 'test                         - run unit tests'
-	@echo 'tests                        - run unit tests'
-	@echo 'test TEST_FILE=<test_file>   - run all tests in file'
+help: ## Print this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

libs/aws/README.md

@@ -89,4 +89,4 @@ There are three different search methods we can use to do retrieval. By default,
 
 ```python
 retriever=vds.as_retriever()
-```
+```

libs/aws/pyproject.toml

@@ -32,10 +32,12 @@ pytest-watcher = "^0.3.4"
 langchain-tests = "0.3.1"
 langchain = "^0.3.7"
 
-
 [tool.poetry.group.codespell]
 optional = true
 
+[tool.codespell]
+ignore-words-list = "HSA, notIn"
+
 [tool.poetry.group.codespell.dependencies]
 codespell = "^2.2.6"
 

libs/aws/scripts/check_imports.py

@@ -5,11 +5,12 @@
 if __name__ == "__main__":
     files = sys.argv[1:]
     has_failure = False
+
     for file in files:
         try:
             SourceFileLoader("x", file).load_module()
         except Exception:
-            has_faillure = True
+            has_failure = True
             print(file)  # noqa: T201
             traceback.print_exc()
             print()  # noqa: T201

libs/aws/tests/callbacks.py

@@ -23,7 +23,7 @@ class BaseFakeCallbackHandler(BaseModel):
     ignore_retriever_: bool = False
     ignore_chat_model_: bool = False
 
-    # to allow for similar callback handlers that are not technicall equal
+    # to allow for similar callback handlers that are not technically equal
     fake_id: Union[str, None] = None
 
     # add finer-grained counters for easier debugging of failing tests

libs/aws/tests/unit_tests/retrievers/test_bedrock.py

@@ -59,7 +59,7 @@ def test_retriever_invoke(amazon_retriever, mock_client):
         retrievalConfiguration={
             "vectorSearchConfiguration": {
                 "numberOfResults": 5,
-                # Expecting to be called with correct "in" operatior instead of "in_"
+                # Expecting to be called with correct "in" operator instead of "in_"
                 "filter": {"in": {"key": "key", "value": ["value1", "value2"]}},
             }
         },