Skip to content

Update invalid-envvar-default to flag os.environ.get #10507

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Update invalid-envvar-default to flag os.environ.get #10507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c359cf4
add invalid-envvar-default check for os.environ.get; add its function…
Aearsears Aug 17, 2025
8c156bc
update documentation examples of invalid-envvar-default
Aearsears Aug 19, 2025
95cea8f
update error message to be os.environ.get and not builtins.dict
Aearsears Aug 19, 2025
5f36561
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 19, 2025
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
1 change: 1 addition & 0 deletions doc/data/messages/i/invalid-envvar-default/bad.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import os

env = os.getenv("SECRET_KEY", 1) # [invalid-envvar-default]
env = os.environ.get("SECRET_KEY", 1) # [invalid-envvar-default]
1 change: 1 addition & 0 deletions doc/data/messages/i/invalid-envvar-default/good.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import os

env = os.getenv("SECRET_KEY", "1")
env = os.environ.get("SECRET_KEY", "1")
1 change: 1 addition & 0 deletions doc/data/messages/i/invalid-envvar-value/bad.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import os

os.getenv(1) # [invalid-envvar-value]
os.environ.get(1) # [invalid-envvar-value]
1 change: 1 addition & 0 deletions doc/data/messages/i/invalid-envvar-value/good.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import os

os.getenv("1")
os.environ.get("1")
43 changes: 39 additions & 4 deletions pylint/checkers/stdlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,14 @@ def visit_call(self, node: nodes.Call) -> None:
self._check_for_check_kw_in_run(node)
elif name in DEBUG_BREAKPOINTS:
self.add_message("forgotten-debug-statement", node=node)
elif (
isinstance(inferred, astroid.BoundMethod)
and self.is_os_environ_get(node)
and utils.is_builtin_object(inferred)
):
# when os.environ.get() is inferred it creates a "builtins.dict" and "_collections_abc.Mapping"
self._check_env_function(node, inferred)

self.check_deprecated_method(node, inferred)

@utils.only_required_for_messages("boolean-datetime")
Expand Down Expand Up @@ -892,7 +900,9 @@ def _check_open_call(
"unspecified-encoding", node=node, confidence=confidence
)

def _check_env_function(self, node: nodes.Call, infer: nodes.FunctionDef) -> None:
def _check_env_function(
self, node: nodes.Call, infer: nodes.FunctionDef | astroid.BoundMethod
) -> None:
env_name_kwarg = "key"
env_value_kwarg = "default"
if node.keywords:
Expand Down Expand Up @@ -934,7 +944,7 @@ def _check_env_function(self, node: nodes.Call, infer: nodes.FunctionDef) -> Non
def _check_invalid_envvar_value(
self,
node: nodes.Call,
infer: nodes.FunctionDef,
infer: nodes.FunctionDef | astroid.BoundMethod,
message: str,
call_arg: InferenceResult | None,
allow_none: bool,
Expand All @@ -950,9 +960,34 @@ def _check_invalid_envvar_value(
elif not isinstance(call_arg.value, str):
emit = True
if emit:
self.add_message(message, node=node, args=(name, call_arg.pytype()))
self.add_message(
message,
node=node,
args=(
"os.environ.get" if self.is_os_environ_get(node) else name,
call_arg.pytype(),
),
)
else:
self.add_message(message, node=node, args=(name, call_arg.pytype()))
self.add_message(
message,
node=node,
args=(
"os.environ.get" if self.is_os_environ_get(node) else name,
call_arg.pytype(),
),
)

def is_os_environ_get(self, node: nodes.Call) -> bool:
try:
return (
isinstance(node.func, nodes.Attribute)
and node.func.attrname == "get"
and node.func.expr.attrname == "environ"
and node.func.expr.expr.name == "os"
)
except AttributeError:
return False

def deprecated_methods(self) -> set[str]:
return self._deprecated_methods
Expand Down
60 changes: 60 additions & 0 deletions tests/functional/i/invalid/invalid_envvar_value.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# pylint: disable=useless-return,missing-docstring
import os
from os import getenv


Expand Down Expand Up @@ -82,3 +83,62 @@ def deep_function_returning_bytes():
getenv(key='TEST', default=function_returning_none())
getenv(key='TEST', default=function_returning_string())
getenv(key='TEST', default=function_returning_bytes()) # [invalid-envvar-default]

os.environ.get() # pylint: disable=no-value-for-parameter

os.environ.get(b"TEST") # [invalid-envvar-value]
os.environ.get("TEST")
os.environ.get(None) # [invalid-envvar-value]
os.environ.get(["Crap"]) # [invalid-envvar-value]
os.environ.get(function_returning_bytes()) # [invalid-envvar-value]
os.environ.get(deep_function_returning_bytes()) # [invalid-envvar-value]
os.environ.get(function_returning_list()) # [invalid-envvar-value]
os.environ.get(function_returning_none()) # [invalid-envvar-value]
os.environ.get(function_returning_string())
os.environ.get(deep_function_returning_string())

os.environ.get(b"TEST", "default") # [invalid-envvar-value]
os.environ.get("TEST", "default")
os.environ.get(None, "default") # [invalid-envvar-value]
os.environ.get(["Crap"], "default") # [invalid-envvar-value]
os.environ.get(function_returning_bytes(), "default") # [invalid-envvar-value]
os.environ.get(function_returning_list(), "default") # [invalid-envvar-value]
os.environ.get(function_returning_none(), "default") # [invalid-envvar-value]
os.environ.get(function_returning_string(), "default")

os.environ.get(key=b"TEST") # [invalid-envvar-value]
os.environ.get(key="TEST")
os.environ.get(key=None) # [invalid-envvar-value]
os.environ.get(key=["Crap"]) # [invalid-envvar-value]
os.environ.get(key=function_returning_bytes()) # [invalid-envvar-value]
os.environ.get(key=function_returning_list()) # [invalid-envvar-value]
os.environ.get(key=function_returning_none()) # [invalid-envvar-value]
os.environ.get(key=function_returning_string())

os.environ.get('TEST', "value")
os.environ.get('TEST', []) # [invalid-envvar-default]
os.environ.get('TEST', None)
os.environ.get('TEST', b"123") # [invalid-envvar-default]
os.environ.get('TEST', function_returning_list()) # [invalid-envvar-default]
os.environ.get('TEST', function_returning_none())
os.environ.get('TEST', function_returning_string())
os.environ.get('TEST', function_returning_bytes()) # [invalid-envvar-default]

os.environ.get('TEST', default="value")
os.environ.get('TEST', default=[]) # [invalid-envvar-default]
os.environ.get('TEST', default=None)
os.environ.get('TEST', default=b"123") # [invalid-envvar-default]
os.environ.get('TEST', default=function_returning_list()) # [invalid-envvar-default]
os.environ.get('TEST', default=function_returning_none())
os.environ.get('TEST', default=function_returning_string())
os.environ.get('TEST', default=function_returning_bytes()) # [invalid-envvar-default]

os.environ.get(key='TEST')
os.environ.get(key='TEST', default="value")
os.environ.get(key='TEST', default=b"value") # [invalid-envvar-default]
os.environ.get(key='TEST', default=["Crap"]) # [invalid-envvar-default]
os.environ.get(key='TEST', default=function_returning_list()) # [invalid-envvar-default]
os.environ.get(key='TEST', default=function_returning_none())
os.environ.get(key='TEST', default=function_returning_string())
os.environ.get(key='TEST', default=function_returning_bytes()) # [invalid-envvar-default]
os.environ.get(key='TEST', default=function_returning_bytes()) # [invalid-envvar-default]
94 changes: 63 additions & 31 deletions tests/functional/i/invalid/invalid_envvar_value.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,63 @@
invalid-envvar-value:30:0:30:15::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:32:0:32:12::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:33:0:33:16::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:34:0:34:34::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:35:0:35:39::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:36:0:36:33::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:37:0:37:33::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:41:0:41:26::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:43:0:43:23::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:44:0:44:27::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:45:0:45:45::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:46:0:46:44::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:47:0:47:44::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:50:0:50:19::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:52:0:52:16::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:53:0:53:20::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:54:0:54:38::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:55:0:55:37::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:56:0:56:37::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-default:60:0:60:18::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:62:0:62:22::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:63:0:63:41::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:66:0:66:42::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:69:0:69:26::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:71:0:71:30::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:72:0:72:49::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:75:0:75:50::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:79:0:79:36::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:80:0:80:36::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:81:0:81:53::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:84:0:84:54::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-value:31:0:31:15::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:33:0:33:12::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:34:0:34:16::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:35:0:35:34::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:36:0:36:39::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:37:0:37:33::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:38:0:38:33::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:42:0:42:26::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:44:0:44:23::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:45:0:45:27::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:46:0:46:45::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:47:0:47:44::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:48:0:48:44::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:51:0:51:19::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:53:0:53:16::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:54:0:54:20::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:55:0:55:38::os.getenv does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:56:0:56:37::os.getenv does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:57:0:57:37::os.getenv does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-default:61:0:61:18::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:63:0:63:22::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:64:0:64:41::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:67:0:67:42::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:70:0:70:26::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:72:0:72:30::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:73:0:73:49::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:76:0:76:50::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:80:0:80:36::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:81:0:81:36::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:82:0:82:53::os.getenv default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:85:0:85:54::os.getenv default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-value:89:0:89:23::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:91:0:91:20::os.environ.get does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:92:0:92:24::os.environ.get does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:93:0:93:42::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:94:0:94:47::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:95:0:95:41::os.environ.get does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:96:0:96:41::os.environ.get does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:100:0:100:34::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:102:0:102:31::os.environ.get does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:103:0:103:35::os.environ.get does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:104:0:104:53::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:105:0:105:52::os.environ.get does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:106:0:106:52::os.environ.get does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:109:0:109:27::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:111:0:111:24::os.environ.get does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-value:112:0:112:28::os.environ.get does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:113:0:113:46::os.environ.get does not support builtins.bytes type argument:UNDEFINED
invalid-envvar-value:114:0:114:45::os.environ.get does not support builtins.list type argument:UNDEFINED
invalid-envvar-value:115:0:115:45::os.environ.get does not support builtins.NoneType type argument:UNDEFINED
invalid-envvar-default:119:0:119:26::os.environ.get default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:121:0:121:30::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:122:0:122:49::os.environ.get default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:125:0:125:50::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:128:0:128:34::os.environ.get default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:130:0:130:38::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:131:0:131:57::os.environ.get default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:134:0:134:58::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:138:0:138:44::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:139:0:139:44::os.environ.get default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:140:0:140:61::os.environ.get default type is builtins.list. Expected str or None.:UNDEFINED
invalid-envvar-default:143:0:143:62::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
invalid-envvar-default:144:0:144:62::os.environ.get default type is builtins.bytes. Expected str or None.:UNDEFINED
Loading