Docs cleanup

Author: kopekC

flask_to_fastapi_migration/guide.md

@@ -1,42 +1,61 @@
+import codegen
 from codegen import Codebase
-codebase = Codebase.from_repo("getmoto/moto", commit="786a8ada7ed0c7f9d8b04d49f24596865e4b7901")
-
-print("🚀 Starting FreezeGun to TimeMachine conversion...")
-
-for file in codebase.files:
-    if "tests" not in file.filepath:
-        continue
-    print(f"📝 Processing: {file.filepath}")
-    # Update imports
-    for imp in file.imports:
-        if imp.symbol_name and 'freezegun' in imp.source:
-            if imp.name == 'freeze_time':
-                # required due to Codegen limitations
-                imp.edit('from time_machine import travel')
-            else:
-                imp.set_import_module('time_machine')
-    # Find all function calls in the file
-    for fcall in file.function_calls:
-        # Skip if not a freeze_time call
-        if 'freeze_time' not in fcall.source:
+
+@codegen.function("freezegun-to-timemachine")
+def run(codebase: Codebase):
+    """Convert FreezeGun usage to TimeMachine in test files.
+
+    This script:
+    1. Identifies test files using FreezeGun.
+    2. Updates imports from FreezeGun to TimeMachine.
+    3. Modifies function calls to include necessary parameters.
+    """
+    print("🚀 Starting FreezeGun to TimeMachine conversion...")
+
+    for file in codebase.files:
+        if "tests" not in file.filepath:
             continue
-        # Get original source and prepare new source
-        new_source = fcall.source
-        # Add tick parameter if not present
-        if not fcall.get_arg_by_parameter_name('tick'):
-            if new_source.endswith(')'):
-                new_source = new_source[:-1]
-                if not new_source.endswith('('):
-                    new_source += ','
-                new_source += ' tick=False)'
-        # Replace freeze_time with travel
-        if '.' in new_source:
-            new_source = new_source.replace(
-                'freeze_time', 'travel').replace('freezegun', 'time_machine')
-        else:
-            new_source = 'travel' + new_source[len('freeze_time'):]
-        # Make single edit with complete changes
-        fcall.edit(new_source)
-codebase.commit()
-
-print("✅ FreezeGun to TimeMachine conversion completed successfully!")
+        print(f"📝 Processing: {file.filepath}")
+
+        # Update imports
+        for imp in file.imports:
+            if imp.symbol_name and 'freezegun' in imp.source:
+                if imp.name == 'freeze_time':
+                    # required due to Codegen limitations
+                    imp.edit('from time_machine import travel')
+                else:
+                    imp.set_import_module('time_machine')
+
+        # Find all function calls in the file
+        for fcall in file.function_calls:
+            # Skip if not a freeze_time call
+            if 'freeze_time' not in fcall.source:
+                continue
+
+            # Get original source and prepare new source
+            new_source = fcall.source
+
+            # Add tick parameter if not present
+            if not fcall.get_arg_by_parameter_name('tick'):
+                if new_source.endswith(')'):
+                    new_source = new_source[:-1]
+                    if not new_source.endswith('('):
+                        new_source += ','
+                    new_source += ' tick=False)'
+
+            # Replace freeze_time with travel
+            if '.' in new_source:
+                new_source = new_source.replace(
+                    'freeze_time', 'travel').replace('freezegun', 'time_machine')
+            else:
+                new_source = 'travel' + new_source[len('freeze_time'):]
+
+            # Make single edit with complete changes
+            fcall.edit(new_source)
+
+    codebase.commit()
+    print("✅ FreezeGun to TimeMachine conversion completed successfully!")
+
+if __name__ == "__main__":
+    codebase = Codebase.from_repo("getmoto/moto", commit="786a8ada7ed0c7f9d8b04d49f24596865e4b7901")
+    run(codebase)

freezegun_to_timemachine_migration/run.py

@@ -1,10 +1,11 @@
+import codegen
 from codegen import Codebase
 
 # Initialize codebase
 codebase = Codebase("./")
 
 # Define the target directory
-TARGET_DIR = "repo-before"
+TARGET_DIR = "input_repo"
 
 
 def convert_print_statements(file):
@@ -114,8 +115,8 @@ def update_iterators(file):
                         new_stmt = new_stmt.rstrip() + ")"
                     stmt.edit(new_stmt)
 
-
-def main():
+@codegen.function("python2-to-python3")
+def run():
     """Main function to run the Python 2 to 3 conversion"""
     print("🚀 Starting Python 2 to 3 conversion...\n")
 
@@ -149,4 +150,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    run(codebase)

python2_to_python3/run.py

@@ -1,12 +1,10 @@
-# unittest to pytest Migration Example
+# Unittest to Pytest Migration Example
 
-[![Documentation](https://img.shields.io/badge/docs-docs.codegen.com-blue)](https://docs.codegen.com/tutorials/unittest-to-pytest)
+This codemod demonstrates how to automatically migrate `unittest` test suites to `pytest` using Codegen. The migration script simplifies the process by handling all the tedious manual updates automatically.
 
-This example demonstrates how to use Codegen to automatically migrate unittest test suites to pytest. For a complete walkthrough, check out our [tutorial](https://docs.codegen.com/tutorials/unittest-to-pytest).
+## How the Migration Script Works
 
-## What This Example Does
-
-The migration script handles four key transformations:
+The script automates the entire migration process in a few key steps:
 
 1. **Convert Test Classes and Setup Methods**
    ```python
@@ -29,6 +27,8 @@ The migration script handles four key transformations:
        user = db.create_user("test")
        assert user.name == "test"
    ```
+   - Converts `unittest.TestCase` classes to standalone functions
+   - Replaces `setUp` methods with `pytest` fixtures
 
 2. **Update Assertions**
    ```python
@@ -45,6 +45,8 @@ The migration script handles four key transformations:
        with pytest.raises(ValueError):
            parse_id("invalid")
    ```
+   - Replaces `unittest` assertions with `pytest` assertions
+   - Uses `pytest.raises` for exception testing
 
 3. **Convert Test Discovery**
    ```python
@@ -55,6 +57,8 @@ The migration script handles four key transformations:
    # To:
    # Remove unittest.main() and rename files to test_*.py
    ```
+   - Removes `unittest.main()` calls
+   - Ensures files are named for `pytest` discovery
 
 4. **Modernize Fixtures**
    ```python
@@ -68,8 +72,9 @@ The migration script handles four key transformations:
    def conn():
        return create_db()
    ```
+   - Converts class-level setup to session-scoped fixtures
 
-## Running the Example
+## Running the Migration
 
 ```bash
 # Install Codegen
@@ -84,12 +89,16 @@ The script will process all Python test files in the `repo-before` directory and
 ## Understanding the Code
 
 - `run.py` - The migration script
-- `repo-before/` - Sample unittest test suite to migrate
+- `repo-before/` - Sample `unittest` test suite to migrate
 - `guide.md` - Additional notes and explanations
 
 ## Learn More
 
 - [Full Tutorial](https://docs.codegen.com/tutorials/unittest-to-pytest)
 - [pytest Documentation](https://docs.pytest.org/)
 - [unittest Documentation](https://docs.python.org/3/library/unittest.html)
-- [Codegen Documentation](https://docs.codegen.com) 
+- [Codegen Documentation](https://docs.codegen.com)
+
+## Contributing
+
+Feel free to submit issues and enhancement requests!