How do I convert a string into a boolean in Python? This attempt returns True:
>>> bool("False")
True
Really, you just compare the string to whatever you expect to accept as representing true, so you can do this:
s == 'True'
Or to checks against a whole bunch of values:
s.lower() in ['true', '1', 't', 'y', 'yes', 'yeah', 'yup', 'certainly', 'uh-huh']
Be cautious when using the following:
>>> bool("foo")
True
>>> bool("False") # beware!
True
>>> bool("")
False
Empty strings evaluate to False, but everything else evaluates to True. So this should not be used for any kind of parsing purposes.
s == "True". But I've seen people make a real mess of this. def convert(s): if s == "True": return True; return False.bool("False"). It will always cast to True.Use:
bool(distutils.util.strtobool(some_string))
distutils.util.strtobooldistutils.util.strtoboolTrue values are y, yes, t, true, on and 1; false values are n, no, f, false, off and 0. Raises ValueError if val is anything else.
Be aware that distutils.util.strtobool() returns integer representations and thus it needs to be wrapped with bool() to get Boolean values.
Given that distutils will no longer be part of the standard library, here is the code for distutils.util.strtobool() (see the source code for 3.11.2).
def strtobool (val):
"""Convert a string representation of truth to true (1) or false (0).
True values are 'y', 'yes', 't', 'true', 'on', and '1'; false values
are 'n', 'no', 'f', 'false', 'off', and '0'. Raises ValueError if
'val' is anything else.
"""
val = val.lower()
if val in ('y', 'yes', 't', 'true', 'on', '1'):
return 1
elif val in ('n', 'no', 'f', 'false', 'off', '0'):
return 0
else:
raise ValueError("invalid truth value %r" % (val,))
None and str(None) as input.bool instead of 1/0 as long as you're not doing bad stuff like if x == False... and if you're dealing with ints and Nones you don't need a special function, you can just check them directly if myint: or if not maybe_none_var:bool is a sub-class of intdef str2bool(v):
return v.lower() in ("yes", "true", "t", "1")
Then call it like so:
>>> str2bool("yes")
True
>>> str2bool("no")
False
>>> str2bool("stuff")
False
>>> str2bool("1")
True
>>> str2bool("0")
False
Handling true and false explicitly:
You could also make your function explicitly check against a True list of words and a False list of words. Then if it is in neither list, you could throw an exception.
The JSON parser is also useful for in general converting strings to reasonable python types.
>>> import json
>>> json.loads("false".lower())
False
>>> json.loads("True".lower())
True
json.loads("[42]".lower()) -> [42].lower() needed? When I don't use it, for example x = "False" j = json.loads(x), I get the error json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)true and false values; see json-schema.org/understanding-json-schema/reference/…Since Python 2.6 you can use ast.literal_eval, and it's still available in Python 3.
Evaluate an expression node or a string containing only a Python literal or container display. The string or node provided may only consist of the following Python literal structures: strings, bytes, numbers, tuples, lists, dicts, sets, booleans,
NoneandEllipsis.This can be used for evaluating strings containing Python values without the need to parse the values oneself. It is not capable of evaluating arbitrarily complex expressions, for example involving operators or indexing.
This function had been documented as “safe” in the past without defining what that meant. That was misleading. This is specifically designed not to execute Python code, unlike the more general
eval(). There is no namespace, no name lookups, or ability to call out. But it is not free from attack: A relatively small input can lead to memory exhaustion or to C stack exhaustion, crashing the process. There is also the possibility for excessive CPU consumption denial of service on some inputs. Calling it on untrusted data is thus not recommended.
Which seems to work, as long as you're sure your strings are going to be either "True" or "False":
>>> ast.literal_eval("True")
True
>>> ast.literal_eval("False")
False
>>> ast.literal_eval("F")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/opt/Python-2.6.1/lib/python2.6/ast.py", line 68, in literal_eval
return _convert(node_or_string)
File "/opt/Python-2.6.1/lib/python2.6/ast.py", line 67, in _convert
raise ValueError('malformed string')
ValueError: malformed string
>>> ast.literal_eval("'False'")
'False'
I wouldn't normally recommend this, but it is completely built-in and could be the right thing depending on your requirements.
If you know the string will be either "True" or "False", you could just use eval(s).
>>> eval("True")
True
>>> eval("False")
False
Only use this if you are sure of the contents of the string though, as it will throw an exception if the string does not contain valid Python, and will also execute code contained in the string.
if eval(os.environ["LOL"]): #might never reach here. Might also charge your company's credit card. eval for a simple string comparison you can never be 100% certain that a piece of code is going to stay the same and behave the same over time but there's a slight chance that you leave the eval in there then the disaster soup is readyThere is an elegant solution with pydantic:
For pydantic >=2:
from pydantic import TypeAdapter
>>> TypeAdapter(bool).validate_python("true")
True
>>> TypeAdapter(bool).validate_python("off")
False
For pydantic <2:
import pydantic
>>> pydantic.parse_obj_as(bool, "true")
True
>>> pydantic.parse_obj_as(bool, "off")
False
NOTE: DON'T EVER USE eval() if it takes an input directly or indirectly from the user because it is highly subject to abuse:
eval('os.system(‘rm -rf /’)')
But cheers! Study finds also that eval() is not evil and it is perfectly OK for TRUSTED CODE. You can use it to convert a boolean string such as "False" and "True" to a boolean type.
I would like to share my simple solution: use the eval(). It will convert the string True and False to proper boolean type IF the string is exactly in title format True or False always first letter capital or else the function will raise an error.
e.g.
>>> eval('False')
False
>>> eval('True')
True
Of course for dynamic variable you can simple use the .title() to format the boolean string.
>>> x = 'true'
>>> eval(x.title())
True
This will throw an error.
>>> eval('true')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<string>", line 1, in <module>
NameError: name 'true' is not defined
>>> eval('false')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<string>", line 1, in <module>
NameError: name 'false' is not defined
eval('os.system(‘rm -rf /’)') and it deletes all the files in that directory. However eval() are perfectly OK for a trusted code it is not really evil. So I better put a note to be careful.literal_eval?This version keeps the semantics of constructors like int(value) and provides an easy way to define acceptable string values.
valid = {'true': True, 't': True, '1': True,
'false': False, 'f': False, '0': False,
}
def to_bool(value):
"""Convert string value to boolean."""
if isinstance(value, bool):
return value
if not isinstance(value, basestring):
raise ValueError('invalid literal for boolean. Not a string.')
lower_value = value.lower()
if lower_value in valid:
return valid[lower_value]
else:
raise ValueError('invalid literal for boolean: "%s"' % value)
# Test cases
assert to_bool('true'), '"true" is True'
assert to_bool('True'), '"True" is True'
assert to_bool('TRue'), '"TRue" is True'
assert to_bool('TRUE'), '"TRUE" is True'
assert to_bool('T'), '"T" is True'
assert to_bool('t'), '"t" is True'
assert to_bool('1'), '"1" is True'
assert to_bool(True), 'True is True'
assert to_bool(u'true'), 'unicode "true" is True'
assert to_bool('false') is False, '"false" is False'
assert to_bool('False') is False, '"False" is False'
assert to_bool('FAlse') is False, '"FAlse" is False'
assert to_bool('FALSE') is False, '"FALSE" is False'
assert to_bool('F') is False, '"F" is False'
assert to_bool('f') is False, '"f" is False'
assert to_bool('0') is False, '"0" is False'
assert to_bool(False) is False, 'False is False'
assert to_bool(u'false') is False, 'unicode "false" is False'
# Expect ValueError to be raised for invalid parameter...
try:
to_bool('')
to_bool(12)
to_bool([])
to_bool('yes')
to_bool('FOObar')
except ValueError, e:
pass
valid should be placed outside the function, or the dict will be rebuilt on every call, removing the majority of the performance benefit of using a dict in the first place.you could always do something like
my_string = "false"
val = (my_string == "true")
the bit in parens would evaluate to False. This is just another way to do it without having to do an actual function call.
Here's is my version. It checks against both positive and negative values lists, raising an exception for unknown values. And it does not receive a string, but any type should do.
def to_bool(value):
"""
Converts 'something' to boolean. Raises exception for invalid formats
Possible True values: 1, True, "1", "TRue", "yes", "y", "t"
Possible False values: 0, False, None, [], {}, "", "0", "faLse", "no", "n", "f", 0.0, ...
"""
if str(value).lower() in ("yes", "y", "true", "t", "1"): return True
if str(value).lower() in ("no", "n", "false", "f", "0", "0.0", "", "none", "[]", "{}"): return False
raise Exception('Invalid value for boolean conversion: ' + str(value))
Sample runs:
>>> to_bool(True)
True
>>> to_bool("tRUe")
True
>>> to_bool("1")
True
>>> to_bool(1)
True
>>> to_bool(2)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<stdin>", line 9, in to_bool
Exception: Invalid value for boolean conversion: 2
>>> to_bool([])
False
>>> to_bool({})
False
>>> to_bool(None)
False
>>> to_bool("Wasssaaaaa")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<stdin>", line 9, in to_bool
Exception: Invalid value for boolean conversion: Wasssaaaaa
>>>
to_bool(["hello"]) which should be a perfectly valid call, if [] is supportedto_bool([]). Instead he would do something along these lines: myList=someFunctionThatReturnAList `if (is_bool(myList)):...´ so one have a list and want to know if this list is None or empty.A cool, simple trick (based on what @Alan Marchiori posted), but using yaml:
import yaml
parsed = yaml.load("true")
print bool(parsed)
If this is too wide, it can be refined by testing the type result. If the yaml-returned type is a str, then it can't be cast to any other type (that I can think of anyway), so you could handle that separately, or just let it be true.
I won't make any guesses at speed, but since I am working with yaml data under Qt gui anyway, this has a nice symmetry.
yaml module is a third party library: PyYAMLyaml.safe_load instead of yaml.loadon and offA dict (really, a defaultdict) gives you a pretty easy way to do this trick:
from collections import defaultdict
bool_mapping = defaultdict(bool) # Will give you False for non-found values
for val in ['True', 'yes', ...]:
bool_mapping[val] = True
print(bool_mapping['True']) # True
print(bool_mapping['kitten']) # False
If you only want to map known values and throw an exception otherwise:
truthy_strings = ['True', 'yes'] # ... and so on
falsy_strings = ['False', 'no'] # ... and so on
bool_mapping = {}
for v in truthy_strings:
bool_mapping[v] = True
for v in falsy_strings:
bool_mapping[v] = False
If you want to be too clever by half, you can shorten this with itertools
from itertools import chain, repeat
bool_mapping = dict(chain(zip(truthy_strings, repeat(True)), zip(falsy_strings, repeat(False))))
This is probably dumb but itertools tricks are vaguely amusing.
I don't agree with any solution here, as they are too permissive. This is not normally what you want when parsing a string.
So here the solution I'm using:
def to_bool(bool_str):
"""Parse the string and return the boolean value encoded or raise an exception"""
# replace basestring by str in python 3.x
if isinstance(bool_str, basestring) and bool_str:
if bool_str.lower() in ['true', 't', '1']: return True
elif bool_str.lower() in ['false', 'f', '0']: return False
#if here we couldn't parse it
raise ValueError("%s is no recognized as a boolean value" % bool_str)
And the results:
>>> [to_bool(v) for v in ['true','t','1','F','FALSE','0']]
[True, True, True, False, False, False]
>>> to_bool("")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<stdin>", line 8, in to_bool
ValueError: '' is no recognized as a boolean value
Just to be clear because it looks as if my answer offended somebody somehow:
The point is that you don't want to test for only one value and assume the other. I don't think you always want to map Absolutely everything to the non parsed value. That produces error prone code.
So, if you know what you want code it in.
By using below simple logic you can convert a string say a = 'true' or 'false', to boolean.
a = a.lower() == 'true'
if a == 'true' then this will set a=True and if a == 'false' then a=False.
"truee"to true. generally we want an exception if the input is invalidAfter having seen so many home brewn solutions, why not use something existing? All you need is:
from attrs.converters import to_bool
From the docs:
Convert "boolean" strings (e.g., from env. vars.) to real booleans
It does what you want: convert the strings True, true, yes, on, 1 (and some more) to True and False, false etc... to False.
It also raises an error if the string does not represent something which can be interpreted as boolean.
attrs is available from pypi.
I use
# function
def to_bool(x):
return x in ("True", "true", True)
# test cases
[[x, to_bool(x)] for x in [True, "True", "true", False, "False", "false", None, 1, 0, -1, 123]]
"""
Result:
[[True, True],
['True', True],
['true', True],
[False, False],
['False', False],
['false', False],
[None, False],
[1, True],
[0, False],
[-1, False],
[123, False]]
"""
You probably already have a solution but for others who are looking for a method to convert a value to a boolean value using "standard" false values including None, [], {}, and "" in addition to false, no , and 0.
def toBoolean( val ):
"""
Get the boolean value of the provided input.
If the value is a boolean return the value.
Otherwise check to see if the value is in
["false", "f", "no", "n", "none", "0", "[]", "{}", "" ]
and returns True if value is not in the list
"""
if val is True or val is False:
return val
falseItems = ["false", "f", "no", "n", "none", "0", "[]", "{}", "" ]
return not str( val ).strip().lower() in falseItems
not in and your selection of false items is somewhat idiosyncratic.If you have control over the entity that's returning true/false, one option is to have it return 1/0 instead of true/false, then:
boolean_response = bool(int(response))
The extra cast to int handles responses from a network, which are always string.
Update 2021: "which are always string" -- this is a naive observation. It depends on the serialization protocol used by the library. Default serialization of high-level libraries (the ones used by most web devs) is typically to convert to string before being serialized to bytes. And then on the other side, it's deserialized from bytes to string, so you've lost any type information.
If you like me just need boolean from variable which is string. You can use distils as mentioned by @jzwiener. However I could not import and use the module as he suggested.
Instead I end up using it this way on python3.7
from distutils import util # to handle str to bool conversion
enable_deletion = 'False'
enable_deletion = bool(util.strtobool(enable_deletion))
distutils is part of the python std lib, so no need to install anything, which is great! 👍
If you know that your input will be either "True" or something else, then why not use:
def bool_convert(s):
return s == "True"
if s else False bit. Think about how "False" == "True" will already return False.if type(s) is bool: return s.The usual rule for casting to a bool is that a few special literals (False, 0, 0.0, (), [], {}) are false and then everything else is true, so I recommend the following:
def boolify(val):
if (isinstance(val, basestring) and bool(val)):
return not val in ('False', '0', '0.0')
else:
return bool(val)
This is the version I wrote. Combines several of the other solutions into one.
def to_bool(value):
"""
Converts 'something' to boolean. Raises exception if it gets a string it doesn't handle.
Case is ignored for strings. These string values are handled:
True: 'True', "1", "TRue", "yes", "y", "t"
False: "", "0", "faLse", "no", "n", "f"
Non-string values are passed to bool.
"""
if type(value) == type(''):
if value.lower() in ("yes", "y", "true", "t", "1"):
return True
if value.lower() in ("no", "n", "false", "f", "0", ""):
return False
raise Exception('Invalid value for boolean conversion: ' + value)
return bool(value)
If it gets a string it expects specific values, otherwise raises an Exception. If it doesn't get a string, just lets the bool constructor figure it out. Tested these cases:
test_cases = [
('true', True),
('t', True),
('yes', True),
('y', True),
('1', True),
('false', False),
('f', False),
('no', False),
('n', False),
('0', False),
('', False),
(1, True),
(0, False),
(1.0, True),
(0.0, False),
([], False),
({}, False),
((), False),
([1], True),
({1:2}, True),
((1,), True),
(None, False),
(object(), True),
]
str instead of type('')I completely agree with the solution of @Jacob\ Gabrielson but the thing is ast.literal_eval only work with string value of True and False not with true or false. So you just have to use .title() for it to work
import ast
ast.literal_eval("false".title())
# or
ast.literal_eval("False".title())
Use this solution:
def to_bool(value) -> bool:
if value == 'true':
return True
elif value == 'True':
return True
elif value == 'false':
return False
elif value == 'False':
return False
elif value == 0:
return False
elif value == 1:
return True
else:
raise ValueError("Value was not recognized as a valid Boolean.")
simple solution is
RUN_LOCAL = True if os.environ.get("RUN_LOCAL") == "True" else False
In this case if RUN_LOCAL variable is "True" it will be converted to boolean True in RUN_LOCAL variable else it will be False. You can add additional verifications if you are planning to input other strings like low case true and false and so on but the idea is simple and works without a need of creating new functions
os.environ.get("RUN_LOCAL") == "True"If you want to be able to customize it, while having appropriate defaults for it:
def tobool(val, truthy=["true", "1", "on", "y", "yes", "t", "i"], falsy=["false", "0", "off", "n", "no", "f", "o"], strfunc = (lambda x: str(x).lower())):
ch = strfunc(val)
if ch in truthy:
return True
elif ch in falsy:
return False
else:
return None
bool("string")it always returnsTrue...except for the empty stringbool("")