client_id and client_secret in docs should be raw string

[synasius]

I recently tried requests-oauthlib with django-oauth-toolkit following the webapplication flow tutorial.

If the provider use '' char in client_id and client_secret strings that will be interpreted as an escape sequence and you'll obtain an InvalidClientId error when you try to exchange the token.
For instance if the client_id XQcKemTaz}^1GW6C@_;@KHDh@yo\4Br\jv/,;5\1:

>>> client_id = 'XQcKemTaz}^1GW6C@_;@KHDh@yo\4Br\jv/,;5\1'
>>> print client_id
XQcKemTaz}^1GW6C@_;@KHDh@yo�Br\jv/,;5�

As you can see the input value and output value are different.
To avoid this behavior you can use raw python string syntax:

>>> client_id = r'XQcKemTaz}^1GW6C@_;@KHDh@yo\4Br\jv/,;5\1'
>>> print client_id
XQcKemTaz}^1GW6C@_;@KHDh@yo\4Br\jv/,;5\1

I can open a PR if you want

[Lukasa]

Hi @synasius, thanks for raising this issue! Whereabouts in the library is this a problem?

[synasius]

Hi,

I stumbled on the problem following this: https://requests-oauthlib.readthedocs.org/en/latest/oauth2_workflow.html#id1

This is a documentation problem, not a bug in the library code.

What I'm trying to report is that you should use raw string syntax in your documentation when you assign values to client_id or client_secret otherwise, as I described above, if the provider uses '' char you'll have problems in obtaining the authorization.

It seems that the library is buggy but it isn't... it's just a documentation issue :)

Am I wrong?

[Lukasa]

Ah, no. =) Just wanted to make sure there wasn't a serious library bug. =) Feel free to open a pull request with the changes. =)