Skip to content

feat(pylint): Add httpx as a blocked networking import #8870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
l0lawrence merged 2 commits into from
Aug 26, 2024
Merged

feat(pylint): Add httpx as a blocked networking import #8870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce41dd9
feat: Add httpx as a blocked networking import
kdestin Aug 20, 2024
e2fa32e
chore: Update CHANGELOG.md
kdestin Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions tools/pylint-extensions/azure-pylint-guidelines-checker/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Release History

## 0.5.0 (unreleased)

- Feature: Add `httpx` as an import flagged by C4749(networking-import-outside-azure-core-transport)

## 0.4.1 (2024-04-17)

- Bug fix for typing under TYPE_CHECKING block.
Expand Down
2 changes: 1 addition & 1 deletion tools/pylint-extensions/azure-pylint-guidelines-checker/pylint_guidelines_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2376,7 +2376,7 @@ class NonCoreNetworkImport(BaseChecker):
"This import is only allowed in azure.core.pipeline.transport.",
),
}
BLOCKED_MODULES = ["aiohttp", "requests", "trio"]
BLOCKED_MODULES = ["aiohttp", "requests", "trio", "httpx"]
AZURE_CORE_TRANSPORT_NAME = "azure.core.pipeline.transport"

def visit_import(self, node):
Expand Down
19 changes: 16 additions & 3 deletions tools/pylint-extensions/azure-pylint-guidelines-checker/tests/test_pylint_custom_plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4052,18 +4052,31 @@ class TestCheckNonCoreNetworkImport(pylint.testutils.CheckerTestCase):
def test_disallowed_imports(self):
"""Check that illegal imports raise warnings"""
# Blocked import ouside of core.
import_node = astroid.extract_node("import requests")
requests_import_node = astroid.extract_node("import requests")
with self.assertAddsMessages(
pylint.testutils.MessageTest(
msg_id="networking-import-outside-azure-core-transport",
line=1,
node=import_node,
node=requests_import_node,
col_offset=0,
end_line=1,
end_col_offset=15,
)
):
self.checker.visit_import(import_node)
self.checker.visit_import(requests_import_node)

httpx_import_node = astroid.extract_node("import httpx")
with self.assertAddsMessages(
pylint.testutils.MessageTest(
msg_id="networking-import-outside-azure-core-transport",
line=1,
node=httpx_import_node,
col_offset=0,
end_line=1,
end_col_offset=12,
)
):
self.checker.visit_import(httpx_import_node)

# blocked import from outside of core.
importfrom_node = astroid.extract_node("from aiohttp import get")
Expand Down