Document areas of code complexity

Author: cclauss

isort/api.py

@@ -66,7 +66,7 @@ class ImportKey(Enum):
     ALIAS = 4
 
 
-def sort_code_string(
+def sort_code_string(  # noqa: PLR0913
     code: str,
     extension: Optional[str] = None,
     config: Config = DEFAULT_CONFIG,
@@ -85,6 +85,12 @@ def sort_code_string(
     - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a
     TextIO stream is provided results will be written to it, otherwise no diff will be computed.
     - ****config_kwargs**: Any config modifications.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * There are currently 6 function argurments vs 5 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
     """
     input_stream = StringIO(code)
     output_stream = StringIO()
@@ -102,7 +108,7 @@ def sort_code_string(
     return output_stream.read()
 
 
-def check_code_string(
+def check_code_string(  # noqa: PLR0913
     code: str,
     show_diff: Union[bool, TextIO] = False,
     extension: Optional[str] = None,
@@ -122,6 +128,12 @@ def check_code_string(
     - **file_path**: The disk location where the code string was pulled from.
     - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file.
     - ****config_kwargs**: Any config modifications.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * There are currently 6 function argurments vs 5 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
     """
     config = _config(path=file_path, config=config, **config_kwargs)
     return check_stream(
@@ -134,7 +146,7 @@ def check_code_string(
     )
 
 
-def sort_stream(
+def sort_stream(  # noqa: C901,PLR0913,PLR0912
     input_stream: TextIO,
     output_stream: TextIO,
     extension: Optional[str] = None,
@@ -157,6 +169,14 @@ def sort_stream(
     - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a
     TextIO stream is provided results will be written to it, otherwise no diff will be computed.
     - ****config_kwargs**: Any config modifications.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * The McCabe cyclomatic complexity is currently 14 vs 10 recommended.
+    * There are currently 8 function argurments vs 5 recommended.
+    * There are currently 13 branches vs 12 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
     """
     extension = extension or (file_path and file_path.suffix.lstrip(".")) or "py"
     if show_diff:
@@ -235,7 +255,7 @@ def sort_stream(
     return changed
 
 
-def check_stream(
+def check_stream(  # noqa: PLR0913
     input_stream: TextIO,
     show_diff: Union[bool, TextIO] = False,
     extension: Optional[str] = None,
@@ -255,6 +275,12 @@ def check_stream(
     - **file_path**: The disk location where the code string was pulled from.
     - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file.
     - ****config_kwargs**: Any config modifications.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * There are currently 6 function argurments vs 5 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
     """
     config = _config(path=file_path, config=config, **config_kwargs)
 
@@ -302,7 +328,7 @@ def check_stream(
     return False
 
 
-def check_file(
+def check_file(  # noqa: PLR0913
     filename: Union[str, Path],
     show_diff: Union[bool, TextIO] = False,
     config: Config = DEFAULT_CONFIG,
@@ -322,6 +348,12 @@ def check_file(
     - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file.
     - **extension**: The file extension that contains imports. Defaults to filename extension or py.
     - ****config_kwargs**: Any config modifications.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * There are currently 6 function argurments vs 5 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
     """
     file_config: Config = config
 
@@ -366,7 +398,7 @@ def _file_output_stream_context(filename: Union[str, Path], source_file: File) -
 # Ignore DeepSource cyclomatic complexity check for this function. It is one
 # the main entrypoints so sort of expected to be complex.
 # skipcq: PY-R1000
-def sort_file(
+def sort_file(  # noqa: C901,PLR0913,PLR0912,PLR0915
     filename: Union[str, Path],
     extension: Optional[str] = None,
     config: Config = DEFAULT_CONFIG,
@@ -393,6 +425,15 @@ def sort_file(
     - **output**: If a TextIO is provided, results will be written there rather than replacing
     the original file content.
     - ****config_kwargs**: Any config modifications.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * The McCabe cyclomatic complexity is currently 18 vs 10 recommended.
+    * There are currently 9 function argurments vs 5 recommended.
+    * There are currently 21 branches vs 12 recommended.
+    * There are currently 59 statements vs 50 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
     """
     file_config: Config = config
 

isort/settings.py

@@ -291,13 +291,21 @@ def __hash__(self) -> int:
 
 
 class Config(_Config):
-    def __init__(
+    def __init__(  # noqa: C901,PLR0912,PLR0915
         self,
         settings_file: str = "",
         settings_path: str = "",
         config: Optional[_Config] = None,
         **config_overrides: Any,
     ):
+        """Future modifications should consider refactoring to reduce complexity.
+
+        * The McCabe cyclomatic complexity is currently 15 vs 10 recommended.
+        * There are currently 7 return statements vs 6 recommended.
+        * There are currently 16 branches vs 12 recommended.
+
+        To revalidate these numbers, run `ruff check --select=C901,PLR091`.
+        """
         self._known_patterns: Optional[List[Tuple[Pattern[str], str]]] = None
         self._section_comments: Optional[Tuple[str, ...]] = None
         self._section_comments_end: Optional[Tuple[str, ...]] = None
@@ -586,8 +594,17 @@ def _check_folder_git_ls_files(self, folder: str) -> Optional[Path]:
         }
         return git_folder
 
-    def is_skipped(self, file_path: Path) -> bool:
-        """Returns True if the file and/or folder should be skipped based on current settings."""
+    def is_skipped(self, file_path: Path) -> bool:  # noqa: C901,PLR0911,PLR0912
+        """Returns True if the file and/or folder should be skipped based on current settings.
+
+        Future modifications should consider refactoring to reduce complexity.
+
+        * The McCabe cyclomatic complexity is currently 15 vs 10 recommended.
+        * There are currently 7 return statements vs 6 recommended.
+        * There are currently 16 branches vs 12 recommended.
+
+        To revalidate these numbers, run `ruff check --select=C901,PLR091`.
+        """
         if self.directory and Path(self.directory) in file_path.resolve().parents:
             file_name = os.path.relpath(file_path.resolve(), self.directory)
         else:
@@ -824,7 +841,17 @@ def find_all_configs(path: str) -> Trie:
     return trie_root
 
 
-def _get_config_data(file_path: str, sections: Tuple[str, ...]) -> Dict[str, Any]:
+def _get_config_data(  # noqa: C901,PLR0912,PLR0915
+    file_path: str, sections: Tuple[str, ...]
+) -> Dict[str, Any]:
+    """Future modifications should consider refactoring to reduce complexity.
+
+    * The McCabe cyclomatic complexity is currently 27 vs 10 recommended.
+    * There are currently 28 branches vs 12 recommended.
+    * There are currently 62 statements vs 50 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
+    """
     settings: Dict[str, Any] = {}
 
     if file_path.endswith(".toml"):

isort/wrap.py

@@ -7,7 +7,7 @@
 from .wrap_modes import formatter_from_string, vertical_hanging_indent
 
 
-def import_statement(
+def import_statement(  # noqa: PLR0913
     import_start: str,
     from_imports: List[str],
     comments: Sequence[str] = (),
@@ -16,7 +16,14 @@ def import_statement(
     multi_line_output: Optional[Modes] = None,
     explode: bool = False,
 ) -> str:
-    """Returns a multi-line wrapped form of the provided from import statement."""
+    """Returns a multi-line wrapped form of the provided from import statement.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * There are currently 7 function argurments vs 5 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
+    """
     if explode:
         formatter = vertical_hanging_indent
         line_length = 1
@@ -68,8 +75,18 @@ def import_statement(
     return statement
 
 
-def line(content: str, line_separator: str, config: Config = DEFAULT_CONFIG) -> str:
-    """Returns a line wrapped to the specified line-length, if possible."""
+def line(
+    content: str, line_separator: str, config: Config = DEFAULT_CONFIG
+) -> str:  # noqa: C901,PLR0912
+    """Returns a line wrapped to the specified line-length, if possible.
+
+    Future modifications should consider refactoring to reduce complexity.
+
+    * The McCabe cyclomatic complexity is currently 14 vs 10 recommended.
+    * There are currently 15 branches vs 12 recommended.
+
+    To revalidate these numbers, run `ruff check --select=C901,PLR091`.
+    """
     wrap_mode = config.multi_line_output
     if len(content) > config.line_length and wrap_mode != Modes.NOQA:  # type: ignore
         line_without_comment = content

pyproject.toml

@@ -182,8 +182,7 @@ lint.select = [
     "FLY",
     "PERF",
     "PIE",
-    "PLC",
-    "PLE",
+    "PL",
     "RUF",
     "S",
     "UP",
@@ -193,15 +192,19 @@ lint.ignore = [
     "B017",
     "B028",
     "B904",
+    "C901",    # REMOVE ME!!
     "E203",
     "E501",
     "PERF203",
+    "PLR5501",
+    "PLR091",  # REMOVE ME!!
+    "PLW",
     "RUF100",
     "UP006",
     "UP035",
 ]
-lint.exclude = [ "isort/_vendored/*" ]
-lint.mccabe.max-complexity = 91  # Default is 10
+lint.exclude = [ "isort/_vendored/*", "isort/deprecated/*" ]
+lint.pylint.allow-magic-value-types = [ "bytes", "int", "str" ]
 
 [tool.ruff.lint.per-file-ignores]
 "isort/deprecated/finders.py" = [ "UP034" ]
@@ -211,7 +214,8 @@ lint.mccabe.max-complexity = 91  # Default is 10
 "isort/setuptools_commands.py" = [ "RUF012" ]
 "tests/*" = [ "RUF001", "S" ]
 "tests/unit/example_crlf_file.py" = [ "F401" ]
-"tests/unit/test_wrap_modes.py" = [ "PIE804" ]
+"tests/unit/test_main.py" = [ "PLR0915" ]
+"tests/unit/test_wrap_modes.py" = [ "PIE804", "PLR0913" ]
 
 [tool.isort]
 profile = "hug"