Add support for isort option --known-first-party (#10803)

* Add support for isort: known-first-party

Similar to known-third-party this recognizes modules as first party modules.

* Add feature doc fragment

Author: Flamefire

doc/user_guide/configuration/all-options.rst

@@ -1041,6 +1041,13 @@ Standard Checkers
 **Default:**  ``()``
 
 
+--known-first-party
+"""""""""""""""""""
+*Force import order to recognize a module as part of a first party library.*
+
+**Default:**  ``()``
+
+
 --known-third-party
 """""""""""""""""""
 *Force import order to recognize a module as part of a third party library.*
@@ -1082,6 +1089,8 @@ Standard Checkers
 
    known-standard-library = []
 
+   known-first-party = []
+
    known-third-party = ["enchant"]
 
    preferred-modules = []

doc/whatsnew/fragments/10803.feature

@@ -0,0 +1,3 @@
+Add support for `--known-first-party` similar to `--known-third-party`.
+
+Refs #10803

examples/pylintrc

@@ -398,6 +398,9 @@ int-import-graph=
 # compatibility libraries.
 known-standard-library=
 
+# Force import order to recognize a module as part of a first party library.
+known-first-party=
+
 # Force import order to recognize a module as part of a third party library.
 known-third-party=enchant
 

examples/pyproject.toml

@@ -350,6 +350,9 @@ max-module-lines = 1000
 # libraries.
 # known-standard-library =
 
+# Force import order to recognize a module as part of a third party library.
+# known-first-party =
+
 # Force import order to recognize a module as part of a third party library.
 known-third-party = [ "enchant" ]
 

pylint/checkers/imports.py

@@ -318,6 +318,7 @@ def _make_graph(
 
 
 DEFAULT_STANDARD_LIBRARY = ()
+DEFAULT_KNOWN_FIRST_PARTY = ()
 DEFAULT_KNOWN_THIRD_PARTY = ("enchant",)
 DEFAULT_PREFERRED_MODULES = ()
 
@@ -401,6 +402,16 @@ class ImportsChecker(DeprecatedMixin, BaseChecker):
                 "the standard compatibility libraries.",
             },
         ),
+        (
+            "known-first-party",
+            {
+                "default": DEFAULT_KNOWN_FIRST_PARTY,
+                "type": "csv",
+                "metavar": "<modules>",
+                "help": "Force import order to recognize a module as part of "
+                "a first party library.",
+            },
+        ),
         (
             "known-third-party",
             {
@@ -758,6 +769,7 @@ def _isort_config(self) -> isort.Config:
             # KNOWN_standard_library for ages in pylint, and we
             # don't want to break compatibility.
             extra_standard_library=self.linter.config.known_standard_library,
+            known_first_party=self.linter.config.known_first_party,
             known_third_party=self.linter.config.known_third_party,
         )
 

tests/functional/w/wrong_import_order2.py

@@ -6,12 +6,16 @@
 import os
 from sys import argv
 
-# external imports
+# external/third-party imports
 import isort
 import datetime  # std import that should be treated as third-party
 
+# First-party imports
 from six import moves
 
+import pylint
+import re  # std import that should be treated as first-party
+
 # local_imports
 from . import my_package
 from .my_package import myClass

tests/functional/w/wrong_import_order2.rc

@@ -1,2 +1,3 @@
 [IMPORTS]
+known-first-party=re
 known-third-party=datetime