chore: enable isort by czhao314 · Pull Request #28 · contextforge-org/contextforge-cli

czhao314 · 2026-03-13T19:06:29Z

Enable isort for Import Sorting

Summary

Enables isort in pre-commit hooks and applies consistent import sorting across the codebase using the black-compatible profile.

Changes

.pre-commit-config.yaml: Enabled isort hook (v6.0.1) with --profile=black
pyproject.toml: Added "I" to Ruff lint rules, removed TODO comment
Code files: Applied isort formatting to organize imports into standard sections (stdlib → third-party → first-party → local)

Impact

30+ files reformatted with consistent import ordering
No functional changes, formatting only
Pre-commit hook enforces import sorting going forward
All tests pass

Resolves TODO in pyproject.toml line 175.

Address #24

updated import order, applied isort to adjust the formatting of the import packages for py files

to test if files pass

gabe-l-hart

Thanks for submitting this! This has been a gross corner for a while. I think we need to look carefully at the profile we're using for isort (some of the changes look wrong to me). Additionally, I'm concerned about possible conflicts between ruff and isort which can cause pre-commit to become inoperable (the issue I ran into that caused me to disable this originally).

gabe-l-hart · 2026-03-13T19:08:55Z

cforge/commands/server/run.py

    # Third Party
+    # First-Party


Suggested change

# Third Party

# First-Party

# First-Party

We still need to remove the duplicate # Third Party heading

gabe-l-hart · 2026-03-13T19:10:04Z

cforge/config.py

 # Standard
 from contextlib import contextmanager
 from functools import lru_cache
+import os


This looks wrong. isort should keep from ... imports separate from import ... imports.

**ignore my previous comment, I see what you mean, import os is in the middle of the from imports; for some reason this does pass the isort --check-only command - will take a look

Typically, I've used imports like the following:

from baz import bat from foo import bar # ^ alpha sort for all `from ...` imports import asdf import qwer # ^ alpha sort for all `import ...` imports

(but without the editorial comments in between)

gotcha- i found the issue:
there was one style param force_sort_within_sections = true (sort the imports by module, independent of import style) which was overriding from_first= true which does the sorting you mentioned

I got rid of that, then added force_alphabetical_sort_within_sections = true to sort each by alphabetical order

gabe-l-hart · 2026-03-13T19:10:56Z

tests/commands/resources/test_a2a.py

 import json
-import tempfile
 from pathlib import Path
+import tempfile


Same here, I think the isort settings must be a bit off from what I'm used to

gabe-l-hart · 2026-03-13T19:11:21Z

cforge/profile_utils.py

+from pydantic import BaseModel, Field, field_validator, ValidationInfo

-# Local
+# First-Party


I think we want cforge to be Local, not First-Party

checked and cforge was set as a known first party in the isort config in the toml, I'll adjust it to known local package!

Yeesh, this is what I get for copying all this config from the upstream project rather than starting from scratch!

gabe-l-hart · 2026-03-13T19:15:01Z

pyproject.toml

-# TODO: Enable "I" for import sorting as a separate PR.
-select = ["E3", "E4", "E7", "E9", "F", "D1"]
+# Also "D1" for docstring present checks and "I" for import sorting.
+select = ["E3", "E4", "E7", "E9", "F", "D1", "I"]


I'm not clear whether it's this change or the one above to enable the pre-commit hook that actually caused all the changes. I'm also concerned that ruff's I might differ from isort w/ --profile=black.

Here's an example of the isort config that I'd like to use for this project: https://github.com/caikit/caikit/blob/main/.isort.cfg. I think there's a way to add this config directly in pyproject.toml without an independent .isort.cfg file which would be the preferred method.

it was the change to enable the isort pre-commit hook that caused these changes. i do see ruff's I is causing some sort of issue in the pre-hook.. just tried it again and it fails the black python reformatter and the isort formatting; I'll re-disable it
I think earlier either I might have run the prehook and the "I" didn't save properly so I didn't see any problems, which is completely my bad

updated configs for isort and re-disabled the toml.

Co-authored-by: Gabe Goodhart <ghart@us.ibm.com>

gabe-l-hart

Two more small style change requests:

Figure out how to remove the extra newline between the from and import lines within a given section
If possible, use case-sensitive alphabetical sorting within sections

There are also a number of local imports in unit tests that show up because the headers for them are changing. This should all get removed, but that can happen in a different PR.

gabe-l-hart · 2026-03-17T18:49:07Z

cforge/commands/resources/a2a.py

 from pathlib import Path
 from typing import Optional

+import json


There shouldn't be a newline before this. It looks like this change (a newline between the from and import sections) is true in all the files, so probably still some subtle setting to fix.

removed lines_between_types = 1 in the config!

gabe-l-hart · 2026-03-17T18:50:38Z

cforge/commands/server/run.py

    # Third Party
+    # First-Party


We still need to remove the duplicate # Third Party heading

gabe-l-hart · 2026-03-17T18:52:54Z

cforge/common/errors.py


 def handle_exception(exception: Exception) -> None:
    """Handle an exception and print a friendly error message."""
+    # Local


NOTE to self: Make sure this is a valid dynamic import to avoid a cycle

gabe-l-hart · 2026-03-17T18:54:53Z

cforge/credential_store.py

 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives import hashes
-from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from cryptography.hazmat.primitives.ciphers import algorithms, Cipher, modes


It looks like this is doing case-insensitive alphabetical sort. In other projects, I've used case-sensitive so all capitalized come first (ALL_CAPS -> CamelCaps -> lower). It's not a setting I have a strong preference about, but I think that's maybe more standard?

sounds good, changed it to case sensitive (set case_sensitive = true in config)

tests/commands/settings/test_logout.py

gabe-l-hart · 2026-03-17T18:58:57Z

pyproject.toml

 ###############################################################################
-known-first-party          = ["cforge", "mcpgateway"]    # treat "cforge" and "mcpgateway" as FIRSTPARTY
-known-local-folder         = ["tests", "scripts"]  # treat these folders as LOCALFOLDER
+known-first-party          = ["mcpgateway"]    # treat "cforge" and "mcpgateway" as FIRSTPARTY


Suggested change

known-first-party = ["mcpgateway"] # treat "cforge" and "mcpgateway" as FIRSTPARTY

known-first-party = ["mcpgateway"] # treat "mcpgateway" as FIRSTPARTY

removed line between from and import types changed sorting to case sensitive

just removed the style changes that are no longer applied from the toml file

gabe-l-hart

One. More. Time! It's all ready to approve, but we need to pull out that spurious PR_ISORT.md file since that should not be committed to the repo.

gabe-l-hart · 2026-03-20T14:36:40Z

PR_ISORT.md

This should be removed

Branch: isort-fix AI-usage: none Signed-off-by: Gabe Goodhart <ghart@us.ibm.com>

gabe-l-hart

Ship it!

czhao314 · 2026-03-20T14:54:07Z

woohoo! also i don't think I have write permissions haha so you'll have to merge it

Christina Zhao added 3 commits March 12, 2026 10:31

chore: fix isort

ec5f887

updated import order, applied isort to adjust the formatting of the import packages for py files

update: added isort back into pre-commit hook

16d1c1b

to test if files pass

removed todo

8f397f7

gabe-l-hart requested changes Mar 13, 2026

View reviewed changes

Christina Zhao and others added 2 commits March 13, 2026 14:37

chore: isort fix updates

aa63628

updated configs for isort and re-disabled the toml.

Update cforge/commands/server/run.py

71c6570

Co-authored-by: Gabe Goodhart <ghart@us.ibm.com>

czhao314 requested a review from gabe-l-hart March 17, 2026 17:25

gabe-l-hart requested changes Mar 17, 2026

View reviewed changes

Christina Zhao added 2 commits March 19, 2026 07:41

chore: update isort config

8c779be

removed line between from and import types changed sorting to case sensitive

removed vs commented out changes in config

c32c15a

just removed the style changes that are no longer applied from the toml file

czhao314 requested a review from gabe-l-hart March 19, 2026 14:45

gabe-l-hart requested changes Mar 20, 2026

View reviewed changes

PR_ISORT.md Outdated

Copy link

Collaborator

gabe-l-hart Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be removed

fix: Remove PR_ISORT.md

2ba4cec

Branch: isort-fix AI-usage: none Signed-off-by: Gabe Goodhart <ghart@us.ibm.com>

gabe-l-hart approved these changes Mar 20, 2026

View reviewed changes

gabe-l-hart merged commit 30b7497 into contextforge-org:main Mar 20, 2026
4 checks passed

	known-first-party = ["mcpgateway"] # treat "cforge" and "mcpgateway" as FIRSTPARTY
	known-first-party = ["mcpgateway"] # treat "mcpgateway" as FIRSTPARTY

Conversation

czhao314 commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Enable isort for Import Sorting

Summary

Changes

Impact

Uh oh!

gabe-l-hart left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

czhao314 Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

czhao314 Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

czhao314 Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gabe-l-hart left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gabe-l-hart left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gabe-l-hart left a comment

Choose a reason for hiding this comment

Uh oh!

czhao314 commented Mar 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

czhao314 commented Mar 13, 2026 •

edited

Loading

czhao314 Mar 13, 2026 •

edited

Loading

czhao314 Mar 13, 2026 •

edited

Loading

czhao314 Mar 13, 2026 •

edited

Loading