Editor displays gymlib correctly (#63)

**Summary**: The editor is now able to find the gymlib library and
display the types correctly.

**Demo**:
Works in dbgym.
<img width="455" alt="Screenshot 2024-12-25 at 19 36 46"
src="https://github.com/user-attachments/assets/22efa678-7267-4d62-858a-c24a2bd382a0"
/>

Works in hello-tune agent.
<img width="450" alt="Screenshot 2024-12-25 at 19 36 50"
src="https://github.com/user-attachments/assets/87ebe1aa-6293-4f0c-abcc-a8bafba07062"
/>


**Details**:
* In the previous PR we got the system running but the editor didn't
display it correctly.
* This works in both dbgym and agent.

.github/workflows/tests.yaml

@@ -31,7 +31,7 @@ jobs:
     - name: Install dependencies
       run: |
         pip install -r ./scripts/configs/requirements.txt
-        pip install -e ./gymlib
+        pip install ./gymlib_package
         ./scripts/install_sysdeps.sh
 
     - name: Check formatting

.gitignore

@@ -2,6 +2,7 @@ __pycache__/
 .mypy_cache/
 .conda/
 .idea/
+build/
 test_clean_scratchspace/
 workspace/
 default_*_benchbase_config_*.xml

gymlib/pyproject.toml → gymlib_package/pyproject.toml

@@ -5,8 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "gymlib"
 version = "0.1.0"
-requires-python = ">=3.8"
-dependencies = []
 
-[tool.setuptools]
-py-modules = ["gymlib"]
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["gymlib*"]

lab.py

@@ -0,0 +1,3 @@
+import gymlib
+
+print(gymlib.magic.get_magic_number())

scripts/_build_conda_env.sh

@@ -40,7 +40,7 @@ fi
 if [ -f "$python_version_path" ]; then
     python_version=$(cat "$python_version_path")
 else
-    echo "Warning: .python_version not found in $python_version_path. Using default Python 3.10."
+    echo "Info: .python_version not found in $python_version_path. Using default Python 3.10."
     python_version="3.10"
 fi
 
@@ -56,15 +56,16 @@ if [ -f "$requirements_path" ]; then
     echo "Installing pip requirements from $requirements_path..."
     pip install -r "$requirements_path"
 else
-    echo "Warning: $requirements_path not found. Skipping pip install."
+    echo "Info: $requirements_path not found. Skipping pip install."
 fi
 
 # We always install gymlib so that the agent has access to it.
-if [ -d "gymlib" ]; then
-    echo "Installing gymlib in editable mode..."
-    pip install -e ./gymlib
+if [ -d "gymlib_package" ]; then
+    echo "Installing gymlib..."
+    # Note that I don't use -e here. When I tried -e, the editor wouldn't be able to find gymlib.
+    pip install ./gymlib_package
 else
-    echo "Error: gymlib directory not found in $(pwd). Please ensure you're running this script from the right folder."
+    echo "Error: gymlib_package directory not found in $(pwd). Please ensure you're running this script from the right folder."
     exit 1
 fi
 

scripts/mypy.sh

@@ -1,3 +1,4 @@
 #!/bin/bash
 # Ignore agents/ because those are all submodules.
-mypy --config-file scripts/configs/mypy.ini . --exclude agents/
+# Ignore gymlib_package/build/ to avoid the error of mypy finding two gymlib packages.
+mypy --config-file scripts/configs/mypy.ini . --exclude agents/ --exclude gymlib_package/build/