Escaped Dollar sign ($) in string environment variables not getting cleaned after import

Hi People,

I’ve encountered an issue while setting the EMAIL_HOST_PASSWORD environment variable.

If you have Dollar sign $ in the beginning of your env variable string django-environ treats it as another environment variable (nested variable): .env file:

EMAIL_HOST_PASSWORD='$my_password_including_$_sign_in_the_beginning'

settings.py

EMAIL_HOST_PASSWORD = env.str('EMAIL_HOST_PASSWORD')

This configuration raises:

django.core.exceptions.ImproperlyConfigured: Set the my_password_including_$_sign_in_the_beginning environment variable

which as you can see omitted the first $ sign.

Now if we try to escape the $ character with a backslash and change our .env file to this:

EMAIL_HOST_PASSWORD='\$my_password_including_$_sign_in_the_beginning'

django-environ escapes the backslash instead of the dollar sign $ and we end up with something like this:

>>> from django.conf import settings
>>> settings.EMAIL_HOST_PASSWORD
'\\$my_password_including_$_sign_in_the_beginning'

Which breaks our configurations and settings.

This is my proposal which if is agreed on I’ll make a pull request:

# Current string reader function
def str(self, var, default=NOTSET, multiline=False):
    """
    :rtype: str
    """
    value = self.get_value(var, default=default)
    if multiline:
        return value.replace('\\n', '\n')
    return value


# My proposal for string function, which we can use escape=True while passing env variables that have such characters
def str(self, var, default=NOTSET, multiline=False, escape=False):
    """
    :rtype: str
    """
    value = self.get_value(var, default=default)
    if multiline:
        return value.replace('\\n', '\n')
    if escape:
        return value.replace('\$', '$')
    return value

[fdemmer]

I’l sort out with this ASAP.

Looking forward to a release, that supports completely disabling proxy/interpolation (or at least using only ${VAR} format). I personally don’t need it at all and it generally adds complexity that leads to bugs as documented by the numerous issues reporting problems.

Thank you for your work on all those recent updates @sergeyklay !

[salaxieb]

Hi everyone following helped me: with my pas$word using double $

export PASSWORD='pas$$word'