No inline imports in Python
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
Install this rule for wispbit
Add this rule to wispbit and it will run when you open a pull request
Install this rule for Coderabbit
Copy the configuration below and add it to your repository as .coderabbit.yml
in your project root.
reviews:
path_instructions:
- path: "*.py"
instructions: |
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Install this rule for Greptile
Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
File Path Patterns:
Install this rule for GitHub Copilot
Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
File Path Patterns:
Install this rule for Graphite Diamond
Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
File Path Patterns:
Use with Cline
Copy the rule below and ask Cline to review your code using this rule
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Use with OpenAI Codex
Copy the rule below and ask OpenAI Codex to review your code using this rule
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Use with Cursor
Copy the rule below and ask Cursor to review your code using this rule
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Use with Claude Code
Copy the rule below and ask Claude Code to review your code using this rule
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Install this rule for Windsurf
To set up rules for Windsurf Reviews, please see this documentation
Place all import statements at the top of the file.
Bad:
```python
def process_data(data: Dict) -> List:
import os # Inline import
import json # Inline import
from mymodule import MyClass # Inline import
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```
Good:
```python
import os
import json
from typing import Dict, List
from mymodule import MyClass
def process_data(data: Dict) -> List:
# Use imported modules here
file_path = os.path.join("data", "output.json")
with open(file_path, "w") as f:
json.dump(data, f)
processor = MyClass()
return processor.transform(data)
```